interface CfnConfigurationProps

Language	Type name
.NET	Amazon.CDK.AWS.AmazonMQ.CfnConfigurationProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsamazonmq#CfnConfigurationProps
Java	software.amazon.awscdk.services.amazonmq.CfnConfigurationProps
Python	aws_cdk.aws_amazonmq.CfnConfigurationProps
TypeScript	aws-cdk-lib » aws_amazonmq » CfnConfigurationProps

Properties for defining a CfnConfiguration.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amazonmq as amazonmq } from 'aws-cdk-lib';
const cfnConfigurationProps: amazonmq.CfnConfigurationProps = {
  engineType: 'engineType',
  name: 'name',

  // the properties below are optional
  authenticationStrategy: 'authenticationStrategy',
  data: 'data',
  description: 'description',
  engineVersion: 'engineVersion',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
engineType	string	Required.
name	string	Required.
authenticationStrategy?	string	Optional.
data?	string	Amazon MQ for Active MQ: The base64-encoded XML configuration.
description?	string	The description of the configuration.
engineVersion?	string	The broker engine version.
tags?	TagsEntryProperty[]	Create tags when creating the configuration.

---

engineType

Type: string

Required.

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

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

---

name

Type: string

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-name

---

authenticationStrategy?

Type: string (optional)

Optional.

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

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

---

data?

Type: string (optional)

Amazon MQ for Active MQ: The base64-encoded XML configuration.

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

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

---

description?

Type: string (optional)

The description of the configuration.

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

---

engineVersion?

Type: string (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-engineversion

---

tags?

Type: TagsEntryProperty[] (optional)

Create tags when creating the configuration.

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