worker_configurations

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

Overview

Name	worker_configurations
Type	Resource
Id	aws.kafkaconnect.worker_configurations

Fields

The following fields are returned by SELECT queries:

describe_worker_configuration

Name	Datatype	Description
name	string	The name of the worker configuration.
creation_time	string (date-time)	The time that the worker configuration was created.
description	string	The description of the worker configuration.
latest_revision	object	The latest revision of the custom configuration.
worker_configuration_arn	string	The Amazon Resource Name (ARN) of the custom configuration.
worker_configuration_state	string	The state of the worker configuration. (ACTIVE, DELETING)

list_worker_configurations

Name	Datatype	Description
name	string	The name of the worker configuration.
creation_time	string (date-time)	The time that a worker configuration was created.
description	string	The description of a worker configuration.
latest_revision	object	The latest revision of a worker configuration.
worker_configuration_arn	string	The Amazon Resource Name (ARN) of the worker configuration.
worker_configuration_state	string	The state of the worker configuration. (ACTIVE, DELETING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_worker_configuration	select	worker_configuration_arn, region		Returns information about a worker configuration.
list_worker_configurations	select	region	maxResults, nextToken, namePrefix	Returns a list of all of the worker configurations in this account and Region.
create_worker_configuration	insert	region, name, propertiesFileContent		Creates a worker configuration using the specified properties.
delete_worker_configuration	delete	worker_configuration_arn, region		Deletes the specified worker 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
region	string	AWS region (default: us-east-1)
worker_configuration_arn	string	The Amazon Resource Name (ARN) of the worker configuration that you want to delete.
maxResults	integer	The maximum number of worker configurations to list in one response.
namePrefix	string	Lists worker configuration names that start with the specified text string.
nextToken	string	If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

SELECT examples

describe_worker_configuration

Returns information about a worker configuration.

SELECT
name,
creation_time,
description,
latest_revision,
worker_configuration_arn,
worker_configuration_state
FROM aws.kafkaconnect.worker_configurations
WHERE worker_configuration_arn = '{{ worker_configuration_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_worker_configurations

Returns a list of all of the worker configurations in this account and Region.

SELECT
name,
creation_time,
description,
latest_revision,
worker_configuration_arn,
worker_configuration_state
FROM aws.kafkaconnect.worker_configurations
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND namePrefix = '{{ namePrefix }}'
;

INSERT examples

create_worker_configuration

Creates a worker configuration using the specified properties.

INSERT INTO aws.kafkaconnect.worker_configurations (
description,
name,
propertiesFileContent,
tags,
region
)
SELECT 
'{{ description }}',
'{{ name }}' /* required */,
'{{ propertiesFileContent }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
name,
creation_time,
latest_revision,
worker_configuration_arn,
worker_configuration_state
;

Manifest

# Description fields are for documentation purposes
- name: worker_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the worker_configurations resource.
  - name: description
    value: "{{ description }}"
  - name: name
    value: "{{ name }}"
  - name: propertiesFileContent
    value: "{{ propertiesFileContent }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_worker_configuration

Deletes the specified worker configuration.

DELETE FROM aws.kafkaconnect.worker_configurations
WHERE worker_configuration_arn = '{{ worker_configuration_arn }}' --required
AND region = '{{ region }}' --required
;