custom_plugins

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

Overview

Name	custom_plugins
Type	Resource
Id	aws.kafkaconnect.custom_plugins

Fields

The following fields are returned by SELECT queries:

describe_custom_plugin

Name	Datatype	Description
name	string	The name of the custom plugin.
creation_time	string (date-time)	The time that the custom plugin was created.
custom_plugin_arn	string	The Amazon Resource Name (ARN) of the custom plugin.
custom_plugin_state	string	The state of the custom plugin. (CREATING, CREATE_FAILED, ACTIVE, UPDATING, UPDATE_FAILED, DELETING)
description	string	The description of the custom plugin.
latest_revision	object	The latest successfully created revision of the custom plugin. If there are no successfully created revisions, this field will be absent.
state_description	object	Details about the state of a custom plugin.

list_custom_plugins

Name	Datatype	Description
name	string	The name of the custom plugin.
creation_time	string (date-time)	The time that the custom plugin was created.
custom_plugin_arn	string	The Amazon Resource Name (ARN) of the custom plugin.
custom_plugin_state	string	The state of the custom plugin. (CREATING, CREATE_FAILED, ACTIVE, UPDATING, UPDATE_FAILED, DELETING)
description	string	A description of the custom plugin.
latest_revision	object	The latest revision of the custom plugin.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_custom_plugin	select	custom_plugin_arn, region		A summary description of the custom plugin.
list_custom_plugins	select	region	maxResults, nextToken, namePrefix	Returns a list of all of the custom plugins in this account and Region.
create_custom_plugin	insert	region, contentType, location, name		Creates a custom plugin using the specified properties.
delete_custom_plugin	delete	custom_plugin_arn, region		Deletes a custom plugin.

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
custom_plugin_arn	string	The Amazon Resource Name (ARN) of the custom plugin that you want to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of custom plugins to list in one response.
namePrefix	string	Lists custom plugin names that start with the specified text string.
nextToken	string	If the response of a ListCustomPlugins 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_custom_plugin

A summary description of the custom plugin.

SELECT
name,
creation_time,
custom_plugin_arn,
custom_plugin_state,
description,
latest_revision,
state_description
FROM aws.kafkaconnect.custom_plugins
WHERE custom_plugin_arn = '{{ custom_plugin_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_custom_plugins

Returns a list of all of the custom plugins in this account and Region.

SELECT
name,
creation_time,
custom_plugin_arn,
custom_plugin_state,
description,
latest_revision
FROM aws.kafkaconnect.custom_plugins
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND namePrefix = '{{ namePrefix }}'
;

INSERT examples

create_custom_plugin

Creates a custom plugin using the specified properties.

INSERT INTO aws.kafkaconnect.custom_plugins (
contentType,
description,
location,
name,
tags,
region
)
SELECT 
'{{ contentType }}' /* required */,
'{{ description }}',
'{{ location }}' /* required */,
'{{ name }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
name,
custom_plugin_arn,
custom_plugin_state,
revision
;

Manifest

# Description fields are for documentation purposes
- name: custom_plugins
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the custom_plugins resource.
  - name: contentType
    value: "{{ contentType }}"
    valid_values: ['JAR', 'ZIP']
  - name: description
    value: "{{ description }}"
  - name: location
    description: |
      Information about the location of a custom plugin.
    value:
      s3Location:
        bucketArn: "{{ bucketArn }}"
        fileKey: "{{ fileKey }}"
        objectVersion: "{{ objectVersion }}"
  - name: name
    value: "{{ name }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_custom_plugin

Deletes a custom plugin.

DELETE FROM aws.kafkaconnect.custom_plugins
WHERE custom_plugin_arn = '{{ custom_plugin_arn }}' --required
AND region = '{{ region }}' --required
;