Package software.amazon.awscdk.services.amazonmq

Class CfnBroker.Builder

java.lang.Object

software.amazon.awscdk.services.amazonmq.CfnBroker.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBroker>

Enclosing class:

CfnBroker

@Stability(Stable)
public static final class CfnBroker.Builder
extends Object
implements software.amazon.jsii.Builder<CfnBroker>

A fluent builder for CfnBroker.

Method Summary

Modifier and Type	Method	Description
CfnBroker.Builder	authenticationStrategy(String authenticationStrategy)	Optional.
CfnBroker.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.
CfnBroker.Builder	autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)	Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.
CfnBroker.Builder	brokerName(String brokerName)	Required.
CfnBroker	build()
CfnBroker.Builder	configuration(IResolvable configuration)	A list of information about the configuration.
CfnBroker.Builder	configuration(CfnBroker.ConfigurationIdProperty configuration)	A list of information about the configuration.
static CfnBroker.Builder	create(software.constructs.Construct scope, String id)
CfnBroker.Builder	dataReplicationMode(String dataReplicationMode)	Defines whether this broker is a part of a data replication pair.
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.
CfnBroker.Builder	deploymentMode(String deploymentMode)	Required.
CfnBroker.Builder	encryptionOptions(IResolvable encryptionOptions)	Encryption options for the broker.
CfnBroker.Builder	encryptionOptions(CfnBroker.EncryptionOptionsProperty encryptionOptions)	Encryption options for the broker.
CfnBroker.Builder	engineType(String engineType)	Required.
CfnBroker.Builder	engineVersion(String engineVersion)	The broker engine version.
CfnBroker.Builder	hostInstanceType(String hostInstanceType)	Required.
CfnBroker.Builder	ldapServerMetadata(IResolvable ldapServerMetadata)	Optional.
CfnBroker.Builder	ldapServerMetadata(CfnBroker.LdapServerMetadataProperty ldapServerMetadata)	Optional.
CfnBroker.Builder	logs(IResolvable logs)	Enables Amazon CloudWatch logging for brokers.
CfnBroker.Builder	logs(CfnBroker.LogListProperty logs)	Enables Amazon CloudWatch logging for brokers.
CfnBroker.Builder	maintenanceWindowStartTime(IResolvable maintenanceWindowStartTime)	The parameters that determine the WeeklyStartTime.
CfnBroker.Builder	maintenanceWindowStartTime(CfnBroker.MaintenanceWindowProperty maintenanceWindowStartTime)	The parameters that determine the WeeklyStartTime.
CfnBroker.Builder	publiclyAccessible(Boolean publiclyAccessible)	Enables connections from applications outside of the VPC that hosts the broker's subnets.
CfnBroker.Builder	publiclyAccessible(IResolvable publiclyAccessible)	Enables connections from applications outside of the VPC that hosts the broker's subnets.
CfnBroker.Builder	securityGroups(List<String> securityGroups)	The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
CfnBroker.Builder	storageType(String storageType)	The broker's storage type.
CfnBroker.Builder	subnetIds(List<String> subnetIds)	The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
CfnBroker.Builder	tags(List<? extends CfnBroker.TagsEntryProperty> tags)	Create tags when creating the broker.
CfnBroker.Builder	users(List<? extends Object> users)	The list of broker users (persons or applications) who can access queues and topics.
CfnBroker.Builder	users(IResolvable users)	The list of broker users (persons or applications) who can access queues and topics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

@Stability(Stable)
public CfnBroker.Builder brokerName(String brokerName)

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.

Parameters:

brokerName - Required. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-brokername

deploymentMode

@Stability(Stable)
public CfnBroker.Builder deploymentMode(String deploymentMode)

Required.

The broker's deployment mode.

Parameters:

deploymentMode - Required. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-deploymentmode

engineType

@Stability(Stable)
public CfnBroker.Builder engineType(String engineType)

Required.

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

Parameters:

engineType - Required. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-enginetype

hostInstanceType

@Stability(Stable)
public CfnBroker.Builder hostInstanceType(String hostInstanceType)

Required.

The broker's instance type.

Parameters:

hostInstanceType - Required. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-hostinstancetype

publiclyAccessible

@Stability(Stable)
public CfnBroker.Builder publiclyAccessible(Boolean publiclyAccessible)

Enables connections from applications outside of the VPC that hosts the broker's subnets.

Set to false by default, if no value is provided.

Parameters:

publiclyAccessible - Enables connections from applications outside of the VPC that hosts the broker's subnets. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-publiclyaccessible

publiclyAccessible

@Stability(Stable)
public CfnBroker.Builder publiclyAccessible(IResolvable publiclyAccessible)

Enables connections from applications outside of the VPC that hosts the broker's subnets.

Set to false by default, if no value is provided.

Parameters:

publiclyAccessible - Enables connections from applications outside of the VPC that hosts the broker's subnets. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-publiclyaccessible

authenticationStrategy

@Stability(Stable)
public CfnBroker.Builder authenticationStrategy(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-authenticationstrategy

autoMinorVersionUpgrade

@Stability(Stable)
public CfnBroker.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

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 true by default, if no value is specified.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

Parameters:

autoMinorVersionUpgrade - Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-autominorversionupgrade

autoMinorVersionUpgrade

@Stability(Stable)
public CfnBroker.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)

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 true by default, if no value is specified.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

Parameters:

autoMinorVersionUpgrade - Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-autominorversionupgrade

configuration

@Stability(Stable)
public CfnBroker.Builder configuration(IResolvable configuration)

A list of information about the configuration.

Parameters:

configuration - A list of information about the configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-configuration

configuration

@Stability(Stable)
public CfnBroker.Builder configuration(CfnBroker.ConfigurationIdProperty configuration)

A list of information about the configuration.

Parameters:

configuration - A list of information about the configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-configuration

dataReplicationMode

@Stability(Stable)
public CfnBroker.Builder dataReplicationMode(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-datareplicationmode

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-datareplicationprimarybrokerarn

encryptionOptions

@Stability(Stable)
public CfnBroker.Builder encryptionOptions(IResolvable encryptionOptions)

Encryption options for the broker.

Parameters:

encryptionOptions - Encryption options for the broker. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-encryptionoptions

encryptionOptions

@Stability(Stable)
public CfnBroker.Builder encryptionOptions(CfnBroker.EncryptionOptionsProperty encryptionOptions)

Encryption options for the broker.

Parameters:

encryptionOptions - Encryption options for the broker. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-encryptionoptions

engineVersion

@Stability(Stable)
public CfnBroker.Builder engineVersion(String engineVersion)

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.

Parameters:

engineVersion - The broker engine version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-engineversion

ldapServerMetadata

@Stability(Stable)
public CfnBroker.Builder ldapServerMetadata(IResolvable 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-ldapservermetadata

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-ldapservermetadata

logs

@Stability(Stable)
public CfnBroker.Builder logs(IResolvable logs)

Enables Amazon CloudWatch logging for brokers.

Parameters:

logs - Enables Amazon CloudWatch logging for brokers. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-logs

logs

@Stability(Stable)
public CfnBroker.Builder logs(CfnBroker.LogListProperty logs)

Enables Amazon CloudWatch logging for brokers.

Parameters:

logs - Enables Amazon CloudWatch logging for brokers. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-logs

maintenanceWindowStartTime

@Stability(Stable)
public CfnBroker.Builder maintenanceWindowStartTime(IResolvable maintenanceWindowStartTime)

The parameters that determine the WeeklyStartTime.

Parameters:

maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-maintenancewindowstarttime

maintenanceWindowStartTime

@Stability(Stable)
public CfnBroker.Builder maintenanceWindowStartTime(CfnBroker.MaintenanceWindowProperty maintenanceWindowStartTime)

The parameters that determine the WeeklyStartTime.

Parameters:

maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-maintenancewindowstarttime

securityGroups

@Stability(Stable)
public CfnBroker.Builder securityGroups(List<String> 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-securitygroups

storageType

@Stability(Stable)
public CfnBroker.Builder storageType(String storageType)

The broker's storage type.

Parameters:

storageType - The broker's storage type. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-storagetype

subnetIds

@Stability(Stable)
public CfnBroker.Builder subnetIds(List<String> 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 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 .

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-subnetids

tags

@Stability(Stable)
public CfnBroker.Builder tags(List<? extends CfnBroker.TagsEntryProperty> tags)

Create tags when creating the broker.

Parameters:

tags - Create tags when creating the broker. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-tags

users

@Stability(Stable)
public CfnBroker.Builder users(IResolvable 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 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.

Parameters:

users - The list of broker users (persons or applications) who can access queues and topics. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-users

users

@Stability(Stable)
public CfnBroker.Builder users(List<? extends Object> 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 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.

Parameters:

users - The list of broker users (persons or applications) who can access queues and topics. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-users

build

@Stability(Stable)
public CfnBroker build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnBroker>

Returns:

a newly built instance of CfnBroker.