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 minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ.
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.
CfnBroker.Builder	brokerName(String brokerName)	The name of the broker.
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)	The deployment mode of the broker.
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)	The type of broker engine.
CfnBroker.Builder	engineVersion(String engineVersion)	The version of the broker engine.
CfnBroker.Builder	hostInstanceType(String hostInstanceType)	The broker's instance type.
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 scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
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.
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)	An array of key-value pairs.
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.

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:

• 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 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:

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

brokerName

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

• 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)

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:

• 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)

The type of broker engine.

Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

Parameters:

engineType - The type of broker engine. 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

engineVersion

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

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

hostInstanceType

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

The broker's instance type.

Parameters:

hostInstanceType - The broker's instance 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-hostinstancetype

publiclyAccessible

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

• 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.

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

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 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:

• 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 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:

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

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

configuration

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

• 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.

Does not apply to RabbitMQ brokers.

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.

Does not apply to RabbitMQ brokers.

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.

Does not apply to RabbitMQ brokers.

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

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 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:

• 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 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:

• 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 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:

• 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)

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:

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

build

@Stability(Stable)
public CfnBroker build()

Specified by:

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

Returns:

a newly built instance of CfnBroker.