REST Resource: projects.locations.connectClusters

Resource: ConnectCluster

An Apache Kafka Connect cluster deployed in a location.

JSON representation 
{
  "name": string,
  "kafkaCluster": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "capacityConfig": {
    object (CapacityConfig)
  },
  "state": enum (State),
  "config": {
    string: string,
    ...
  },

  // Union field platform_config can be only one of the following:
  "gcpConfig": {
    object (ConnectGcpConfig)
  }
  // End of list of possible types for union field platform_config.
  "satisfiesPzi": boolean,
  "satisfiesPzs": boolean
}
Fields
name

string

Identifier. The name of the Kafka Connect cluster. Structured like: projects/{projectNumber}/locations/{location}/connectClusters/{connectClusterId}
kafkaCluster

string

Required. Immutable. The name of the Kafka cluster this Kafka Connect cluster is attached to. Structured like: projects/{project}/locations/{location}/clusters/{cluster}
createTime

string (Timestamp format)

Output only. The time when the cluster was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time when the cluster was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Labels as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
capacityConfig

object (CapacityConfig)

Required. Capacity configuration for the Kafka Connect cluster.
state

enum (State)

Output only. The current state of the Kafka Connect cluster.
config

map (key: string, value: string)

Optional. Configurations for the worker that are overridden from the defaults. The key of the map is a Kafka Connect worker property name, for example: exactly.once.source.support.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Union field platform_config. Platform specific configuration properties for a Kafka Connect cluster. platform_config can be only one of the following:
gcpConfig

object (ConnectGcpConfig)

Required. Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform.
satisfiesPzi

boolean

Output only. Reserved for future use.
satisfiesPzs

boolean

Output only. Reserved for future use.

ConnectGcpConfig

Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform.

JSON representation 
{
  "accessConfig": {
    object (ConnectAccessConfig)
  },
  "secretPaths": [
    string
  ]
}
Fields
accessConfig

object (ConnectAccessConfig)

Required. Access configuration for the Kafka Connect cluster.
secretPaths[]

string

Optional. Secrets to load into workers. Exact SecretVersions from Secret Manager must be provided -- aliases are not supported. Up to 32 secrets may be loaded into one cluster. Format: projects//secrets//versions/

ConnectAccessConfig

The configuration of access to the Kafka Connect cluster.

JSON representation 
{
  "networkConfigs": [
    {
      object (ConnectNetworkConfig)
    }
  ]
}
Fields
networkConfigs[]

object (ConnectNetworkConfig)

Required. Virtual Private Cloud (VPC) networks that must be granted direct access to the Kafka Connect cluster. Minimum of 1 network is required. Maximum 10 networks can be specified.

ConnectNetworkConfig

The configuration of a Virtual Private Cloud (VPC) network that can access the Kafka Connect cluster.

JSON representation 
{
  "primarySubnet": string,
  "additionalSubnets": [
    string
  ],
  "dnsDomainNames": [
    string
  ]
}
Fields
primarySubnet

string

Required. VPC subnet to make available to the Kafka Connect cluster. Structured like: projects/{project}/regions/{region}/subnetworks/{subnet_id}

It is used to create a Private Service Connect (PSC) interface for the Kafka Connect workers. It must be located in the same region as the Kafka Connect cluster.

The CIDR range of the subnet must be within the IPv4 address ranges for private networks, as specified in RFC 1918. The primary subnet CIDR range must have a minimum size of /22 (1024 addresses).
additionalSubnets[]
(deprecated)

string

Optional. Deprecated: Managed Kafka Connect clusters can now reach any endpoint accessible from the primary subnet without the need to define additional subnets. Please see https://cloud.google.com/managed-service-for-apache-kafka/docs/connect-cluster/create-connect-cluster#worker-subnet for more information.
dnsDomainNames[]

string

Optional. Additional DNS domain names from the subnet's network to be made visible to the Connect Cluster. When using MirrorMaker2, it's necessary to add the bootstrap address's dns domain name of the target cluster to make it visible to the connector. For example: my-kafka-cluster.us-central1.managedkafka.my-project.cloud.goog

State

The state of the Kafka Connect cluster.

Enums
STATE_UNSPECIFIED A state was not specified.
CREATING The cluster is being created.
ACTIVE The cluster is active.
DELETING The cluster is being deleted.
DETACHED The cluster is detached.

Methods

create

 Creates a new Kafka Connect cluster in a given project and location.

delete

 Deletes a single Connect cluster.

get

 Returns the properties of a single Kafka Connect cluster.

list

 Lists the Kafka Connect clusters in a given project and location.

patch

 Updates the properties of a single Kafka Connect cluster.