Sign in
Connect Clusters (usm/v1)

Create a Connect Cluster

Preview

Make a request to create a connect cluster.

post/usm/v1/connect-clusters

Request body

api_version'usm/v1'

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

kind'ConnectCluster'

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

confluent_platform_connect_cluster_idstring required

The unique identifier of the Connect cluster within the Confluent Platform environment.

kafka_cluster_idstring required

The unique identifier of the metadata Kafka cluster for the Connect Cluster.

usm_kafka_cluster_idstring

The unique identifier of the metadata Kafka cluster for the Connect Cluster.

cloudstring

The cloud service provider where the metadata for the Connect Cluster should be stored. This field is optional. If provided, 'region' must also be provided. If neither 'cloud' nor 'region' are provided, the cloud provider of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback.

regionstring

The home region of the Confluent Platform Connect cluster where the metadata should be stored. This field is optional. If provided, 'cloud' must also be provided. If neither 'cloud' nor 'region' are provided, the home region of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback.

Example request

{
  "id": "dlz-f3a90de",
  "confluent_platform_connect_cluster_id": "connect-group-xyz123",
  "kafka_cluster_id": "4k0R9d1GTS5tI9f4Y2xZ0Q",
  "usm_kafka_cluster_id": "usmkc-00000",
  "cloud": "AWS",
  "region": "us-east-1",
  "environment": {
    "id": "env-00000"
  }
}

Response

A Connect Cluster was created.

api_version'usm/v1'

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

kind'ConnectCluster'

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

confluent_platform_connect_cluster_idstring required

The unique identifier of the Connect cluster within the Confluent Platform environment.

kafka_cluster_idstring required

The unique identifier of the metadata Kafka cluster for the Connect Cluster.

usm_kafka_cluster_idstring

The unique identifier of the metadata Kafka cluster for the Connect Cluster.

cloudstring

The cloud service provider where the metadata for the Connect Cluster should be stored. This field is optional. If provided, 'region' must also be provided. If neither 'cloud' nor 'region' are provided, the cloud provider of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback.

regionstring

The home region of the Confluent Platform Connect cluster where the metadata should be stored. This field is optional. If provided, 'cloud' must also be provided. If neither 'cloud' nor 'region' are provided, the home region of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback.

Example response

{
  "id": "dlz-f3a90de",
  "confluent_platform_connect_cluster_id": "connect-group-xyz123",
  "kafka_cluster_id": "4k0R9d1GTS5tI9f4Y2xZ0Q",
  "usm_kafka_cluster_id": "usmkc-00000",
  "cloud": "AWS",
  "region": "us-east-1",
  "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.