class CfnBrokerPropsMixin

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.AmazonMQ.CfnBrokerPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsamazonmq#CfnBrokerPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.amazonmq.CfnBrokerPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_amazonmq.CfnBrokerPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_amazonmq » CfnBrokerPropsMixin

Implements IMixin

Extends Mixin

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amazonmq as amazonmq } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnBrokerPropsMixin = new amazonmq.CfnBrokerPropsMixin({
  authenticationStrategy: 'authenticationStrategy',
  autoMinorVersionUpgrade: false,
  brokerName: 'brokerName',
  configuration: {
    id: 'id',
    revision: 123,
  },
  dataReplicationMode: 'dataReplicationMode',
  dataReplicationPrimaryBrokerArn: 'dataReplicationPrimaryBrokerArn',
  deploymentMode: 'deploymentMode',
  encryptionOptions: {
    kmsKeyId: 'kmsKeyId',
    useAwsOwnedKey: false,
  },
  engineType: 'engineType',
  engineVersion: 'engineVersion',
  hostInstanceType: 'hostInstanceType',
  ldapServerMetadata: {
    hosts: ['hosts'],
    roleBase: 'roleBase',
    roleName: 'roleName',
    roleSearchMatching: 'roleSearchMatching',
    roleSearchSubtree: false,
    serviceAccountPassword: 'serviceAccountPassword',
    serviceAccountUsername: 'serviceAccountUsername',
    userBase: 'userBase',
    userRoleName: 'userRoleName',
    userSearchMatching: 'userSearchMatching',
    userSearchSubtree: false,
  },
  logs: {
    audit: false,
    general: false,
  },
  maintenanceWindowStartTime: {
    dayOfWeek: 'dayOfWeek',
    timeOfDay: 'timeOfDay',
    timeZone: 'timeZone',
  },
  publiclyAccessible: false,
  securityGroups: ['securityGroups'],
  storageType: 'storageType',
  subnetIds: ['subnetIds'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  users: [{
    consoleAccess: false,
    groups: ['groups'],
    password: 'password',
    replicationUser: false,
    username: 'username',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnBrokerPropsMixin(props: CfnBrokerMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnBrokerMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::AmazonMQ::Broker.

Properties

Name	Type	Description
props	CfnBrokerMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnBrokerMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.