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::MSK::Configuration
Id	aws.msk.configurations

Fields

Name	Datatype	Description
name	string
description	string
server_properties	string
kafka_versions_list	array
arn	string
latest_revision	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ServerProperties, 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,
name,
description,
server_properties,
kafka_versions_list,
arn,
latest_revision
FROM aws.msk.configurations
WHERE region = 'us-east-1';

Gets all properties from an individual configuration.

SELECT
region,
name,
description,
server_properties,
kafka_versions_list,
arn,
latest_revision
FROM aws.msk.configurations
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

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.msk.configurations (
 Name,
 ServerProperties,
 region
)
SELECT 
'{{ Name }}',
 '{{ ServerProperties }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.msk.configurations (
 Name,
 Description,
 ServerProperties,
 KafkaVersionsList,
 LatestRevision,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ ServerProperties }}',
 '{{ KafkaVersionsList }}',
 '{{ LatestRevision }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: configuration
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: ServerProperties
        value: '{{ ServerProperties }}'
      - name: KafkaVersionsList
        value:
          - '{{ KafkaVersionsList[0] }}'
      - name: LatestRevision
        value:
          CreationTime: '{{ CreationTime }}'
          Description: '{{ Description }}'
          Revision: '{{ Revision }}'

DELETE example

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

Permissions

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

Create

kafka:CreateConfiguration,
Kafka:DescribeConfiguration

Delete

kafka:DeleteConfiguration,
kafka:DescribeConfiguration

List

kafka:ListConfigurations

Read

kafka:DescribeConfiguration

Update

kafka:UpdateConfiguration,
kafka:DescribeConfiguration