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)
// 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")
.serviceAccountUsername("serviceAccountUsername")
.userBase("userBase")
.userSearchMatching("userSearchMatching")
// the properties below are optional
.roleName("roleName")
.roleSearchSubtree(false)
.serviceAccountPassword("serviceAccountPassword")
.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()))
.users(List.of(UserProperty.builder()
.password("password")
.username("username")
// the properties below are optional
.consoleAccess(false)
.groups(List.of("groups"))
.replicationUser(false)
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnBrokerPropsstatic final classAn implementation forCfnBrokerProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnBrokerProps.Builderbuilder()default StringOptional.default ObjectEnables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.Required.default ObjectA list of information about the configuration.default StringDefines whether this broker is a part of a data replication pair.default StringThe 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.Required.default ObjectEncryption options for the broker.Required.default StringThe broker engine version.Required.default ObjectOptional.default ObjectgetLogs()Enables Amazon CloudWatch logging for brokers.default ObjectThe parameters that determine the WeeklyStartTime.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 StringThe 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()Create tags when creating the broker.default ObjectgetUsers()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
Required.The broker's name. 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 CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.
- See Also:
-
getDeploymentMode
Required.The broker's deployment mode.
- See Also:
-
getEngineType
Required.The type of broker engine. Currently, Amazon MQ supports
ACTIVEMQandRABBITMQ.- See Also:
-
getHostInstanceType
Required.The broker's instance type.
- See Also:
-
getPubliclyAccessible
Enables connections from applications outside of the VPC that hosts the broker's subnets.Set to
falseby default, if no value is provided.Returns union: either
BooleanorIResolvable- See Also:
-
getAuthenticationStrategy
Optional.The authentication strategy used to secure the broker. The default is
SIMPLE.- See Also:
-
getAutoMinorVersionUpgrade
Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to
trueby default, if no value is specified.Must be set to
truefor ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.Returns union: either
BooleanorIResolvable- See Also:
-
getConfiguration
A list of information about the configuration.Returns union: either
IResolvableorCfnBroker.ConfigurationIdProperty- 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.Returns union: either
IResolvableorCfnBroker.EncryptionOptionsProperty- See Also:
-
getEngineVersion
The broker engine version.Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections 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.
Returns union: either
IResolvableorCfnBroker.LdapServerMetadataProperty- See Also:
-
getLogs
Enables Amazon CloudWatch logging for brokers.Returns union: either
IResolvableorCfnBroker.LogListProperty- See Also:
-
getMaintenanceWindowStartTime
The parameters that determine the WeeklyStartTime.Returns union: either
IResolvableorCfnBroker.MaintenanceWindowProperty- 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 Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment 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 endpoints in VPCs that are not owned by your AWS account .
- See Also:
-
getTags
Create tags when creating the broker.- 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 broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
When OAuth 2.0 is enabled, the broker accepts one or no users.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnBroker.UserProperty>- See Also:
-
builder
- Returns:
- a
CfnBrokerProps.BuilderofCfnBrokerProps
-