worker_configurations

Creates, updates, deletes or gets a worker_configuration resource or lists worker_configurations in a region

Overview

Name	worker_configurations
Type	Resource
Description	The configuration of the workers, which are the processes that run the connector logic.
Id	awscc.kafkaconnect.worker_configurations

Fields

get (all properties)

Name	Datatype	Description
name	string	The name of the worker configuration.
description	string	A summary description of the worker configuration.
worker_configuration_arn	string	The Amazon Resource Name (ARN) of the custom configuration.
properties_file_content	string	Base64 encoded contents of connect-distributed.properties file.
revision	integer	The description of a revision of the worker configuration.
▶tags	array	A collection of tags associated with a resource
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
worker_configuration_arn	string	The Amazon Resource Name (ARN) of the custom configuration.
region	string	AWS region.

For more information, see AWS::KafkaConnect::WorkerConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	worker_configurations	INSERT	Name, PropertiesFileContent, region
delete_resource	worker_configurations	DELETE	Identifier, region
update_resource	worker_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	worker_configurations_list_only	SELECT	region
get_resource	worker_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual worker_configuration.

SELECT
  region,
  name,
  description,
  worker_configuration_arn,
  properties_file_content,
  revision,
  tags
FROM awscc.kafkaconnect.worker_configurations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ worker_configuration_arn }}';

list (identifiers only)

Lists all worker_configurations in a region.

SELECT
  region,
  worker_configuration_arn
FROM awscc.kafkaconnect.worker_configurations_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new worker_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.kafkaconnect.worker_configurations (
  Name,
  PropertiesFileContent,
  region
)
SELECT
  '{{ name }}',
  '{{ properties_file_content }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.kafkaconnect.worker_configurations (
  Name,
  Description,
  PropertiesFileContent,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ properties_file_content }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: worker_configuration
    props:
      - name: name
        value: '{{ name }}'
      - name: description
        value: '{{ description }}'
      - name: properties_file_content
        value: '{{ properties_file_content }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.kafkaconnect.worker_configurations
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ worker_configuration_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.kafkaconnect.worker_configurations
WHERE
  Identifier = '{{ worker_configuration_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

kafkaconnect:DescribeWorkerConfiguration,
kafkaconnect:CreateWorkerConfiguration,
kafkaconnect:TagResource,
kafkaconnect:ListTagsForResource

Read

kafkaconnect:DescribeWorkerConfiguration,
kafkaconnect:ListTagsForResource

Update

kafkaconnect:DescribeWorkerConfiguration,
kafkaconnect:ListTagsForResource,
kafkaconnect:TagResource,
kafkaconnect:UntagResource

Delete

kafkaconnect:DescribeWorkerConfiguration,
kafkaconnect:DeleteWorkerConfiguration

List

kafkaconnect:ListWorkerConfigurations