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

Class CfnBrokerPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.amazonmq.CfnBrokerPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-19T12:55:16.275Z") @Stability(Stable) public class CfnBrokerPropsMixin extends Mixin implements software.constructs.IMixin
Creates a broker. Note: This API is asynchronous.

To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.

  • 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

For more information, see Create an IAM User and Get Your AWS Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide .

Example: 

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

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnBrokerPropsMixin

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

    • CfnBrokerPropsMixin

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

    • CfnBrokerPropsMixin

      @Stability(Stable) public CfnBrokerPropsMixin(@NotNull CfnBrokerMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::AmazonMQ::Broker.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnBrokerPropsMixin

      @Stability(Stable) public CfnBrokerPropsMixin(@NotNull CfnBrokerMixinProps props)
      Create a mixin to apply properties to AWS::AmazonMQ::Broker.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnBrokerMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()