CfnConfigurationProps

class aws_cdk.aws_amazonmq.CfnConfigurationProps(*, data, engine_type, engine_version, name, authentication_strategy=None, description=None, tags=None)

Bases: object

Properties for defining a CfnConfiguration.

Parameters
  • data (str) – The base64-encoded XML configuration.

  • engine_type (str) – The type of broker engine. Note: Currently, Amazon MQ only supports ACTIVEMQ for creating and editing broker configurations.

  • engine_version (str) – The version of the broker engine. For a list of supported engine versions, see ` <https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html>`_

  • name (str) – The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

  • authentication_strategy (Optional[str]) – Optional. The authentication strategy associated with the configuration. The default is SIMPLE .

  • description (Optional[str]) – The description of the configuration.

  • tags (Optional[Sequence[TagsEntryProperty]]) – Create tags when creating the configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.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_configuration_props = amazonmq.CfnConfigurationProps(
    data="data",
    engine_type="engineType",
    engine_version="engineVersion",
    name="name",

    # the properties below are optional
    authentication_strategy="authenticationStrategy",
    description="description",
    tags=[amazonmq.CfnConfiguration.TagsEntryProperty(
        key="key",
        value="value"
    )]
)

Attributes

authentication_strategy

Optional.

The authentication strategy associated with the configuration. The default is SIMPLE .

Link

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

Return type

Optional[str]

data

The base64-encoded XML configuration.

Link

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

Return type

str

description

The description of the configuration.

Link

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

Return type

Optional[str]

engine_type

The type of broker engine.

Note: Currently, Amazon MQ only supports ACTIVEMQ for creating and editing broker configurations.

Link

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

Return type

str

engine_version

The version of the broker engine.

For a list of supported engine versions, see ` <https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html>`_

Link

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

Return type

str

name

The name of the configuration.

This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

Link

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

Return type

str

tags

Create tags when creating the configuration.

Link

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

Return type

Optional[List[TagsEntryProperty]]