Interface CfnBrokerProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnBrokerProps.Jsii$Proxy
CfnBroker
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.amazonmq.*; CfnBrokerProps cfnBrokerProps = CfnBrokerProps.builder() .brokerName("brokerName") .deploymentMode("deploymentMode") .engineType("engineType") .hostInstanceType("hostInstanceType") .publiclyAccessible(false) .users(List.of(UserProperty.builder() .password("password") .username("username") // the properties below are optional .consoleAccess(false) .groups(List.of("groups")) .replicationUser(false) .build())) // the properties below are optional .authenticationStrategy("authenticationStrategy") .autoMinorVersionUpgrade(false) .configuration(ConfigurationIdProperty.builder() .id("id") .revision(123) .build()) .dataReplicationMode("dataReplicationMode") .dataReplicationPrimaryBrokerArn("dataReplicationPrimaryBrokerArn") .encryptionOptions(EncryptionOptionsProperty.builder() .useAwsOwnedKey(false) // the properties below are optional .kmsKeyId("kmsKeyId") .build()) .engineVersion("engineVersion") .ldapServerMetadata(LdapServerMetadataProperty.builder() .hosts(List.of("hosts")) .roleBase("roleBase") .roleSearchMatching("roleSearchMatching") .serviceAccountPassword("serviceAccountPassword") .serviceAccountUsername("serviceAccountUsername") .userBase("userBase") .userSearchMatching("userSearchMatching") // the properties below are optional .roleName("roleName") .roleSearchSubtree(false) .userRoleName("userRoleName") .userSearchSubtree(false) .build()) .logs(LogListProperty.builder() .audit(false) .general(false) .build()) .maintenanceWindowStartTime(MaintenanceWindowProperty.builder() .dayOfWeek("dayOfWeek") .timeOfDay("timeOfDay") .timeZone("timeZone") .build()) .securityGroups(List.of("securityGroups")) .storageType("storageType") .subnetIds(List.of("subnetIds")) .tags(List.of(TagsEntryProperty.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnBrokerProps
static final class
An implementation forCfnBrokerProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnBrokerProps.Builder
builder()
default String
Optional.default Object
Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ.The name of the broker.default Object
A list of information about the configuration.default String
Defines whether this broker is a part of a data replication pair.default String
The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker.The deployment mode of the broker.default Object
Encryption options for the broker.The type of broker engine.default String
The version of the broker engine.The broker's instance type.default Object
Optional.default Object
getLogs()
Enables Amazon CloudWatch logging for brokers.default Object
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.Enables connections from applications outside of the VPC that hosts the broker's subnets.The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.default String
The broker's storage type.The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.default List<CfnBroker.TagsEntryProperty>
getTags()
An array of key-value pairs.getUsers()
The list of broker users (persons or applications) who can access queues and topics.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBrokerName
The name of the broker.This value must be unique in your AWS account , 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including C CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.
- See Also:
-
getDeploymentMode
The deployment mode of the broker. Available values:.SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ
- See Also:
-
getEngineType
The type of broker engine.Currently, Amazon MQ supports
ACTIVEMQ
andRABBITMQ
.- See Also:
-
getHostInstanceType
The broker's instance type.- See Also:
-
getPubliclyAccessible
Enables connections from applications outside of the VPC that hosts the broker's subnets.- See Also:
-
getUsers
The list of broker users (persons or applications) who can access queues and topics.For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent RabbitMQ users are created by via the RabbitMQ web console or by using the RabbitMQ management API.
- See Also:
-
getAuthenticationStrategy
Optional.The authentication strategy used to secure the broker. The default is
SIMPLE
.- See Also:
-
getAutoMinorVersionUpgrade
Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ.Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
- See Also:
-
getConfiguration
A list of information about the configuration.Does not apply to RabbitMQ brokers.
- See Also:
-
getDataReplicationMode
Defines whether this broker is a part of a data replication pair.- See Also:
-
getDataReplicationPrimaryBrokerArn
The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker.Must be set when dataReplicationMode is set to CRDR.
- See Also:
-
getEncryptionOptions
Encryption options for the broker.Does not apply to RabbitMQ brokers.
- See Also:
-
getEngineVersion
The version of the broker engine.For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .
- See Also:
-
getLdapServerMetadata
Optional.The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- See Also:
-
getLogs
Enables Amazon CloudWatch logging for brokers.- See Also:
-
getMaintenanceWindowStartTime
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.- See Also:
-
getSecurityGroups
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.- See Also:
-
getStorageType
The broker's storage type.- See Also:
-
getSubnetIds
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.
If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account . Amazon MQ will not be able to create VPC enpoints in VPCs that are not owned by your AWS account .
- See Also:
-
getTags
An array of key-value pairs.For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
- See Also:
-
builder
- Returns:
- a
CfnBrokerProps.Builder
ofCfnBrokerProps
-