interface CfnBrokerProps

Language	Type name
.NET	`Amazon.CDK.AWS.AmazonMQ.CfnBrokerProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsamazonmq#CfnBrokerProps`
Java	`software.amazon.awscdk.services.amazonmq.CfnBrokerProps`
Python	`aws_cdk.aws_amazonmq.CfnBrokerProps`
TypeScript	`aws-cdk-lib` » `aws_amazonmq` » `CfnBrokerProps`

Properties for defining a CfnBroker.

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-lib';
const cfnBrokerProps: amazonmq.CfnBrokerProps = {
  brokerName: 'brokerName',
  deploymentMode: 'deploymentMode',
  engineType: 'engineType',
  hostInstanceType: 'hostInstanceType',
  publiclyAccessible: false,

  // the properties below are optional
  authenticationStrategy: 'authenticationStrategy',
  autoMinorVersionUpgrade: false,
  configuration: {
    id: 'id',
    revision: 123,
  },
  dataReplicationMode: 'dataReplicationMode',
  dataReplicationPrimaryBrokerArn: 'dataReplicationPrimaryBrokerArn',
  encryptionOptions: {
    useAwsOwnedKey: false,

    // the properties below are optional
    kmsKeyId: 'kmsKeyId',
  },
  engineVersion: 'engineVersion',
  ldapServerMetadata: {
    hosts: ['hosts'],
    roleBase: 'roleBase',
    roleSearchMatching: 'roleSearchMatching',
    serviceAccountUsername: 'serviceAccountUsername',
    userBase: 'userBase',
    userSearchMatching: 'userSearchMatching',

    // the properties below are optional
    roleName: 'roleName',
    roleSearchSubtree: false,
    serviceAccountPassword: 'serviceAccountPassword',
    userRoleName: 'userRoleName',
    userSearchSubtree: false,
  },
  logs: {
    audit: false,
    general: false,
  },
  maintenanceWindowStartTime: {
    dayOfWeek: 'dayOfWeek',
    timeOfDay: 'timeOfDay',
    timeZone: 'timeZone',
  },
  securityGroups: ['securityGroups'],
  storageType: 'storageType',
  subnetIds: ['subnetIds'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  users: [{
    password: 'password',
    username: 'username',

    // the properties below are optional
    consoleAccess: false,
    groups: ['groups'],
    replicationUser: false,
  }],
};

Properties

Name	Type	Description
brokerName	`string`	Required.
deploymentMode	`string`	Required.
engineType	`string`	Required.
hostInstanceType	`string`	Required.
publiclyAccessible	`boolean \|` `IResolvable`	Enables connections from applications outside of the VPC that hosts the broker's subnets.
authenticationStrategy?	`string`	Optional.
autoMinorVersionUpgrade?	`boolean \|` `IResolvable`	Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.
configuration?	`IResolvable` `\|` `ConfigurationIdProperty`	A list of information about the configuration.
dataReplicationMode?	`string`	Defines whether this broker is a part of a data replication pair.
dataReplicationPrimaryBrokerArn?	`string`	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.
encryptionOptions?	`IResolvable` `\|` `EncryptionOptionsProperty`	Encryption options for the broker.
engineVersion?	`string`	The broker engine version.
ldapServerMetadata?	`IResolvable` `\|` `LdapServerMetadataProperty`	Optional.
logs?	`IResolvable` `\|` `LogListProperty`	Enables Amazon CloudWatch logging for brokers.
maintenanceWindowStartTime?	`IResolvable` `\|` `MaintenanceWindowProperty`	The parameters that determine the WeeklyStartTime.
securityGroups?	`string[]`	The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
storageType?	`string`	The broker's storage type.
subnetIds?	`string[]`	The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
tags?	`TagsEntryProperty[]`	Create tags when creating the broker.
users?	`IResolvable` `\| (IResolvable` `\|` `UserProperty)[]`	The list of broker users (persons or applications) who can access queues and topics.

brokerName

Type: string

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.

deploymentMode

Type: string

Required.

The broker's deployment mode.

engineType

Type: string

Required.

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

hostInstanceType

Type: string

Required.

The broker's instance type.

publiclyAccessible

Type: boolean | IResolvable

Enables connections from applications outside of the VPC that hosts the broker's subnets.

Set to false by default, if no value is provided.

authenticationStrategy?

Type: string (optional)

Optional.

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

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

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.

configuration?

Type: IResolvable | ConfigurationIdProperty (optional)

A list of information about the configuration.

dataReplicationMode?

Type: string (optional)

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

dataReplicationPrimaryBrokerArn?

Type: string (optional)

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.

encryptionOptions?

Type: IResolvable | EncryptionOptionsProperty (optional)

Encryption options for the broker.

engineVersion?

Type: string (optional)

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.

ldapServerMetadata?

Type: IResolvable | LdapServerMetadataProperty (optional)

Optional.

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

logs?

Type: IResolvable | LogListProperty (optional)

Enables Amazon CloudWatch logging for brokers.

maintenanceWindowStartTime?

Type: IResolvable | MaintenanceWindowProperty (optional)

The parameters that determine the WeeklyStartTime.

securityGroups?

Type: string[] (optional)

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

storageType?

Type: string (optional)

The broker's storage type.

subnetIds?

Type: string[] (optional)

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 .

tags?

Type: TagsEntryProperty[] (optional)

Create tags when creating the broker.

users?

Type: IResolvable | (IResolvable | UserProperty)[] (optional)

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.