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

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	configurations	INSERT	ServerProperties, 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,
  name,
  description,
  server_properties,
  kafka_versions_list,
  arn,
  latest_revision
FROM awscc.msk.configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all configurations in a region.

SELECT
  region,
  arn
FROM awscc.msk.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.msk.configurations (
  Name,
  ServerProperties,
  region
)
SELECT
  '{{ name }}',
  '{{ server_properties }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.msk.configurations (
  Name,
  Description,
  ServerProperties,
  KafkaVersionsList,
  LatestRevision,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ server_properties }}',
  '{{ kafka_versions_list }}',
  '{{ latest_revision }}',
  '{{ 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: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: server_properties
      value: '{{ server_properties }}'
    - name: kafka_versions_list
      value:
        - '{{ kafka_versions_list[0] }}'
    - name: latest_revision
      value:
        creation_time: '{{ creation_time }}'
        description: '{{ description }}'
        revision: '{{ revision }}'

UPDATE example

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

/*+ update */
UPDATE awscc.msk.configurations
SET PatchDocument = string('{{ {
    "Description": description,
    "ServerProperties": server_properties
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.msk.configurations
WHERE
  Identifier = '{{ arn }}' 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

kafka:CreateConfiguration,
Kafka:DescribeConfiguration

Delete

kafka:DeleteConfiguration,
kafka:DescribeConfiguration

List

kafka:ListConfigurations

Read

kafka:DescribeConfiguration

Update

kafka:UpdateConfiguration,
kafka:DescribeConfiguration