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	awscc.amazonmq.configurations

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	The ID of the Amazon MQ configuration.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	configurations	INSERT	EngineType, Name, region
delete_resource	configurations	DELETE	Identifier, region
update_resource	configurations	UPDATE	Identifier, PatchDocument, region
list_resources	configurations_list_only	SELECT	region
get_resource	configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual configuration.

SELECT
  region,
  arn,
  authentication_strategy,
  engine_type,
  engine_version,
  data,
  description,
  id,
  name,
  revision,
  tags
FROM awscc.amazonmq.configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all configurations in a region.

SELECT
  region,
  id
FROM awscc.amazonmq.configurations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.amazonmq.configurations (
  EngineType,
  Name,
  region
)
SELECT
  '{{ engine_type }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.amazonmq.configurations (
  AuthenticationStrategy,
  EngineType,
  EngineVersion,
  Data,
  Description,
  Name,
  Tags,
  region
)
SELECT
  '{{ authentication_strategy }}',
  '{{ engine_type }}',
  '{{ engine_version }}',
  '{{ data }}',
  '{{ description }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: configuration
  props:
    - name: authentication_strategy
      value: '{{ authentication_strategy }}'
    - name: engine_type
      value: '{{ engine_type }}'
    - name: engine_version
      value: '{{ engine_version }}'
    - name: data
      value: '{{ data }}'
    - name: description
      value: '{{ description }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

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

/*+ update */
UPDATE awscc.amazonmq.configurations
SET PatchDocument = string('{{ {
    "Data": data,
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.amazonmq.configurations
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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:DeleteConfiguration

List

mq:ListConfigurations