Package software.amazon.awscdk.services.amazonmq

Class CfnBroker

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.amazonmq.CfnBroker
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.298Z") @Stability(Stable) public class CfnBroker extends CfnResource implements IInspectable
A CloudFormation AWS::AmazonMQ::Broker.

A broker is a message broker environment running on Amazon MQ . It is the basic building block of Amazon MQ .

The AWS::AmazonMQ::Broker resource lets you create Amazon MQ for ActiveMQ and Amazon MQ for RabbitMQ brokers, add configuration changes or modify users for a speified ActiveMQ broker, return information about the specified broker, and delete the broker. For more information, see How Amazon MQ works in the Amazon MQ Developer Guide .

  • ec2:CreateNetworkInterface

This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.

  • ec2:CreateNetworkInterfacePermission

This permission is required to attach the ENI to the broker instance.

  • ec2:DeleteNetworkInterface
  • ec2:DeleteNetworkInterfacePermission
  • ec2:DetachNetworkInterface
  • ec2:DescribeInternetGateways
  • ec2:DescribeNetworkInterfaces
  • ec2:DescribeNetworkInterfacePermissions
  • ec2:DescribeRouteTables
  • ec2:DescribeSecurityGroups
  • ec2:DescribeSubnets
  • ec2:DescribeVpcs

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amazonmq.*;
 CfnBroker cfnBroker = CfnBroker.Builder.create(this, "MyCfnBroker")
         .autoMinorVersionUpgrade(false)
         .brokerName("brokerName")
         .deploymentMode("deploymentMode")
         .engineType("engineType")
         .engineVersion("engineVersion")
         .hostInstanceType("hostInstanceType")
         .publiclyAccessible(false)
         .users(List.of(UserProperty.builder()
                 .password("password")
                 .username("username")
                 // the properties below are optional
                 .consoleAccess(false)
                 .groups(List.of("groups"))
                 .build()))
         // the properties below are optional
         .authenticationStrategy("authenticationStrategy")
         .configuration(ConfigurationIdProperty.builder()
                 .id("id")
                 .revision(123)
                 .build())
         .encryptionOptions(EncryptionOptionsProperty.builder()
                 .useAwsOwnedKey(false)
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .build())
         .ldapServerMetadata(LdapServerMetadataProperty.builder()
                 .hosts(List.of("hosts"))
                 .roleBase("roleBase")
                 .roleSearchMatching("roleSearchMatching")
                 .serviceAccountPassword("serviceAccountPassword")
                 .serviceAccountUsername("serviceAccountUsername")
                 .userBase("userBase")
                 .userSearchMatching("userSearchMatching")
                 // the properties below are optional
                 .roleName("roleName")
                 .roleSearchSubtree(false)
                 .userRoleName("userRoleName")
                 .userSearchSubtree(false)
                 .build())
         .logs(LogListProperty.builder()
                 .audit(false)
                 .general(false)
                 .build())
         .maintenanceWindowStartTime(MaintenanceWindowProperty.builder()
                 .dayOfWeek("dayOfWeek")
                 .timeOfDay("timeOfDay")
                 .timeZone("timeZone")
                 .build())
         .securityGroups(List.of("securityGroups"))
         .storageType("storageType")
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(TagsEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnBroker

      protected CfnBroker(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnBroker

      protected CfnBroker(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnBroker

      @Stability(Stable) public CfnBroker(@NotNull Construct scope, @NotNull String id, @NotNull CfnBrokerProps props)
      Create a new AWS::AmazonMQ::Broker.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAmqpEndpoints

      @Stability(Stable) @NotNull public List<String> getAttrAmqpEndpoints()
      The AMQP endpoints of each broker instance as a list of strings.

      amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the Amazon MQ broker.

      arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

    • getAttrConfigurationId

      @Stability(Stable) @NotNull public String getAttrConfigurationId()
      The unique ID that Amazon MQ generates for the configuration.

      c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

    • getAttrConfigurationRevision

      @Stability(Stable) @NotNull public Number getAttrConfigurationRevision()
      The revision number of the configuration.

      1

    • getAttrIpAddresses

      @Stability(Stable) @NotNull public List<String> getAttrIpAddresses()
      The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.

      ['198.51.100.2', '203.0.113.9']

    • getAttrMqttEndpoints

      @Stability(Stable) @NotNull public List<String> getAttrMqttEndpoints()
      The MQTT endpoints of each broker instance as a list of strings.

      mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883

    • getAttrOpenWireEndpoints

      @Stability(Stable) @NotNull public List<String> getAttrOpenWireEndpoints()
      The OpenWire endpoints of each broker instance as a list of strings.

      ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617

    • getAttrStompEndpoints

      @Stability(Stable) @NotNull public List<String> getAttrStompEndpoints()
      The STOMP endpoints of each broker instance as a list of strings.

      stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614

    • getAttrWssEndpoints

      @Stability(Stable) @NotNull public List<String> getAttrWssEndpoints()
      The WSS endpoints of each broker instance as a list of strings.

      wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs.

      For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .

    • getAutoMinorVersionUpgrade

      @Stability(Stable) @NotNull public Object getAutoMinorVersionUpgrade()
      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.

    • setAutoMinorVersionUpgrade

      @Stability(Stable) public void setAutoMinorVersionUpgrade(@NotNull Boolean value)
      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.

    • setAutoMinorVersionUpgrade

      @Stability(Stable) public void setAutoMinorVersionUpgrade(@NotNull IResolvable value)
      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.

    • getBrokerName

      @Stability(Stable) @NotNull public String getBrokerName()
      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.

    • setBrokerName

      @Stability(Stable) public void setBrokerName(@NotNull String value)
      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.

    • getDeploymentMode

      @Stability(Stable) @NotNull public String getDeploymentMode()
      The deployment mode of the broker. Available values:.

      • SINGLE_INSTANCE
      • ACTIVE_STANDBY_MULTI_AZ
      • CLUSTER_MULTI_AZ

    • setDeploymentMode

      @Stability(Stable) public void setDeploymentMode(@NotNull String value)
      The deployment mode of the broker. Available values:.

      • SINGLE_INSTANCE
      • ACTIVE_STANDBY_MULTI_AZ
      • CLUSTER_MULTI_AZ

    • getEngineType

      @Stability(Stable) @NotNull public String getEngineType()
      The type of broker engine.

      Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

    • setEngineType

      @Stability(Stable) public void setEngineType(@NotNull String value)
      The type of broker engine.

      Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

    • getEngineVersion

      @Stability(Stable) @NotNull public String getEngineVersion()
      The version of the broker engine.

      For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@NotNull String value)
      The version of the broker engine.

      For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .

    • getHostInstanceType

      @Stability(Stable) @NotNull public String getHostInstanceType()
      The broker's instance type.

    • setHostInstanceType

      @Stability(Stable) public void setHostInstanceType(@NotNull String value)
      The broker's instance type.

    • getPubliclyAccessible

      @Stability(Stable) @NotNull public Object getPubliclyAccessible()
      Enables connections from applications outside of the VPC that hosts the broker's subnets.

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@NotNull Boolean value)
      Enables connections from applications outside of the VPC that hosts the broker's subnets.

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@NotNull IResolvable value)
      Enables connections from applications outside of the VPC that hosts the broker's subnets.

    • getUsers

      @Stability(Stable) @NotNull public Object getUsers()
      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.

    • setUsers

      @Stability(Stable) public void setUsers(@NotNull IResolvable value)
      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.

    • setUsers

      @Stability(Stable) public void setUsers(@NotNull List<Object> value)
      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.

    • getAuthenticationStrategy

      @Stability(Stable) @Nullable public String getAuthenticationStrategy()
      Optional.

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

    • setAuthenticationStrategy

      @Stability(Stable) public void setAuthenticationStrategy(@Nullable String value)
      Optional.

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

    • getConfiguration

      @Stability(Stable) @Nullable public Object getConfiguration()
      A list of information about the configuration.

      Does not apply to RabbitMQ brokers.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable IResolvable value)
      A list of information about the configuration.

      Does not apply to RabbitMQ brokers.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable CfnBroker.ConfigurationIdProperty value)
      A list of information about the configuration.

      Does not apply to RabbitMQ brokers.

    • getEncryptionOptions

      @Stability(Stable) @Nullable public Object getEncryptionOptions()
      Encryption options for the broker.

      Does not apply to RabbitMQ brokers.

    • setEncryptionOptions

      @Stability(Stable) public void setEncryptionOptions(@Nullable IResolvable value)
      Encryption options for the broker.

      Does not apply to RabbitMQ brokers.

    • setEncryptionOptions

      @Stability(Stable) public void setEncryptionOptions(@Nullable CfnBroker.EncryptionOptionsProperty value)
      Encryption options for the broker.

      Does not apply to RabbitMQ brokers.

    • getLdapServerMetadata

      @Stability(Stable) @Nullable public Object getLdapServerMetadata()
      Optional.

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

    • setLdapServerMetadata

      @Stability(Stable) public void setLdapServerMetadata(@Nullable IResolvable value)
      Optional.

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

    • setLdapServerMetadata

      @Stability(Stable) public void setLdapServerMetadata(@Nullable CfnBroker.LdapServerMetadataProperty value)
      Optional.

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

    • getLogs

      @Stability(Stable) @Nullable public Object getLogs()
      Enables Amazon CloudWatch logging for brokers.

    • setLogs

      @Stability(Stable) public void setLogs(@Nullable IResolvable value)
      Enables Amazon CloudWatch logging for brokers.

    • setLogs

      @Stability(Stable) public void setLogs(@Nullable CfnBroker.LogListProperty value)
      Enables Amazon CloudWatch logging for brokers.

    • getMaintenanceWindowStartTime

      @Stability(Stable) @Nullable public Object getMaintenanceWindowStartTime()
      The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

    • setMaintenanceWindowStartTime

      @Stability(Stable) public void setMaintenanceWindowStartTime(@Nullable IResolvable value)
      The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

    • setMaintenanceWindowStartTime

      @Stability(Stable) public void setMaintenanceWindowStartTime(@Nullable CfnBroker.MaintenanceWindowProperty value)
      The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

    • getSecurityGroups

      @Stability(Stable) @Nullable public List<String> getSecurityGroups()
      The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

    • setSecurityGroups

      @Stability(Stable) public void setSecurityGroups(@Nullable List<String> value)
      The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

    • getStorageType

      @Stability(Stable) @Nullable public String getStorageType()
      The broker's storage type.

    • setStorageType

      @Stability(Stable) public void setStorageType(@Nullable String value)
      The broker's storage type.

    • getSubnetIds

      @Stability(Stable) @Nullable public List<String> getSubnetIds()
      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 .

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@Nullable List<String> value)
      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 .