CfnConfigurationProps

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

Bases: object

Properties for defining a CfnConfiguration.

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

  • name (str) – Required. 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 .

  • data (Optional[str]) – Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.

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

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

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

See:

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

cfn_configuration_props = amazonmq.CfnConfigurationProps(
    engine_type="engineType",
    name="name",

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

Attributes

authentication_strategy

Optional.

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

See:

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

data

The base64-encoded XML configuration.

Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.

See:

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

Type:

Amazon MQ for Active MQ

description

The description of the configuration.

See:

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

engine_type

Required.

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

See:

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

engine_version

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.

See:

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

name

Required.

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.

See:

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

tags

Create tags when creating the configuration.

See:

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