AWS::AmazonMQ::Configuration
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
Note
Does not apply to RabbitMQ brokers.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::AmazonMQ::Configuration", "Properties" : { "AuthenticationStrategy" :
String
, "Data" :String
, "Description" :String
, "EngineType" :String
, "EngineVersion" :String
, "Name" :String
, "Tags" :[ TagsEntry, ... ]
} }
YAML
Type: AWS::AmazonMQ::Configuration Properties: AuthenticationStrategy:
String
Data:String
Description:String
EngineType:String
EngineVersion:String
Name:String
Tags:- TagsEntry
Properties
AuthenticationStrategy
-
Optional. The authentication strategy associated with the configuration. The default is
SIMPLE
.Required: No
Type: String
Update requires: Replacement
Data
-
The base64-encoded XML configuration.
Required: Yes
Type: String
Update requires: No interruption
Description
-
The description of the configuration.
Required: No
Type: String
Update requires: No interruption
EngineType
-
The type of broker engine. Note: Currently, Amazon MQ only supports ACTIVEMQ for creating and editing broker configurations.
Required: Yes
Type: String
Update requires: Replacement
EngineVersion
-
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
Required: No
Type: String
Update requires: Replacement
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.
Required: Yes
Type: String
Update requires: Replacement
-
Create tags when creating the configuration.
Required: No
Type: Array of TagsEntry
Update requires: No interruption
Return values
Ref
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
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 Fn::GetAtt
.
Arn
-
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
-
The ID of the Amazon MQ configuration.
c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
Revision
-
The revision number of the configuration.
1
Examples
Amazon MQ Configuration
JSON
{ "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
--- 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