CfnBrokerProps

class aws_cdk.aws_amazonmq.CfnBrokerProps(*, auto_minor_version_upgrade, broker_name, deployment_mode, engine_type, engine_version, host_instance_type, publicly_accessible, users, authentication_strategy=None, configuration=None, encryption_options=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
  • auto_minor_version_upgrade (Union[bool, IResolvable]) – 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.

  • 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 .

  • engine_version (str) – The version of the broker engine. For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .

  • 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]]]) – 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 .

  • configuration (Union[IResolvable, ConfigurationIdProperty, None]) – A list of information about the configuration. Does not apply to RabbitMQ brokers.

  • encryption_options (Union[IResolvable, EncryptionOptionsProperty, None]) – Encryption options for the broker. Does not apply to RabbitMQ brokers.

  • ldap_server_metadata (Union[IResolvable, LdapServerMetadataProperty, 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, None]) – Enables Amazon CloudWatch logging for brokers.

  • maintenance_window_start_time (Union[IResolvable, MaintenanceWindowProperty, 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[TagsEntryProperty]]) – An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .

Link

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.
import aws_cdk.aws_amazonmq as amazonmq

cfn_broker_props = amazonmq.CfnBrokerProps(
    auto_minor_version_upgrade=False,
    broker_name="brokerName",
    deployment_mode="deploymentMode",
    engine_type="engineType",
    engine_version="engineVersion",
    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"]
    )],

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

        # the properties below are optional
        kms_key_id="kmsKeyId"
    ),
    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 .

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Union[bool, IResolvable]

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.
Link

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

Return type

str

configuration

A list of information about the configuration.

Does not apply to RabbitMQ brokers.

Link

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

Return type

Union[IResolvable, ConfigurationIdProperty, None]

deployment_mode

.

  • SINGLE_INSTANCE

  • ACTIVE_STANDBY_MULTI_AZ

  • CLUSTER_MULTI_AZ

Link

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

Return type

str

encryption_options

Encryption options for the broker.

Does not apply to RabbitMQ brokers.

Link

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

Return type

Union[IResolvable, EncryptionOptionsProperty, None]

engine_type

The type of broker engine.

Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

Link

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

Return type

str

engine_version

The version of the broker engine.

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

Link

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

Return type

str

host_instance_type

The broker’s instance type.

Link

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

Return type

str

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.

Link

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

Return type

Union[IResolvable, LdapServerMetadataProperty, None]

logs

Enables Amazon CloudWatch logging for brokers.

Link

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

Return type

Union[IResolvable, LogListProperty, None]

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.

Link

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

Return type

Union[IResolvable, MaintenanceWindowProperty, None]

publicly_accessible

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

Link

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

Return type

Union[bool, IResolvable]

security_groups

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

Link

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

Return type

Optional[List[str]]

storage_type

The broker’s storage type.

Link

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

Return type

Optional[str]

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 .
Link

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

Return type

Optional[List[str]]

tags

An array of key-value pairs.

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

Link

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

Return type

Optional[List[TagsEntryProperty]]

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.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, UserProperty]]]