- Resource: Cluster
- GcpConfig
- AccessConfig
- NetworkConfig
- CapacityConfig
- RebalanceConfig
- Mode
- State
- Methods
Resource: Cluster
An Apache Kafka cluster deployed in a location.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "capacityConfig": { object ( |
Fields | |
---|---|
name |
Identifier. The name of the cluster. Structured like: projects/{projectNumber}/locations/{location}/clusters/{clusterId} |
create |
Output only. The time when the cluster was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
update |
Output only. The time when the cluster was last updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
labels |
Optional. Labels as key value pairs. An object containing a list of |
capacity |
Required. Capacity configuration for the Kafka cluster. |
rebalance |
Optional. Rebalance configuration for the Kafka cluster. |
state |
Output only. The current state of the cluster. |
Union field platform_config . Platform specific configuration properties for a Kafka cluster. platform_config can be only one of the following: |
|
gcp |
Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform. |
satisfies |
Output only. Reserved for future use. |
satisfies |
Output only. Reserved for future use. |
GcpConfig
Configuration properties for a Kafka cluster deployed to Google Cloud Platform.
JSON representation |
---|
{
"accessConfig": {
object ( |
Fields | |
---|---|
access |
Required. Access configuration for the Kafka cluster. |
kms |
Optional. Immutable. The Cloud KMS Key name to use for encryption. The key must be located in the same region as the cluster and cannot be changed. Structured like: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. |
AccessConfig
The configuration of access to the Kafka cluster.
JSON representation |
---|
{
"networkConfigs": [
{
object ( |
Fields | |
---|---|
network |
Required. Virtual Private Cloud (VPC) networks that must be granted direct access to the Kafka cluster. Minimum of 1 network is required. Maximum 10 networks can be specified. |
NetworkConfig
The configuration of a Virtual Private Cloud (VPC) network that can access the Kafka cluster.
JSON representation |
---|
{ "subnet": string } |
Fields | |
---|---|
subnet |
Required. Name of the VPC subnet in which to create Private Service Connect (PSC) endpoints for the Kafka brokers and bootstrap address. Structured like: projects/{project}/regions/{region}/subnetworks/{subnet_id} The subnet must be located in the same region as the Kafka cluster. The project may differ. Multiple subnets from the same parent network must not be specified. |
CapacityConfig
A capacity configuration of a Kafka cluster.
JSON representation |
---|
{ "vcpuCount": string, "memoryBytes": string } |
Fields | |
---|---|
vcpu |
Required. The number of vCPUs to provision for the cluster. Minimum: 3. |
memory |
Required. The memory to provision for the cluster in bytes. The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8. Minimum: 3221225472 (3 GiB). |
RebalanceConfig
Defines rebalancing behavior of a Kafka cluster.
JSON representation |
---|
{
"mode": enum ( |
Fields | |
---|---|
mode |
Optional. The rebalance behavior for the cluster. When not specified, defaults to |
Mode
The partition rebalance mode for the cluster.
Enums | |
---|---|
MODE_UNSPECIFIED |
A mode was not specified. Do not use. |
NO_REBALANCE |
Do not rebalance automatically. |
AUTO_REBALANCE_ON_SCALE_UP |
Automatically rebalance topic partitions among brokers when the cluster is scaled up. |
State
The state of the 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. |
Methods |
|
---|---|
|
Creates a new cluster in a given project and location. |
|
Deletes a single cluster. |
|
Returns the properties of a single cluster. |
|
Lists the clusters in a given project and location. |
|
Updates the properties of a single cluster. |