custom_connect_plugins

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

Overview

Name	custom_connect_plugins
Type	Resource
Id	confluent.ccpm.custom_connect_plugins

Fields

The following fields are returned by SELECT queries:

get_ccpm_v1_custom_connect_plugin

Custom Connect Plugin.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (ccpm/v1)
kind	string	Kind defines the object this REST resource represents. (CustomConnectPlugin)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Custom Connect Plugin

list_ccpm_v1_custom_connect_plugins

Custom Connect Plugin.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (ccpm/v1)
kind	string	Kind defines the object this REST resource represents. (CustomConnectPlugin)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Custom Connect Plugin

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ccpm_v1_custom_connect_plugin	select	environment, id		Make a request to read a custom connect plugin.
list_ccpm_v1_custom_connect_plugins	select	environment	spec.cloud, page_size, page_token	Retrieve a sorted, filtered, paginated list of all custom connect plugins. If no cloud filter is specified, returns custom connect plugins from all clouds.
create_ccpm_v1_custom_connect_plugin	insert	spec		Make a request to create a custom connect plugin.
update_ccpm_v1_custom_connect_plugin	update	id, spec		Make a request to update a custom connect plugin.
delete_ccpm_v1_custom_connect_plugin	delete	environment, id		Make a request to delete a custom connect 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
environment	string	Scope the operation to the given environment. (example: env-00000)
id	string	The unique identifier for the custom connect plugin.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
spec.cloud	string	Filter the results by exact match for spec.cloud. (example: AWS)

SELECT examples

get_ccpm_v1_custom_connect_plugin

Make a request to read a custom connect plugin.

SELECT
id,
api_version,
kind,
metadata,
spec
FROM confluent.ccpm.custom_connect_plugins
WHERE environment = '{{ environment }}' -- required
AND id = '{{ id }}' -- required
;

list_ccpm_v1_custom_connect_plugins

Retrieve a sorted, filtered, paginated list of all custom connect plugins.

If no cloud filter is specified, returns custom connect plugins from all clouds.

SELECT
id,
api_version,
kind,
metadata,
spec
FROM confluent.ccpm.custom_connect_plugins
WHERE environment = '{{ environment }}' -- required
AND spec.cloud = '{{ spec.cloud }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_ccpm_v1_custom_connect_plugin

Make a request to create a custom connect plugin.

INSERT INTO confluent.ccpm.custom_connect_plugins (
spec
)
SELECT 
'{{ spec }}' /* required */
RETURNING
id,
api_version,
kind,
metadata,
spec
;

Manifest

# Description fields are for documentation purposes
- name: custom_connect_plugins
props:
  - name: spec
    description: |
      The desired state of the Custom Connect Plugin
    value:
      cloud: "{{ cloud }}"
      display_name: "{{ display_name }}"
      description: "{{ description }}"
      runtime_language: "{{ runtime_language }}"
      environment:
        id: "{{ id }}"
        environment: "{{ environment }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"

UPDATE examples

update_ccpm_v1_custom_connect_plugin

Make a request to update a custom connect plugin.

UPDATE confluent.ccpm.custom_connect_plugins
SET 
spec = '{{ spec }}'
WHERE 
id = '{{ id }}' --required
AND spec = '{{ spec }}' --required
RETURNING
id,
api_version,
kind,
metadata,
spec;

DELETE examples

delete_ccpm_v1_custom_connect_plugin

Make a request to delete a custom connect plugin.

DELETE FROM confluent.ccpm.custom_connect_plugins
WHERE environment = '{{ environment }}' --required
AND id = '{{ id }}' --required
;