integrations_v2

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

Overview

Name	integrations_v2
Type	Resource
Id	confluent.provider_integrations.integrations_v2

Fields

The following fields are returned by SELECT queries:

get_pim_v2_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: bigquery_provider_integration)
api_version	string	APIVersion defines the schema version of this representation of a resource. (pim/v2)
config	object	Cloud provider specific configuration for the provider integration. Required only when updating integrations with DRAFT status. Not required during creation.
environment	object	The environment to which this belongs.
kind	string	Kind defines the object this REST resource represents. (Integration)
provider	string	Cloud provider to which access is provided through provider integration. (example: GCP, default: GCP)
status	string	Status of the provider integration. - DRAFT: Integration exists but is not associated with customer configuration - CREATED: Integration has been associated with customer configuration - ACTIVE: Integration is in use by Confluent resources (example: CREATED)
usages	array	List of resource crns where this integration is being used.

list_pim_v2_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: bigquery_provider_integration)
api_version	string	APIVersion defines the schema version of this representation of a resource. (pim/v2)
config	object	Cloud provider specific configuration for the provider integration. Required only when updating integrations with DRAFT status. Not required during creation.
environment	object	The environment to which this belongs.
kind	string	Kind defines the object this REST resource represents. (Integration)
provider	string	Cloud provider to which access is provided through provider integration. (example: GCP, default: GCP)
status	string	Status of the provider integration. - DRAFT: Integration exists but is not associated with customer configuration - CREATED: Integration has been associated with customer configuration - ACTIVE: Integration is in use by Confluent resources (example: CREATED)
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_v2_integration	select	environment, id		Make a request to read an integration.
list_pim_v2_integrations	select	environment	display_name, provider, status, 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_v2_integration	insert	environment		Make a request to create an integration.
delete_pim_v2_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.
display_name	string	Filter the results by a partial search of display_name. (example: bigquery_provider_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: GCP)
status	string	Filter the results by exact match for status. (example: CREATED)

SELECT examples

get_pim_v2_integration

Make a request to read an integration.

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

list_pim_v2_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,
status,
usages
FROM confluent.provider_integrations.integrations_v2
WHERE environment = '{{ environment }}' -- required
AND display_name = '{{ display_name }}'
AND provider = '{{ provider }}'
AND status = '{{ status }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_pim_v2_integration

Make a request to create an integration.

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

Manifest

# Description fields are for documentation purposes
- name: integrations_v2
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: GCP
  - name: config
    description: |
      Cloud provider specific configuration for the provider integration.
      Required only when updating integrations with `DRAFT` status. Not required during creation.
    value:
      google_service_account: "{{ google_service_account }}"
      customer_google_service_account: "{{ customer_google_service_account }}"
      kind: "{{ kind }}"
      confluent_multi_tenant_app_id: "{{ confluent_multi_tenant_app_id }}"
      customer_azure_tenant_id: "{{ customer_azure_tenant_id }}"
      iam_role_arn: "{{ iam_role_arn }}"
      external_id: "{{ external_id }}"
      customer_iam_role_arn: "{{ customer_iam_role_arn }}"
  - name: environment
    description: |
      The environment to which this belongs.
    value:
      id: "{{ id }}"
      environment: "{{ environment }}"
      related: "{{ related }}"
      resource_name: "{{ resource_name }}"
      api_version: "{{ api_version }}"
      kind: "{{ kind }}"

DELETE examples

delete_pim_v2_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_v2
WHERE environment = '{{ environment }}' --required
AND id = '{{ id }}' --required
;