Package software.amazon.awscdk.cfnpropertymixins.services.amazonmq

Class CfnBrokerMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.amazonmq.CfnBrokerMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBrokerMixinProps>

Enclosing interface:

CfnBrokerMixinProps

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

A builder for CfnBrokerMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnBrokerMixinProps.Builder	authenticationStrategy(String authenticationStrategy)	Sets the value of CfnBrokerMixinProps.getAuthenticationStrategy()
CfnBrokerMixinProps.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	Sets the value of CfnBrokerMixinProps.getAutoMinorVersionUpgrade()
CfnBrokerMixinProps.Builder	autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)	Sets the value of CfnBrokerMixinProps.getAutoMinorVersionUpgrade()
CfnBrokerMixinProps.Builder	brokerName(String brokerName)	Sets the value of CfnBrokerMixinProps.getBrokerName()
CfnBrokerMixinProps	build()	Builds the configured instance.
CfnBrokerMixinProps.Builder	configuration(CfnBrokerPropsMixin.ConfigurationIdProperty configuration)	Sets the value of CfnBrokerMixinProps.getConfiguration()
CfnBrokerMixinProps.Builder	configuration(IResolvable configuration)	Sets the value of CfnBrokerMixinProps.getConfiguration()
CfnBrokerMixinProps.Builder	dataReplicationMode(String dataReplicationMode)	Sets the value of CfnBrokerMixinProps.getDataReplicationMode()
CfnBrokerMixinProps.Builder	dataReplicationPrimaryBrokerArn(String dataReplicationPrimaryBrokerArn)	Sets the value of CfnBrokerMixinProps.getDataReplicationPrimaryBrokerArn()
CfnBrokerMixinProps.Builder	deploymentMode(String deploymentMode)	Sets the value of CfnBrokerMixinProps.getDeploymentMode()
CfnBrokerMixinProps.Builder	encryptionOptions(CfnBrokerPropsMixin.EncryptionOptionsProperty encryptionOptions)	Sets the value of CfnBrokerMixinProps.getEncryptionOptions()
CfnBrokerMixinProps.Builder	encryptionOptions(IResolvable encryptionOptions)	Sets the value of CfnBrokerMixinProps.getEncryptionOptions()
CfnBrokerMixinProps.Builder	engineType(String engineType)	Sets the value of CfnBrokerMixinProps.getEngineType()
CfnBrokerMixinProps.Builder	engineVersion(String engineVersion)	Sets the value of CfnBrokerMixinProps.getEngineVersion()
CfnBrokerMixinProps.Builder	hostInstanceType(String hostInstanceType)	Sets the value of CfnBrokerMixinProps.getHostInstanceType()
CfnBrokerMixinProps.Builder	ldapServerMetadata(CfnBrokerPropsMixin.LdapServerMetadataProperty ldapServerMetadata)	Sets the value of CfnBrokerMixinProps.getLdapServerMetadata()
CfnBrokerMixinProps.Builder	ldapServerMetadata(IResolvable ldapServerMetadata)	Sets the value of CfnBrokerMixinProps.getLdapServerMetadata()
CfnBrokerMixinProps.Builder	logs(CfnBrokerPropsMixin.LogListProperty logs)	Sets the value of CfnBrokerMixinProps.getLogs()
CfnBrokerMixinProps.Builder	logs(IResolvable logs)	Sets the value of CfnBrokerMixinProps.getLogs()
CfnBrokerMixinProps.Builder	maintenanceWindowStartTime(CfnBrokerPropsMixin.MaintenanceWindowProperty maintenanceWindowStartTime)	Sets the value of CfnBrokerMixinProps.getMaintenanceWindowStartTime()
CfnBrokerMixinProps.Builder	maintenanceWindowStartTime(IResolvable maintenanceWindowStartTime)	Sets the value of CfnBrokerMixinProps.getMaintenanceWindowStartTime()
CfnBrokerMixinProps.Builder	publiclyAccessible(Boolean publiclyAccessible)	Sets the value of CfnBrokerMixinProps.getPubliclyAccessible()
CfnBrokerMixinProps.Builder	publiclyAccessible(IResolvable publiclyAccessible)	Sets the value of CfnBrokerMixinProps.getPubliclyAccessible()
CfnBrokerMixinProps.Builder	securityGroups(List<String> securityGroups)	Sets the value of CfnBrokerMixinProps.getSecurityGroups()
CfnBrokerMixinProps.Builder	storageType(String storageType)	Sets the value of CfnBrokerMixinProps.getStorageType()
CfnBrokerMixinProps.Builder	subnetIds(List<String> subnetIds)	Sets the value of CfnBrokerMixinProps.getSubnetIds()
CfnBrokerMixinProps.Builder	tags(List<? extends CfnBrokerPropsMixin.TagsEntryProperty> tags)	Sets the value of CfnBrokerMixinProps.getTags()
CfnBrokerMixinProps.Builder	users(List<? extends Object> users)	Sets the value of CfnBrokerMixinProps.getUsers()
CfnBrokerMixinProps.Builder	users(IResolvable users)	Sets the value of CfnBrokerMixinProps.getUsers()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

authenticationStrategy

@Stability(Stable)
public CfnBrokerMixinProps.Builder authenticationStrategy(String authenticationStrategy)

Sets the value of CfnBrokerMixinProps.getAuthenticationStrategy()

Parameters:

authenticationStrategy - Optional. The authentication strategy used to secure the broker. The default is SIMPLE .

Returns:

this

autoMinorVersionUpgrade

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

Sets the value of CfnBrokerMixinProps.getAutoMinorVersionUpgrade()

Parameters:

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.

Returns:

this

autoMinorVersionUpgrade

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

Sets the value of CfnBrokerMixinProps.getAutoMinorVersionUpgrade()

Parameters:

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.

Returns:

this

brokerName

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

Sets the value of CfnBrokerMixinProps.getBrokerName()

Parameters:

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.

Returns:

this

configuration

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

Sets the value of CfnBrokerMixinProps.getConfiguration()

Parameters:

configuration - A list of information about the configuration.

Returns:

this

configuration

@Stability(Stable)
public CfnBrokerMixinProps.Builder configuration(CfnBrokerPropsMixin.ConfigurationIdProperty configuration)

Sets the value of CfnBrokerMixinProps.getConfiguration()

Parameters:

configuration - A list of information about the configuration.

Returns:

this

dataReplicationMode

@Stability(Stable)
public CfnBrokerMixinProps.Builder dataReplicationMode(String dataReplicationMode)

Sets the value of CfnBrokerMixinProps.getDataReplicationMode()

Parameters:

dataReplicationMode - Defines whether this broker is a part of a data replication pair.

Returns:

this

dataReplicationPrimaryBrokerArn

@Stability(Stable)
public CfnBrokerMixinProps.Builder dataReplicationPrimaryBrokerArn(String dataReplicationPrimaryBrokerArn)

Sets the value of CfnBrokerMixinProps.getDataReplicationPrimaryBrokerArn()

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. Must be set when dataReplicationMode is set to CRDR.

Returns:

this

deploymentMode

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

Sets the value of CfnBrokerMixinProps.getDeploymentMode()

Parameters:

deploymentMode - Required. The broker's deployment mode.

Returns:

this

encryptionOptions

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

Sets the value of CfnBrokerMixinProps.getEncryptionOptions()

Parameters:

encryptionOptions - Encryption options for the broker.

Returns:

this

encryptionOptions

@Stability(Stable)
public CfnBrokerMixinProps.Builder encryptionOptions(CfnBrokerPropsMixin.EncryptionOptionsProperty encryptionOptions)

Sets the value of CfnBrokerMixinProps.getEncryptionOptions()

Parameters:

encryptionOptions - Encryption options for the broker.

Returns:

this

engineType

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

Sets the value of CfnBrokerMixinProps.getEngineType()

Parameters:

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

Returns:

this

engineVersion

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

Sets the value of CfnBrokerMixinProps.getEngineVersion()

Parameters:

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.

Returns:

this

hostInstanceType

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

Sets the value of CfnBrokerMixinProps.getHostInstanceType()

Parameters:

hostInstanceType - Required. The broker's instance type.

Returns:

this

ldapServerMetadata

@Stability(Stable)
public CfnBrokerMixinProps.Builder ldapServerMetadata(IResolvable ldapServerMetadata)

Sets the value of CfnBrokerMixinProps.getLdapServerMetadata()

Parameters:

ldapServerMetadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Returns:

this

ldapServerMetadata

@Stability(Stable)
public CfnBrokerMixinProps.Builder ldapServerMetadata(CfnBrokerPropsMixin.LdapServerMetadataProperty ldapServerMetadata)

Sets the value of CfnBrokerMixinProps.getLdapServerMetadata()

Parameters:

ldapServerMetadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Returns:

this

logs

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

Sets the value of CfnBrokerMixinProps.getLogs()

Parameters:

logs - Enables Amazon CloudWatch logging for brokers.

Returns:

this

logs

@Stability(Stable)
public CfnBrokerMixinProps.Builder logs(CfnBrokerPropsMixin.LogListProperty logs)

Sets the value of CfnBrokerMixinProps.getLogs()

Parameters:

logs - Enables Amazon CloudWatch logging for brokers.

Returns:

this

maintenanceWindowStartTime

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

Sets the value of CfnBrokerMixinProps.getMaintenanceWindowStartTime()

Parameters:

maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.

Returns:

this

maintenanceWindowStartTime

@Stability(Stable)
public CfnBrokerMixinProps.Builder maintenanceWindowStartTime(CfnBrokerPropsMixin.MaintenanceWindowProperty maintenanceWindowStartTime)

Sets the value of CfnBrokerMixinProps.getMaintenanceWindowStartTime()

Parameters:

maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.

Returns:

this

publiclyAccessible

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

Sets the value of CfnBrokerMixinProps.getPubliclyAccessible()

Parameters:

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.

Returns:

this

publiclyAccessible

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

Sets the value of CfnBrokerMixinProps.getPubliclyAccessible()

Parameters:

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.

Returns:

this

securityGroups

@Stability(Stable)
public CfnBrokerMixinProps.Builder securityGroups(List<String> securityGroups)

Sets the value of CfnBrokerMixinProps.getSecurityGroups()

Parameters:

securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

Returns:

this

storageType

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

Sets the value of CfnBrokerMixinProps.getStorageType()

Parameters:

storageType - The broker's storage type.

Returns:

this

subnetIds

@Stability(Stable)
public CfnBrokerMixinProps.Builder subnetIds(List<String> subnetIds)

Sets the value of CfnBrokerMixinProps.getSubnetIds()

Parameters:

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 .

Returns:

this

tags

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

Sets the value of CfnBrokerMixinProps.getTags()

Parameters:

tags - Create tags when creating the broker.

Returns:

this

users

@Stability(Stable)
public CfnBrokerMixinProps.Builder users(IResolvable users)

Sets the value of CfnBrokerMixinProps.getUsers()

Parameters:

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.

Returns:

this

users

@Stability(Stable)
public CfnBrokerMixinProps.Builder users(List<? extends Object> users)

Sets the value of CfnBrokerMixinProps.getUsers()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnBrokerMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnBrokerMixinProps

Throws:

NullPointerException - if any required attribute was not provided