Class CfnBroker.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnBroker>
- Enclosing class:
CfnBroker
CfnBroker
.-
Method Summary
Modifier and TypeMethodDescriptionauthenticationStrategy
(String authenticationStrategy) Optional.autoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ.autoMinorVersionUpgrade
(IResolvable autoMinorVersionUpgrade) Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ.brokerName
(String brokerName) The name of the broker.build()
configuration
(IResolvable configuration) A list of information about the configuration.configuration
(CfnBroker.ConfigurationIdProperty configuration) A list of information about the configuration.static CfnBroker.Builder
dataReplicationMode
(String dataReplicationMode) Defines whether this broker is a part of a data replication pair.dataReplicationPrimaryBrokerArn
(String dataReplicationPrimaryBrokerArn) 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.deploymentMode
(String deploymentMode) The deployment mode of the broker.encryptionOptions
(IResolvable encryptionOptions) Encryption options for the broker.encryptionOptions
(CfnBroker.EncryptionOptionsProperty encryptionOptions) Encryption options for the broker.engineType
(String engineType) The type of broker engine.engineVersion
(String engineVersion) The version of the broker engine.hostInstanceType
(String hostInstanceType) The broker's instance type.ldapServerMetadata
(IResolvable ldapServerMetadata) Optional.ldapServerMetadata
(CfnBroker.LdapServerMetadataProperty ldapServerMetadata) Optional.logs
(IResolvable logs) Enables Amazon CloudWatch logging for brokers.Enables Amazon CloudWatch logging for brokers.maintenanceWindowStartTime
(IResolvable maintenanceWindowStartTime) The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.maintenanceWindowStartTime
(CfnBroker.MaintenanceWindowProperty maintenanceWindowStartTime) The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.publiclyAccessible
(Boolean publiclyAccessible) Enables connections from applications outside of the VPC that hosts the broker's subnets.publiclyAccessible
(IResolvable publiclyAccessible) Enables connections from applications outside of the VPC that hosts the broker's subnets.securityGroups
(List<String> securityGroups) The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.storageType
(String storageType) The broker's storage type.The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.tags
(List<? extends CfnBroker.TagsEntryProperty> tags) An array of key-value pairs.The list of broker users (persons or applications) who can access queues and topics.users
(IResolvable users) The list of broker users (persons or applications) who can access queues and topics.
-
Method Details
-
create
@Stability(Stable) public static CfnBroker.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnBroker.Builder
.
-
brokerName
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.
- Parameters:
brokerName
- The name of the broker. This parameter is required.- Returns:
this
- See Also:
-
deploymentMode
The deployment mode of the broker. Available values:.SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ
- Parameters:
deploymentMode
- The deployment mode of the broker. Available values:. This parameter is required.- Returns:
this
- See Also:
-
engineType
The type of broker engine.Currently, Amazon MQ supports
ACTIVEMQ
andRABBITMQ
.- Parameters:
engineType
- The type of broker engine. This parameter is required.- Returns:
this
- See Also:
-
hostInstanceType
The broker's instance type.- Parameters:
hostInstanceType
- The broker's instance type. This parameter is required.- Returns:
this
- See Also:
-
publiclyAccessible
Enables connections from applications outside of the VPC that hosts the broker's subnets.- Parameters:
publiclyAccessible
- Enables connections from applications outside of the VPC that hosts the broker's subnets. This parameter is required.- Returns:
this
- See Also:
-
publiclyAccessible
Enables connections from applications outside of the VPC that hosts the broker's subnets.- Parameters:
publiclyAccessible
- Enables connections from applications outside of the VPC that hosts the broker's subnets. This parameter is required.- Returns:
this
- See Also:
-
users
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.
- Parameters:
users
- The list of broker users (persons or applications) who can access queues and topics. This parameter is required.- Returns:
this
- See Also:
-
users
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.
- Parameters:
users
- The list of broker users (persons or applications) who can access queues and topics. This parameter is required.- Returns:
this
- See Also:
-
authenticationStrategy
Optional.The authentication strategy used to secure the broker. The default is
SIMPLE
.- Parameters:
authenticationStrategy
- Optional. This parameter is required.- Returns:
this
- See Also:
-
autoMinorVersionUpgrade
@Stability(Stable) public CfnBroker.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) 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.
- Parameters:
autoMinorVersionUpgrade
- Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ. This parameter is required.- Returns:
this
- See Also:
-
autoMinorVersionUpgrade
@Stability(Stable) public CfnBroker.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade) 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.
- Parameters:
autoMinorVersionUpgrade
- Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ. This parameter is required.- Returns:
this
- See Also:
-
configuration
A list of information about the configuration.Does not apply to RabbitMQ brokers.
- Parameters:
configuration
- A list of information about the configuration. This parameter is required.- Returns:
this
- See Also:
-
configuration
@Stability(Stable) public CfnBroker.Builder configuration(CfnBroker.ConfigurationIdProperty configuration) A list of information about the configuration.Does not apply to RabbitMQ brokers.
- Parameters:
configuration
- A list of information about the configuration. This parameter is required.- Returns:
this
- See Also:
-
dataReplicationMode
Defines whether this broker is a part of a data replication pair.- Parameters:
dataReplicationMode
- Defines whether this broker is a part of a data replication pair. This parameter is required.- Returns:
this
- See Also:
-
dataReplicationPrimaryBrokerArn
@Stability(Stable) public CfnBroker.Builder dataReplicationPrimaryBrokerArn(String dataReplicationPrimaryBrokerArn) 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.
- Parameters:
dataReplicationPrimaryBrokerArn
- 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. This parameter is required.- Returns:
this
- See Also:
-
encryptionOptions
Encryption options for the broker.Does not apply to RabbitMQ brokers.
- Parameters:
encryptionOptions
- Encryption options for the broker. This parameter is required.- Returns:
this
- See Also:
-
encryptionOptions
@Stability(Stable) public CfnBroker.Builder encryptionOptions(CfnBroker.EncryptionOptionsProperty encryptionOptions) Encryption options for the broker.Does not apply to RabbitMQ brokers.
- Parameters:
encryptionOptions
- Encryption options for the broker. This parameter is required.- Returns:
this
- See Also:
-
engineVersion
The version of the broker engine.For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .
- Parameters:
engineVersion
- The version of the broker engine. This parameter is required.- Returns:
this
- See Also:
-
ldapServerMetadata
Optional.The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- Parameters:
ldapServerMetadata
- Optional. This parameter is required.- Returns:
this
- See Also:
-
ldapServerMetadata
@Stability(Stable) public CfnBroker.Builder ldapServerMetadata(CfnBroker.LdapServerMetadataProperty ldapServerMetadata) Optional.The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- Parameters:
ldapServerMetadata
- Optional. This parameter is required.- Returns:
this
- See Also:
-
logs
Enables Amazon CloudWatch logging for brokers.- Parameters:
logs
- Enables Amazon CloudWatch logging for brokers. This parameter is required.- Returns:
this
- See Also:
-
logs
Enables Amazon CloudWatch logging for brokers.- Parameters:
logs
- Enables Amazon CloudWatch logging for brokers. This parameter is required.- Returns:
this
- See Also:
-
maintenanceWindowStartTime
@Stability(Stable) public CfnBroker.Builder maintenanceWindowStartTime(IResolvable maintenanceWindowStartTime) The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.- Parameters:
maintenanceWindowStartTime
- The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker. This parameter is required.- Returns:
this
- See Also:
-
maintenanceWindowStartTime
@Stability(Stable) public CfnBroker.Builder maintenanceWindowStartTime(CfnBroker.MaintenanceWindowProperty maintenanceWindowStartTime) The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.- Parameters:
maintenanceWindowStartTime
- The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker. This parameter is required.- Returns:
this
- See Also:
-
securityGroups
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.- Parameters:
securityGroups
- The list of rules (1 minimum, 125 maximum) that authorize connections to brokers. This parameter is required.- Returns:
this
- See Also:
-
storageType
The broker's storage type.- Parameters:
storageType
- The broker's storage type. This parameter is required.- Returns:
this
- See Also:
-
subnetIds
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 .
- Parameters:
subnetIds
- The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. This parameter is required.- Returns:
this
- See Also:
-
tags
An array of key-value pairs.For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
- Parameters:
tags
- An array of key-value pairs. This parameter is required.- Returns:
this
- See Also:
-
build
-