CfnBroker

class aws_cdk.aws_amazonmq.CfnBroker(scope, id, *, broker_name, deployment_mode, engine_type, host_instance_type, publicly_accessible, 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, users=None)

Bases: CfnResource

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:

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

CloudformationResource:

AWS::AmazonMQ::Broker

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 = amazonmq.CfnBroker(self, "MyCfnBroker",
    broker_name="brokerName",
    deployment_mode="deploymentMode",
    engine_type="engineType",
    host_instance_type="hostInstanceType",
    publicly_accessible=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_username="serviceAccountUsername",
        user_base="userBase",
        user_search_matching="userSearchMatching",

        # the properties below are optional
        role_name="roleName",
        role_search_subtree=False,
        service_account_password="serviceAccountPassword",
        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"
    )],
    users=[amazonmq.CfnBroker.UserProperty(
        password="password",
        username="username",

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

Create a new AWS::AmazonMQ::Broker.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • broker_name (str) – 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. .. 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 CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.

  • deployment_mode (str) – Required. The broker’s deployment mode.

  • engine_type (str) – Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

  • host_instance_type (str) – Required. The broker’s instance type.

  • publicly_accessible (Union[bool, 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.

  • 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 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. .. epigraph:: Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

  • configuration (Union[IResolvable, ConfigurationIdProperty, Dict[str, Any], None]) – A list of information about the configuration.

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

  • engine_version (Optional[str]) – 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.

  • 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 parameters that determine the WeeklyStartTime.

  • 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 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. .. 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 endpoints in VPCs that are not owned by your AWS account .

  • tags (Optional[Sequence[Union[TagsEntryProperty, Dict[str, Any]]]]) – Create tags when creating the broker.

  • users (Union[IResolvable, Sequence[Union[IResolvable, UserProperty, Dict[str, Any]]], None]) – 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::AmazonMQ::Broker'
attr_amqp_endpoints

The AMQP endpoints of each broker instance as a list of strings.

amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671

CloudformationAttribute:

AmqpEndpoints

attr_arn

The Amazon Resource Name (ARN) of the Amazon MQ broker.

arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

CloudformationAttribute:

Arn

attr_configuration_id

The unique ID that Amazon MQ generates for the configuration.

c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

CloudformationAttribute:

ConfigurationId

attr_configuration_revision

The revision number of the configuration.

1

CloudformationAttribute:

ConfigurationRevision

attr_console_ur_ls

ConsoleURLs

Type:

cloudformationAttribute

attr_engine_version_current

The version in use.

This may have more precision than the specified EngineVersion.

CloudformationAttribute:

EngineVersionCurrent

attr_id

Id

Type:

cloudformationAttribute

attr_ip_addresses

The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.

['198.51.100.2', '203.0.113.9']

CloudformationAttribute:

IpAddresses

attr_mqtt_endpoints

The MQTT endpoints of each broker instance as a list of strings.

mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883

CloudformationAttribute:

MqttEndpoints

attr_open_wire_endpoints

The OpenWire endpoints of each broker instance as a list of strings.

ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617

CloudformationAttribute:

OpenWireEndpoints

attr_stomp_endpoints

The STOMP endpoints of each broker instance as a list of strings.

stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614

CloudformationAttribute:

StompEndpoints

attr_wss_endpoints

The WSS endpoints of each broker instance as a list of strings.

wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619

CloudformationAttribute:

WssEndpoints

authentication_strategy

Optional.

auto_minor_version_upgrade

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.

broker_name

Required.

broker_ref

A reference to a Broker resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

configuration

A list of information about the configuration.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

data_replication_mode

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

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.

deployment_mode

Required.

encryption_options

Encryption options for the broker.

engine_type

Required.

engine_version

The broker engine version.

env
host_instance_type

Required.

ldap_server_metadata

Optional.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

logs

Enables Amazon CloudWatch logging for brokers.

maintenance_window_start_time

The parameters that determine the WeeklyStartTime.

node

The tree node.

publicly_accessible

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

security_groups

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

storage_type

The broker’s storage type.

subnet_ids

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

tags

Tag Manager which manages the tags for this resource.

tags_raw

Create tags when creating the broker.

users

The list of broker users (persons or applications) who can access queues and topics.

Static Methods

classmethod arn_for_broker(resource)
Parameters:

resource (IBrokerRef)

Return type:

str

classmethod is_cfn_broker(x)

Checks whether the given object is a CfnBroker.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

ConfigurationIdProperty

class CfnBroker.ConfigurationIdProperty(*, id, revision)

Bases: object

A list of information about the configuration.

Parameters:

  • id (str) – Required. The unique ID that Amazon MQ generates for the configuration.

  • revision (Union[int, float]) – The revision number of the configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.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

configuration_id_property = amazonmq.CfnBroker.ConfigurationIdProperty(
    id="id",
    revision=123
)

Attributes

id

Required.

The unique ID that Amazon MQ generates for the configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-id

revision

The revision number of the configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-revision

EncryptionOptionsProperty

class CfnBroker.EncryptionOptionsProperty(*, use_aws_owned_key, kms_key_id=None)

Bases: object

Encryption options for the broker.

Parameters:

  • use_aws_owned_key (Union[bool, IResolvable]) – Enables the use of an AWS owned CMK using AWS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.

  • kms_key_id (Optional[str]) – The customer master key (CMK) to use for the A AWS (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.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

encryption_options_property = amazonmq.CfnBroker.EncryptionOptionsProperty(
    use_aws_owned_key=False,

    # the properties below are optional
    kms_key_id="kmsKeyId"
)

Attributes

kms_key_id

The customer master key (CMK) to use for the A AWS (KMS).

This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.

See:

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

use_aws_owned_key

Enables the use of an AWS owned CMK using AWS (KMS).

Set to true by default, if no value is provided, for example, for RabbitMQ brokers.

See:

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

LdapServerMetadataProperty

class CfnBroker.LdapServerMetadataProperty(*, hosts, role_base, role_search_matching, service_account_username, user_base, user_search_matching, role_name=None, role_search_subtree=None, service_account_password=None, user_role_name=None, user_search_subtree=None)

Bases: object

Optional.

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

Parameters:

  • hosts (Sequence[str])

  • role_base (str)

  • role_search_matching (str)

  • service_account_username (str)

  • user_base (str)

  • user_search_matching (str)

  • role_name (Optional[str])

  • role_search_subtree (Union[bool, IResolvable, None])

  • service_account_password (Optional[str])

  • user_role_name (Optional[str])

  • user_search_subtree (Union[bool, IResolvable, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.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

ldap_server_metadata_property = amazonmq.CfnBroker.LdapServerMetadataProperty(
    hosts=["hosts"],
    role_base="roleBase",
    role_search_matching="roleSearchMatching",
    service_account_username="serviceAccountUsername",
    user_base="userBase",
    user_search_matching="userSearchMatching",

    # the properties below are optional
    role_name="roleName",
    role_search_subtree=False,
    service_account_password="serviceAccountPassword",
    user_role_name="userRoleName",
    user_search_subtree=False
)

Attributes

hosts

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

Type:

see

role_base

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

Type:

see

role_name

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

Type:

see

role_search_matching

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

Type:

see

role_search_subtree

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

Type:

see

service_account_password

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

Type:

see

service_account_username

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

Type:

see

user_base

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

Type:

see

user_role_name

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

Type:

see

user_search_matching

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

Type:

see

user_search_subtree

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

Type:

see

LogListProperty

class CfnBroker.LogListProperty(*, audit=None, general=None)

Bases: object

The list of information about logs to be enabled for the specified broker.

Parameters:

  • audit (Union[bool, IResolvable, None]) – Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.

  • general (Union[bool, IResolvable, None]) – Enables general logging.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.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

log_list_property = amazonmq.CfnBroker.LogListProperty(
    audit=False,
    general=False
)

Attributes

audit

Enables audit logging.

Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-audit

general

Enables general logging.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-general

MaintenanceWindowProperty

class CfnBroker.MaintenanceWindowProperty(*, day_of_week, time_of_day, time_zone)

Bases: object

The parameters that determine the WeeklyStartTime.

Parameters:

  • day_of_week (str) – Required. The day of the week.

  • time_of_day (str) – Required. The time, in 24-hour format.

  • time_zone (str) – The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.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

maintenance_window_property = amazonmq.CfnBroker.MaintenanceWindowProperty(
    day_of_week="dayOfWeek",
    time_of_day="timeOfDay",
    time_zone="timeZone"
)

Attributes

day_of_week

Required.

The day of the week.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-dayofweek

time_of_day

Required.

The time, in 24-hour format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timeofday

time_zone

The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timezone

TagsEntryProperty

class CfnBroker.TagsEntryProperty(*, key, value)

Bases: object

Create tags when creating the broker.

Parameters:

  • key (str)

  • value (str)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.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

tags_entry_property = amazonmq.CfnBroker.TagsEntryProperty(
    key="key",
    value="value"
)

Attributes

key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html#cfn-amazonmq-broker-tagsentry-key

Type:

see

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html#cfn-amazonmq-broker-tagsentry-value

Type:

see

UserProperty

class CfnBroker.UserProperty(*, password, username, console_access=None, groups=None, replication_user=None)

Bases: object

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.

Parameters:

  • password (str) – Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

  • username (str) – The username of the broker user. The following restrictions apply to broker usernames:. - For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. - For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long. .. epigraph:: Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.

  • console_access (Union[bool, IResolvable, None]) – Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

  • groups (Optional[Sequence[str]]) – The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

  • replication_user (Union[bool, IResolvable, None]) – Defines if this user is intended for CRDR replication purposes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.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

user_property = amazonmq.CfnBroker.UserProperty(
    password="password",
    username="username",

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

Attributes

console_access

Enables access to the ActiveMQ Web Console for the ActiveMQ user.

Does not apply to RabbitMQ brokers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-consoleaccess

groups

The list of groups (20 maximum) to which the ActiveMQ user belongs.

This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-groups

password

Required.

The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-password

replication_user

Defines if this user is intended for CRDR replication purposes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-replicationuser

username

.

  • For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

  • For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-username

Type:

The username of the broker user. The following restrictions apply to broker usernames