integrations_v1

Creates, updates, deletes, gets or lists an integrations_v1 resource.

Overview

Name	integrations_v1
Type	Resource
Id	confluent.provider_integrations.integrations_v1

Fields

The following fields are returned by SELECT queries:

get_pim_v1_integration

Integration.

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)
display_name	string	Display name of Provider Integration. (example: s3_provider_integration)
api_version	string	APIVersion defines the schema version of this representation of a resource. (pim/v1)
config	object	Cloud provider specific configs for provider integration
environment	object	The environment to which this belongs. (x-immutable: true')
kind	string	Kind defines the object this REST resource represents. (Integration)
provider	string	Cloud provider to which access is provided through provider integration. (example: AWS, default: AWS)
usages	array	List of resource crns where this integration is being used.

list_pim_v1_integrations

Integration.

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)
display_name	string	Display name of Provider Integration. (example: s3_provider_integration)
api_version	string	APIVersion defines the schema version of this representation of a resource. (pim/v1)
config	object	Cloud provider specific configs for provider integration
environment	object	The environment to which this belongs. (x-immutable: true')
kind	string	Kind defines the object this REST resource represents. (Integration)
provider	string	Cloud provider to which access is provided through provider integration. (example: AWS, default: AWS)
usages	array	List of resource crns where this integration is being used.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pim_v1_integration	select	environment, id		Make a request to read an integration.
list_pim_v1_integrations	select	environment	provider, page_size, page_token	Retrieve a sorted, filtered, paginated list of all integrations. If no provider filter is specified, returns provider integrations from all clouds.
create_pim_v1_integration	insert	config, environment		Make a request to create an integration.
delete_pim_v1_integration	delete	environment, id		Make a request to delete an integration. This request fails if existing workloads are using this CSP integration.

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 integration.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
provider	string	Filter the results by exact match for provider. (example: AWS)

SELECT examples

get_pim_v1_integration

Make a request to read an integration.

SELECT
id,
display_name,
api_version,
config,
environment,
kind,
provider,
usages
FROM confluent.provider_integrations.integrations_v1
WHERE environment = '{{ environment }}' -- required
AND id = '{{ id }}' -- required
;

list_pim_v1_integrations

Retrieve a sorted, filtered, paginated list of all integrations.

If no provider filter is specified, returns provider integrations from all clouds.

SELECT
id,
display_name,
api_version,
config,
environment,
kind,
provider,
usages
FROM confluent.provider_integrations.integrations_v1
WHERE environment = '{{ environment }}' -- required
AND provider = '{{ provider }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_pim_v1_integration

Make a request to create an integration.

INSERT INTO confluent.provider_integrations.integrations_v1 (
display_name,
provider,
config,
environment
)
SELECT 
'{{ display_name }}',
'{{ provider }}',
'{{ config }}' /* required */,
'{{ environment }}' /* required */
RETURNING
id,
display_name,
api_version,
config,
environment,
kind,
provider,
usages
;

Manifest

# Description fields are for documentation purposes
- name: integrations_v1
props:
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Display name of Provider Integration.
  - name: provider
    value: "{{ provider }}"
    description: |
      Cloud provider to which access is provided through provider integration.
    default: AWS
  - name: config
    description: |
      Cloud provider specific configs for provider integration
    value:
      iam_role_arn: "{{ iam_role_arn }}"
      external_id: "{{ external_id }}"
      customer_iam_role_arn: "{{ customer_iam_role_arn }}"
      kind: "{{ kind }}"
  - name: environment
    description: |
      The environment to which this belongs.
    value:
      id: "{{ id }}"
      related: "{{ related }}"
      resource_name: "{{ resource_name }}"

DELETE examples

delete_pim_v1_integration

Make a request to delete an integration.

This request fails if existing workloads are using this CSP integration.

DELETE FROM confluent.provider_integrations.integrations_v1
WHERE environment = '{{ environment }}' --required
AND id = '{{ id }}' --required
;