configurations

Creates, updates, deletes or gets a configuration resource or lists configurations in a region

Overview

Name	configurations
Type	Resource
Description	Resource Type definition for AWS::AmazonMQ::Configuration
Id	aws.amazonmq.configurations

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the Amazon MQ configuration.
authentication_strategy	string	The authentication strategy associated with the configuration. The default is SIMPLE.
engine_type	string	The type of broker engine. Note: Currently, Amazon MQ only supports ACTIVEMQ for creating and editing broker configurations.
engine_version	string	The version of the broker engine.
data	string	The base64-encoded XML configuration.
description	string	The description of the configuration.
id	string	The ID of the Amazon MQ configuration.
name	string	The name of the configuration.
revision	string	The revision number of the configuration.
tags	array	Create tags when creating the configuration.
region	string	AWS region.

For more information, see AWS::AmazonMQ::Configuration.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	EngineType, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all configurations in a region.

SELECT
region,
arn,
authentication_strategy,
engine_type,
engine_version,
data,
description,
id,
name,
revision,
tags
FROM aws.amazonmq.configurations
WHERE region = 'us-east-1';

Gets all properties from an individual configuration.

SELECT
region,
arn,
authentication_strategy,
engine_type,
engine_version,
data,
description,
id,
name,
revision,
tags
FROM aws.amazonmq.configurations
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.amazonmq.configurations (
 EngineType,
 Name,
 region
)
SELECT 
'{{ EngineType }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.amazonmq.configurations (
 AuthenticationStrategy,
 EngineType,
 EngineVersion,
 Data,
 Description,
 Name,
 Tags,
 region
)
SELECT 
 '{{ AuthenticationStrategy }}',
 '{{ EngineType }}',
 '{{ EngineVersion }}',
 '{{ Data }}',
 '{{ Description }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: configuration
    props:
      - name: AuthenticationStrategy
        value: '{{ AuthenticationStrategy }}'
      - name: EngineType
        value: '{{ EngineType }}'
      - name: EngineVersion
        value: '{{ EngineVersion }}'
      - name: Data
        value: '{{ Data }}'
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.amazonmq.configurations
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the configurations resource, the following permissions are required:

Create

mq:CreateConfiguration,
mq:CreateTags,
mq:UpdateConfiguration

Read

mq:DescribeConfiguration,
mq:ListTags

Update

mq:UpdateConfiguration,
mq:CreateTags,
mq:DeleteTags

Delete

mq:DescribeConfiguration

List

mq:ListConfigurations