configurations

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

Overview

Name	configurations
Type	Resource
Id	aws.kafka.configurations

Fields

The following fields are returned by SELECT queries:

describe_configuration

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the configuration.
creation_time	string (date-time)	The time when the configuration was created.
description	string	The description of the configuration.
kafka_versions	array	The versions of Apache Kafka with which you can use this MSK configuration.
latest_revision	object	Latest revision of the configuration.
name	string	The name of the configuration.
state	string	The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. (ACTIVE, DELETING, DELETE_FAILED)

list_configurations

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the configuration.
creation_time	string (date-time)	The time when the configuration was created.
description	string	The description of the configuration.
kafka_versions	array	An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.
latest_revision	object	Latest revision of the configuration.
name	string	The name of the configuration.
state	string	The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. (ACTIVE, DELETING, DELETE_FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_configuration	select	arn, region		Returns a description of this MSK configuration.
list_configurations	select	region	maxResults, nextToken	Returns a list of all the MSK configurations in this Region.
create_configuration	insert	region, ServerProperties		Creates a new MSK configuration.
update_cluster_configuration	update	cluster_arn, region, ConfigurationInfo, CurrentVersion		Updates the cluster with the configuration that is specified in the request body.
update_configuration	update	arn, region, ServerProperties		Updates an MSK configuration.
delete_configuration	delete	arn, region		Deletes an MSK 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
arn	string	The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
cluster_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the cluster.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
nextToken	string	The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

SELECT examples

describe_configuration

Returns a description of this MSK configuration.

SELECT
arn,
creation_time,
description,
kafka_versions,
latest_revision,
name,
state
FROM aws.kafka.configurations
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_configurations

Returns a list of all the MSK configurations in this Region.

SELECT
arn,
creation_time,
description,
kafka_versions,
latest_revision,
name,
state
FROM aws.kafka.configurations
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_configuration

Creates a new MSK configuration.

INSERT INTO aws.kafka.configurations (
Description,
KafkaVersions,
Name,
ServerProperties,
region
)
SELECT 
'{{ Description }}',
'{{ KafkaVersions }}',
'{{ Name }}',
'{{ ServerProperties }}' /* required */,
'{{ region }}'
RETURNING
arn,
creation_time,
latest_revision,
name,
state
;

Manifest

# Description fields are for documentation purposes
- name: configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configurations resource.
  - name: Description
    value: "{{ Description }}"
  - name: KafkaVersions
    value:
      - "{{ KafkaVersions }}"
  - name: Name
    value: "{{ Name }}"
  - name: ServerProperties
    value: "{{ ServerProperties }}"

UPDATE examples

update_cluster_configuration

Updates the cluster with the configuration that is specified in the request body.

UPDATE aws.kafka.configurations
SET 
ConfigurationInfo = '{{ ConfigurationInfo }}',
CurrentVersion = '{{ CurrentVersion }}'
WHERE 
cluster_arn = '{{ cluster_arn }}' --required
AND region = '{{ region }}' --required
AND ConfigurationInfo = '{{ ConfigurationInfo }}' --required
AND CurrentVersion = '{{ CurrentVersion }}' --required
RETURNING
cluster_arn,
cluster_operation_arn;

update_configuration

Updates an MSK configuration.

UPDATE aws.kafka.configurations
SET 
Description = '{{ Description }}',
ServerProperties = '{{ ServerProperties }}'
WHERE 
arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
AND ServerProperties = '{{ ServerProperties }}' --required
RETURNING
arn,
latest_revision;

DELETE examples

delete_configuration

Deletes an MSK Configuration.

DELETE FROM aws.kafka.configurations
WHERE arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
;