Package software.amazon.awscdk.services.amazonmq

Class CfnBrokerProps.Builder

java.lang.Object
software.amazon.awscdk.services.amazonmq.CfnBrokerProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnBrokerProps>
Enclosing interface:
CfnBrokerProps
@Stability(Stable) public static final class CfnBrokerProps.Builder extends Object implements software.amazon.jsii.Builder<CfnBrokerProps>
A builder for CfnBrokerProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • brokerName

      @Stability(Stable) public CfnBrokerProps.Builder brokerName(String brokerName)
      Sets the value of CfnBrokerProps.getBrokerName()
      Parameters:
      brokerName - The name of the broker. This parameter is required. 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.

      Returns:
      this

    • deploymentMode

      @Stability(Stable) public CfnBrokerProps.Builder deploymentMode(String deploymentMode)
      Sets the value of CfnBrokerProps.getDeploymentMode()
      Parameters:
      deploymentMode - The deployment mode of the broker. Available values:. This parameter is required.
      • SINGLE_INSTANCE
      • ACTIVE_STANDBY_MULTI_AZ
      • CLUSTER_MULTI_AZ
      Returns:
      this

    • engineType

      @Stability(Stable) public CfnBrokerProps.Builder engineType(String engineType)
      Sets the value of CfnBrokerProps.getEngineType()
      Parameters:
      engineType - The type of broker engine. This parameter is required. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .
      Returns:
      this

    • hostInstanceType

      @Stability(Stable) public CfnBrokerProps.Builder hostInstanceType(String hostInstanceType)
      Sets the value of CfnBrokerProps.getHostInstanceType()
      Parameters:
      hostInstanceType - The broker's instance type. This parameter is required.
      Returns:
      this

    • publiclyAccessible

      @Stability(Stable) public CfnBrokerProps.Builder publiclyAccessible(Boolean publiclyAccessible)
      Sets the value of CfnBrokerProps.getPubliclyAccessible()
      Parameters:
      publiclyAccessible - Enables connections from applications outside of the VPC that hosts the broker's subnets. This parameter is required.
      Returns:
      this

    • publiclyAccessible

      @Stability(Stable) public CfnBrokerProps.Builder publiclyAccessible(IResolvable publiclyAccessible)
      Sets the value of CfnBrokerProps.getPubliclyAccessible()
      Parameters:
      publiclyAccessible - Enables connections from applications outside of the VPC that hosts the broker's subnets. This parameter is required.
      Returns:
      this

    • users

      @Stability(Stable) public CfnBrokerProps.Builder users(IResolvable users)
      Sets the value of CfnBrokerProps.getUsers()
      Parameters:
      users - The list of broker users (persons or applications) who can access queues and topics. This parameter is required. 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.
      Returns:
      this

    • users

      @Stability(Stable) public CfnBrokerProps.Builder users(List<? extends Object> users)
      Sets the value of CfnBrokerProps.getUsers()
      Parameters:
      users - The list of broker users (persons or applications) who can access queues and topics. This parameter is required. 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.
      Returns:
      this

    • authenticationStrategy

      @Stability(Stable) public CfnBrokerProps.Builder authenticationStrategy(String authenticationStrategy)
      Sets the value of CfnBrokerProps.getAuthenticationStrategy()
      Parameters:
      authenticationStrategy - Optional. The authentication strategy used to secure the broker. The default is SIMPLE .
      Returns:
      this

    • autoMinorVersionUpgrade

      @Stability(Stable) public CfnBrokerProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
      Sets the value of CfnBrokerProps.getAutoMinorVersionUpgrade()
      Parameters:
      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.
      Returns:
      this

    • autoMinorVersionUpgrade

      @Stability(Stable) public CfnBrokerProps.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)
      Sets the value of CfnBrokerProps.getAutoMinorVersionUpgrade()
      Parameters:
      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.
      Returns:
      this

    • configuration

      @Stability(Stable) public CfnBrokerProps.Builder configuration(IResolvable configuration)
      Sets the value of CfnBrokerProps.getConfiguration()
      Parameters:
      configuration - A list of information about the configuration. Does not apply to RabbitMQ brokers.
      Returns:
      this

    • configuration

      @Stability(Stable) public CfnBrokerProps.Builder configuration(CfnBroker.ConfigurationIdProperty configuration)
      Sets the value of CfnBrokerProps.getConfiguration()
      Parameters:
      configuration - A list of information about the configuration. Does not apply to RabbitMQ brokers.
      Returns:
      this

    • dataReplicationMode

      @Stability(Stable) public CfnBrokerProps.Builder dataReplicationMode(String dataReplicationMode)
      Sets the value of CfnBrokerProps.getDataReplicationMode()
      Parameters:
      dataReplicationMode - Defines whether this broker is a part of a data replication pair.
      Returns:
      this

    • dataReplicationPrimaryBrokerArn

      @Stability(Stable) public CfnBrokerProps.Builder dataReplicationPrimaryBrokerArn(String dataReplicationPrimaryBrokerArn)
      Sets the value of CfnBrokerProps.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

    • encryptionOptions

      @Stability(Stable) public CfnBrokerProps.Builder encryptionOptions(IResolvable encryptionOptions)
      Sets the value of CfnBrokerProps.getEncryptionOptions()
      Parameters:
      encryptionOptions - Encryption options for the broker. Does not apply to RabbitMQ brokers.
      Returns:
      this

    • encryptionOptions

      @Stability(Stable) public CfnBrokerProps.Builder encryptionOptions(CfnBroker.EncryptionOptionsProperty encryptionOptions)
      Sets the value of CfnBrokerProps.getEncryptionOptions()
      Parameters:
      encryptionOptions - Encryption options for the broker. Does not apply to RabbitMQ brokers.
      Returns:
      this

    • engineVersion

      @Stability(Stable) public CfnBrokerProps.Builder engineVersion(String engineVersion)
      Sets the value of CfnBrokerProps.getEngineVersion()
      Parameters:
      engineVersion - The version of the broker engine. For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .
      Returns:
      this

    • ldapServerMetadata

      @Stability(Stable) public CfnBrokerProps.Builder ldapServerMetadata(IResolvable ldapServerMetadata)
      Sets the value of CfnBrokerProps.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 CfnBrokerProps.Builder ldapServerMetadata(CfnBroker.LdapServerMetadataProperty ldapServerMetadata)
      Sets the value of CfnBrokerProps.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 CfnBrokerProps.Builder logs(IResolvable logs)
      Sets the value of CfnBrokerProps.getLogs()
      Parameters:
      logs - Enables Amazon CloudWatch logging for brokers.
      Returns:
      this

    • logs

      @Stability(Stable) public CfnBrokerProps.Builder logs(CfnBroker.LogListProperty logs)
      Sets the value of CfnBrokerProps.getLogs()
      Parameters:
      logs - Enables Amazon CloudWatch logging for brokers.
      Returns:
      this

    • maintenanceWindowStartTime

      @Stability(Stable) public CfnBrokerProps.Builder maintenanceWindowStartTime(IResolvable maintenanceWindowStartTime)
      Sets the value of CfnBrokerProps.getMaintenanceWindowStartTime()
      Parameters:
      maintenanceWindowStartTime - The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
      Returns:
      this

    • maintenanceWindowStartTime

      @Stability(Stable) public CfnBrokerProps.Builder maintenanceWindowStartTime(CfnBroker.MaintenanceWindowProperty maintenanceWindowStartTime)
      Sets the value of CfnBrokerProps.getMaintenanceWindowStartTime()
      Parameters:
      maintenanceWindowStartTime - The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
      Returns:
      this

    • securityGroups

      @Stability(Stable) public CfnBrokerProps.Builder securityGroups(List<String> securityGroups)
      Sets the value of CfnBrokerProps.getSecurityGroups()
      Parameters:
      securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
      Returns:
      this

    • storageType

      @Stability(Stable) public CfnBrokerProps.Builder storageType(String storageType)
      Sets the value of CfnBrokerProps.getStorageType()
      Parameters:
      storageType - The broker's storage type.
      Returns:
      this

    • subnetIds

      @Stability(Stable) public CfnBrokerProps.Builder subnetIds(List<String> subnetIds)
      Sets the value of CfnBrokerProps.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 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 .

      Returns:
      this

    • tags

      @Stability(Stable) public CfnBrokerProps.Builder tags(List<? extends CfnBroker.TagsEntryProperty> tags)
      Sets the value of CfnBrokerProps.getTags()
      Parameters:
      tags - An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
      Returns:
      this

    • build

      @Stability(Stable) public CfnBrokerProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnBrokerProps>
      Returns:
      a new instance of CfnBrokerProps
      Throws:
      NullPointerException - if any required attribute was not provided