This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::AmazonMQ::Configuration
<a name="aws-resource-amazonmq-configuration"></a>

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

## Syntax
<a name="aws-resource-amazonmq-configuration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-amazonmq-configuration-syntax.json"></a>

```
{
  "Type" : "AWS::AmazonMQ::Configuration",
  "Properties" : {
      "[AuthenticationStrategy](#cfn-amazonmq-configuration-authenticationstrategy)" : String,
      "[Data](#cfn-amazonmq-configuration-data)" : String,
      "[Description](#cfn-amazonmq-configuration-description)" : String,
      "[EngineType](#cfn-amazonmq-configuration-enginetype)" : String,
      "[EngineVersion](#cfn-amazonmq-configuration-engineversion)" : String,
      "[Name](#cfn-amazonmq-configuration-name)" : String,
      "[Tags](#cfn-amazonmq-configuration-tags)" : [ TagsEntry, ... ]
    }
}
```

### YAML
<a name="aws-resource-amazonmq-configuration-syntax.yaml"></a>

```
Type: AWS::AmazonMQ::Configuration
Properties:
  [AuthenticationStrategy](#cfn-amazonmq-configuration-authenticationstrategy): String
  [Data](#cfn-amazonmq-configuration-data): String
  [Description](#cfn-amazonmq-configuration-description): String
  [EngineType](#cfn-amazonmq-configuration-enginetype): String
  [EngineVersion](#cfn-amazonmq-configuration-engineversion): String
  [Name](#cfn-amazonmq-configuration-name): String
  [Tags](#cfn-amazonmq-configuration-tags): 
    - TagsEntry
```

## Properties
<a name="aws-resource-amazonmq-configuration-properties"></a>

`AuthenticationStrategy`  <a name="cfn-amazonmq-configuration-authenticationstrategy"></a>
Optional. The authentication strategy associated with the configuration. The default is `SIMPLE`.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Data`  <a name="cfn-amazonmq-configuration-data"></a>
Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-amazonmq-configuration-description"></a>
The description of the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EngineType`  <a name="cfn-amazonmq-configuration-enginetype"></a>
Required. The type of broker engine. Currently, Amazon MQ supports `ACTIVEMQ` and `RABBITMQ`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EngineVersion`  <a name="cfn-amazonmq-configuration-engineversion"></a>
The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the [ActiveMQ version management](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html) and the [RabbitMQ version management](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html) sections in the Amazon MQ Developer Guide.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-amazonmq-configuration-name"></a>
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . \$1 \$1). This value must be 1-150 characters long.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-amazonmq-configuration-tags"></a>
Create tags when creating the configuration.  
*Required*: No  
*Type*: Array of [TagsEntry](aws-properties-amazonmq-configuration-tagsentry.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-amazonmq-configuration-return-values"></a>

### Ref
<a name="aws-resource-amazonmq-configuration-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon MQ configuration ID. For example: 

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

### Fn::GetAtt
<a name="aws-resource-amazonmq-configuration-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-amazonmq-configuration-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the Amazon MQ configuration.  
 `arn:aws:mq:us-east-2:123456789012:configuration:MyConfigurationDevelopment:c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9` 

`Id`  <a name="Id-fn::getatt"></a>
The ID of the Amazon MQ configuration.  
 `c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9` 

`Revision`  <a name="Revision-fn::getatt"></a>
The revision number of the configuration.  
 `1` 

## Examples
<a name="aws-resource-amazonmq-configuration--examples"></a>

### Amazon MQ Configuration
<a name="aws-resource-amazonmq-configuration--examples--Amazon_MQ_Configuration"></a>

#### JSON
<a name="aws-resource-amazonmq-configuration--examples--Amazon_MQ_Configuration--json"></a>

```
{
  "Description": "Create an Amazon MQ for ActiveMQ configuration",
    "Configuration1": {
      "Type": "AWS::AmazonMQ::Configuration",
      "Properties": {
        "Data": {
          "Fn::Base64": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<broker xmlns=\"http://activemq.apache.org/schema/core\" start=\"false\">\n  <destinationPolicy>\n    <policyMap>\n      <policyEntries>\n        <policyEntry topic=\">\">\n          <pendingMessageLimitStrategy>\n            <constantPendingMessageLimitStrategy limit=\"3000\"/>\n          </pendingMessageLimitStrategy>\n        </policyEntry>\n      </policyEntries>\n    </policyMap>\n  </destinationPolicy>\n  <plugins>\n  </plugins>\n</broker>\n"
        },
        "EngineType": "ACTIVEMQ",
        "EngineVersion": "5.15.0",
        "Name": "my-configuration-1"
      }
   }
}
```

#### YAML
<a name="aws-resource-amazonmq-configuration--examples--Amazon_MQ_Configuration--yaml"></a>

```
--- 
Description: "Create an Amazon MQ for ActiveMQ configuration"
Resources: 
  Configuration: 
    Type: "AWS::AmazonMQ::Configuration"
    Properties: 
      Data: 
        ? "Fn::Base64"
        : |
            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
            <broker xmlns="http://activemq.apache.org/schema/core" start="false">
              <destinationPolicy>
                <policyMap>
                  <policyEntries>
                    <policyEntry topic=">">
                      <pendingMessageLimitStrategy>
                        <constantPendingMessageLimitStrategy limit="3000"/>
                      </pendingMessageLimitStrategy>
                    </policyEntry>
                  </policyEntries>
                </policyMap>
              </destinationPolicy>
              <plugins>
              </plugins>
            </broker>
      EngineType: ACTIVEMQ
      EngineVersion: "5.15.0"
      Name: my-configuration-1
```

# AWS::AmazonMQ::Configuration TagsEntry
<a name="aws-properties-amazonmq-configuration-tagsentry"></a>

The list of all tags associated with this configuration.

## Syntax
<a name="aws-properties-amazonmq-configuration-tagsentry-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-amazonmq-configuration-tagsentry-syntax.json"></a>

```
{
  "[Key](#cfn-amazonmq-configuration-tagsentry-key)" : String,
  "[Value](#cfn-amazonmq-configuration-tagsentry-value)" : String
}
```

### YAML
<a name="aws-properties-amazonmq-configuration-tagsentry-syntax.yaml"></a>

```
  [Key](#cfn-amazonmq-configuration-tagsentry-key): String
  [Value](#cfn-amazonmq-configuration-tagsentry-value): String
```

## Properties
<a name="aws-properties-amazonmq-configuration-tagsentry-properties"></a>

`Key`  <a name="cfn-amazonmq-configuration-tagsentry-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-amazonmq-configuration-tagsentry-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)