CfnBrokerProps

class aws_cdk.aws_amazonmq.CfnBrokerProps(*, broker_name, deployment_mode, engine_type, host_instance_type, publicly_accessible, users, authentication_strategy=None, auto_minor_version_upgrade=None, configuration=None, data_replication_mode=None, data_replication_primary_broker_arn=None, encryption_options=None, engine_version=None, ldap_server_metadata=None, logs=None, maintenance_window_start_time=None, security_groups=None, storage_type=None, subnet_ids=None, tags=None)

Bases: object

Properties for defining a CfnBroker.

Parameters:

broker_name (str) – 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. .. epigraph:: 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.
deployment_mode (str) – The deployment mode of the broker. Available values:. - SINGLE_INSTANCE - ACTIVE_STANDBY_MULTI_AZ - CLUSTER_MULTI_AZ
engine_type (str) – The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .
host_instance_type (str) – The broker’s instance type.
publicly_accessible (Union[bool, IResolvable]) – Enables connections from applications outside of the VPC that hosts the broker’s subnets.
users (Union[IResolvable, Sequence[Union[IResolvable, UserProperty, Dict[str, Any]]]]) – 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.
authentication_strategy (Optional[str]) – Optional. The authentication strategy used to secure the broker. The default is SIMPLE .
auto_minor_version_upgrade (Union[bool, IResolvable, None]) – 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.
configuration (Union[IResolvable, ConfigurationIdProperty, Dict[str, Any], None]) – A list of information about the configuration. Does not apply to RabbitMQ brokers.
data_replication_mode (Optional[str]) – Defines whether this broker is a part of a data replication pair.
data_replication_primary_broker_arn (Optional[str]) – 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.
encryption_options (Union[IResolvable, EncryptionOptionsProperty, Dict[str, Any], None]) – Encryption options for the broker. Does not apply to RabbitMQ brokers.
engine_version (Optional[str]) – The version of the broker engine. For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .
ldap_server_metadata (Union[IResolvable, LdapServerMetadataProperty, Dict[str, Any], None]) – Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
logs (Union[IResolvable, LogListProperty, Dict[str, Any], None]) – Enables Amazon CloudWatch logging for brokers.
maintenance_window_start_time (Union[IResolvable, MaintenanceWindowProperty, Dict[str, Any], None]) – The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
security_groups (Optional[Sequence[str]]) – The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
storage_type (Optional[str]) – The broker’s storage type.
subnet_ids (Optional[Sequence[str]]) – 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. .. epigraph:: 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 .
tags (Optional[Sequence[Union[TagsEntryProperty, Dict[str, Any]]]]) – An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_amazonmq as amazonmq

cfn_broker_props = amazonmq.CfnBrokerProps(
    broker_name="brokerName",
    deployment_mode="deploymentMode",
    engine_type="engineType",
    host_instance_type="hostInstanceType",
    publicly_accessible=False,
    users=[amazonmq.CfnBroker.UserProperty(
        password="password",
        username="username",

        # the properties below are optional
        console_access=False,
        groups=["groups"],
        replication_user=False
    )],

    # the properties below are optional
    authentication_strategy="authenticationStrategy",
    auto_minor_version_upgrade=False,
    configuration=amazonmq.CfnBroker.ConfigurationIdProperty(
        id="id",
        revision=123
    ),
    data_replication_mode="dataReplicationMode",
    data_replication_primary_broker_arn="dataReplicationPrimaryBrokerArn",
    encryption_options=amazonmq.CfnBroker.EncryptionOptionsProperty(
        use_aws_owned_key=False,

        # the properties below are optional
        kms_key_id="kmsKeyId"
    ),
    engine_version="engineVersion",
    ldap_server_metadata=amazonmq.CfnBroker.LdapServerMetadataProperty(
        hosts=["hosts"],
        role_base="roleBase",
        role_search_matching="roleSearchMatching",
        service_account_password="serviceAccountPassword",
        service_account_username="serviceAccountUsername",
        user_base="userBase",
        user_search_matching="userSearchMatching",

        # the properties below are optional
        role_name="roleName",
        role_search_subtree=False,
        user_role_name="userRoleName",
        user_search_subtree=False
    ),
    logs=amazonmq.CfnBroker.LogListProperty(
        audit=False,
        general=False
    ),
    maintenance_window_start_time=amazonmq.CfnBroker.MaintenanceWindowProperty(
        day_of_week="dayOfWeek",
        time_of_day="timeOfDay",
        time_zone="timeZone"
    ),
    security_groups=["securityGroups"],
    storage_type="storageType",
    subnet_ids=["subnetIds"],
    tags=[amazonmq.CfnBroker.TagsEntryProperty(
        key="key",
        value="value"
    )]
)

Attributes

authentication_strategy

Optional.

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

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

auto_minor_version_upgrade

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.

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

broker_name

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. .. epigraph:

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.

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

configuration

A list of information about the configuration.

Does not apply to RabbitMQ brokers.

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

data_replication_mode

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

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

data_replication_primary_broker_arn

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.

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

deployment_mode

.

SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-deploymentmode
Type:: The deployment mode of the broker. Available values

encryption_options

Encryption options for the broker.

Does not apply to RabbitMQ brokers.

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

engine_type

The type of broker engine.

Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

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

engine_version

The version of the broker engine.

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

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

host_instance_type

The broker’s instance type.

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

ldap_server_metadata

Optional.

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

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

logs

Enables Amazon CloudWatch logging for brokers.

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

maintenance_window_start_time

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

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

publicly_accessible

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

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

security_groups

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

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

storage_type

The broker’s storage type.

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

subnet_ids

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. .. epigraph:

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 .

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

tags

An array of key-value pairs.

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

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

users

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.

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