Sign in
Integrations (pim/v1)

Create an Integration

General Availability

Make a request to create an integration.

post/pim/v1/integrations

Request body

api_version'pim/v1'

APIVersion defines the schema version of this representation of a resource.

kind'Integration'

Kind defines the object this REST resource represents.

idstring

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").

display_namestring

Display name of Provider Integration.

providerstring

Cloud provider to which access is provided through provider integration.

usagesstring[]

List of resource crns where this integration is being used.

Example request

{
  "id": "dlz-f3a90de",
  "display_name": "s3_provider_integration",
  "provider": "AWS",
  "config": {
    "iam_role_arn": "arn:aws:iam::000000000000:role/my-test-aws-role",
    "customer_iam_role_arn": "arn:aws:iam::000000000000:role/my-test-aws-role",
    "kind": "AwsIntegrationConfig"
  },
  "usages": [
    "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector"
  ],
  "environment": {
    "id": "env-00000"
  }
}

Response

An Integration was created.

api_version'pim/v1'

APIVersion defines the schema version of this representation of a resource.

kind'Integration'

Kind defines the object this REST resource represents.

idstring

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").

display_namestring

Display name of Provider Integration.

providerstring

Cloud provider to which access is provided through provider integration.

usagesstring[]

List of resource crns where this integration is being used.

Example response

{
  "id": "dlz-f3a90de",
  "display_name": "s3_provider_integration",
  "provider": "AWS",
  "config": {
    "iam_role_arn": "arn:aws:iam::000000000000:role/my-test-aws-role",
    "customer_iam_role_arn": "arn:aws:iam::000000000000:role/my-test-aws-role",
    "kind": "AwsIntegrationConfig"
  },
  "usages": [
    "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector"
  ],
  "environment": {
    "id": "env-00000",
    "related": "https://api.confluent.cloud/v2/environments/env-00000",
    "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.