custom_plugins

Creates, updates, deletes or gets a custom_plugin resource or lists custom_plugins in a region

Overview

Name	custom_plugins
Type	Resource
Description	An example resource schema demonstrating some basic constructs and validation rules.
Id	aws.kafkaconnect.custom_plugins

Fields

Name	Datatype	Description
name	string	The name of the custom plugin.
description	string	A summary description of the custom plugin.
custom_plugin_arn	string	The Amazon Resource Name (ARN) of the custom plugin to use.
content_type	string	The type of the plugin file.
file_description	object	Details about the custom plugin file.
location	object	Information about the location of a custom plugin.
revision	integer	The revision of the custom plugin.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

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

SELECT
region,
name,
description,
custom_plugin_arn,
content_type,
file_description,
location,
revision,
tags
FROM aws.kafkaconnect.custom_plugins
WHERE region = 'us-east-1';

Gets all properties from an individual custom_plugin.

SELECT
region,
name,
description,
custom_plugin_arn,
content_type,
file_description,
location,
revision,
tags
FROM aws.kafkaconnect.custom_plugins
WHERE region = 'us-east-1' AND data__Identifier = '<CustomPluginArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.kafkaconnect.custom_plugins (
 Name,
 ContentType,
 Location,
 region
)
SELECT 
'{{ Name }}',
 '{{ ContentType }}',
 '{{ Location }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.kafkaconnect.custom_plugins (
 Name,
 Description,
 ContentType,
 Location,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ ContentType }}',
 '{{ Location }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: custom_plugin
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: ContentType
        value: '{{ ContentType }}'
      - name: Location
        value:
          S3Location:
            BucketArn: '{{ BucketArn }}'
            FileKey: '{{ FileKey }}'
            ObjectVersion: '{{ ObjectVersion }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.kafkaconnect.custom_plugins
WHERE data__Identifier = '<CustomPluginArn>'
AND region = 'us-east-1';

Permissions

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

Create

kafkaconnect:DescribeCustomPlugin,
kafkaconnect:ListTagsForResource,
kafkaconnect:CreateCustomPlugin,
kafkaconnect:TagResource,
s3:GetObject,
s3:GetObjectVersion,
s3:GetObjectAttributes,
s3:GetObjectVersionAttributes

Read

kafkaconnect:DescribeCustomPlugin,
kafkaconnect:ListTagsForResource

Update

kafkaconnect:DescribeCustomPlugin,
kafkaconnect:ListTagsForResource,
kafkaconnect:TagResource,
kafkaconnect:UntagResource

Delete

kafkaconnect:DeleteCustomPlugin,
kafkaconnect:DescribeCustomPlugin

List

kafkaconnect:ListCustomPlugins