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	aws.kafkaconnect.worker_configurations

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, PropertiesFileContent, 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 worker_configurations in a region.

SELECT
region,
name,
description,
worker_configuration_arn,
properties_file_content,
revision,
tags
FROM aws.kafkaconnect.worker_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual worker_configuration.

SELECT
region,
name,
description,
worker_configuration_arn,
properties_file_content,
revision,
tags
FROM aws.kafkaconnect.worker_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<WorkerConfigurationArn>';

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 aws.kafkaconnect.worker_configurations (
 Name,
 PropertiesFileContent,
 region
)
SELECT 
'{{ Name }}',
 '{{ PropertiesFileContent }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.kafkaconnect.worker_configurations (
 Name,
 Description,
 PropertiesFileContent,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ PropertiesFileContent }}',
 '{{ 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: PropertiesFileContent
        value: '{{ PropertiesFileContent }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.kafkaconnect.worker_configurations
WHERE data__Identifier = '<WorkerConfigurationArn>'
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