configurations

Creates, updates, deletes, gets or lists a configurations resource.

Overview

Name	configurations
Type	Resource
Id	aws.mq.configurations

Fields

The following fields are returned by SELECT queries:

describe_configuration

Name	Datatype	Description
arn	string	Required. The ARN of the configuration.
authentication_strategy	string	Optional. The authentication strategy used to secure the broker. The default is SIMPLE. (SIMPLE, LDAP, CONFIG_MANAGED)
created	string (date-time)	Required. The date and time of the configuration revision.
description	string	Required. The description of the configuration.
engine_type	string	The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ. (ACTIVEMQ, RABBITMQ)
engine_version	string	The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
id	string	Required. The unique ID that Amazon MQ generates for the configuration.
latest_revision	object	Required. The latest revision of the configuration.
name	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.
tags	object	The list of all tags associated with this configuration.

list_configurations

Name	Datatype	Description
configurations	array	The list of all revisions for the specified configuration.
max_results	integer	The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
next_token	string	The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_configuration	select	configuration-id, region		Returns information about the specified configuration.
list_configurations	select	region	maxResults, nextToken	Returns a list of all configurations.
create_configuration	insert	region, EngineType		Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
update_configuration	update	configuration-id, region, Data		Updates the specified configuration.
delete_configuration	delete	configuration-id, region		Deletes the specified configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
configuration-id	string	The unique ID that Amazon MQ generates for the configuration.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
nextToken	string	The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

SELECT examples

describe_configuration

Returns information about the specified configuration.

SELECT
arn,
authentication_strategy,
created,
description,
engine_type,
engine_version,
id,
latest_revision,
name,
tags
FROM aws.mq.configurations
WHERE `configuration-id` = '{{ configuration-id }}' -- required
AND region = '{{ region }}' -- required
;

list_configurations

Returns a list of all configurations.

SELECT
configurations,
max_results,
next_token
FROM aws.mq.configurations
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_configuration

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

INSERT INTO aws.mq.configurations (
AuthenticationStrategy,
EngineType,
EngineVersion,
Name,
Tags,
region
)
SELECT 
'{{ AuthenticationStrategy }}',
'{{ EngineType }}' /* required */,
'{{ EngineVersion }}',
'{{ Name }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
authentication_strategy,
created,
id,
latest_revision,
name
;

Manifest

# Description fields are for documentation purposes
- name: configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configurations resource.
  - name: AuthenticationStrategy
    value: "{{ AuthenticationStrategy }}"
    description: |
      Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
    valid_values: ['SIMPLE', 'LDAP', 'CONFIG_MANAGED']
  - name: EngineType
    value: "{{ EngineType }}"
    description: |
      The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
    valid_values: ['ACTIVEMQ', 'RABBITMQ']
  - name: EngineVersion
    value: "{{ EngineVersion }}"
  - name: Name
    value: "{{ Name }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_configuration

Updates the specified configuration.

UPDATE aws.mq.configurations
SET 
Data = '{{ Data }}',
Description = '{{ Description }}'
WHERE 
`configuration-id` = '{{ configuration-id }}' --required
AND region = '{{ region }}' --required
AND Data = '{{ Data }}' --required
RETURNING
arn,
created,
id,
latest_revision,
name,
warnings;

DELETE examples

delete_configuration

Deletes the specified configuration.

DELETE FROM aws.mq.configurations
WHERE `configuration-id` = '{{ configuration-id }}' --required
AND region = '{{ region }}' --required
;