gcp_managedkafka_cluster

ancestors

Type: UNORDERED_LIST_STRING

capacity_config

Type: STRUCT
Provider name: capacityConfig
Description: Required. Capacity configuration for the Kafka cluster.

• memory_bytes
  Type: INT64
  Provider name: memoryBytes
  Description: 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).
  
• vcpu_count
  Type: INT64
  Provider name: vcpuCount
  Description: Required. The number of vCPUs to provision for the cluster. Minimum: 3.
  

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The time when the cluster was created.

gcp_config

Type: STRUCT
Provider name: gcpConfig
Description: Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform.

• access_config
  Type: STRUCT
  Provider name: accessConfig
  Description: Required. Access configuration for the Kafka cluster.
  
  • network_configs
    Type: UNORDERED_LIST_STRUCT
    Provider name: networkConfigs
    Description: 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.
    
    • subnet
      Type: STRING
      Provider name: subnet
      Description: 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.
      
• kms_key
  Type: STRING
  Provider name: kmsKey
  Description: 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}.
  

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

rebalance_config

Type: STRUCT
Provider name: rebalanceConfig
Description: Optional. Rebalance configuration for the Kafka cluster.

• mode
  Type: STRING
  Provider name: mode
  Description: Optional. The rebalance behavior for the cluster. When not specified, defaults to NO_REBALANCE.
  Possible values:
  
  • 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.
    

resource_name

Type: STRING

satisfies_pzi

Type: BOOLEAN
Provider name: satisfiesPzi
Description: Output only. Reserved for future use.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: Output only. Reserved for future use.

state

Type: STRING
Provider name: state
Description: Output only. The current state of the cluster.
Possible values:

• STATE_UNSPECIFIED - A state was not specified.
  
• CREATING - The cluster is being created.
  
• ACTIVE - The cluster is active.
  
• DELETING - The cluster is being deleted.
  

tags

Type: UNORDERED_LIST_STRING

tls_config

Type: STRUCT
Provider name: tlsConfig
Description: Optional. TLS configuration for the Kafka cluster.

• ssl_principal_mapping_rules
  Type: STRING
  Provider name: sslPrincipalMappingRules
  Description: Optional. A list of rules for mapping from SSL principal names to short names. These are applied in order by Kafka. Refer to the Apache Kafka documentation for ssl.principal.mapping.rules for the precise formatting details and syntax. Example: “RULE:^CN=(.?),OU=ServiceUsers.$/$1@example.com/,DEFAULT” This is a static Kafka broker configuration. Setting or modifying this field will trigger a rolling restart of the Kafka brokers to apply the change. An empty string means no rules are applied (Kafka default).
  
• trust_config
  Type: STRUCT
  Provider name: trustConfig
  Description: Optional. The configuration of the broker truststore. If specified, clients can use mTLS for authentication.
  
  • cas_configs
    Type: UNORDERED_LIST_STRUCT
    Provider name: casConfigs
    Description: Optional. Configuration for the Google Certificate Authority Service. Maximum 10.
    
    • ca_pool
      Type: STRING
      Provider name: caPool
      Description: Required. The name of the CA pool to pull CA certificates from. Structured like: projects/{project}/locations/{location}/caPools/{ca_pool}. The CA pool does not need to be in the same project or location as the Kafka cluster.
      

update_options

Type: STRUCT
Provider name: updateOptions
Description: Optional. UpdateOptions represents options that control how updates to the cluster are applied.

• allow_broker_downscale_on_cluster_upscale
  Type: BOOLEAN
  Provider name: allowBrokerDownscaleOnClusterUpscale
  Description: Optional. If true, allows an update operation that increases the total vCPU and/or memory allocation of the cluster to significantly decrease the per-broker vCPU and/or memory allocation. This can result in reduced performance and availability. By default, the update operation will fail if an upscale request results in a vCPU or memory allocation for the brokers that is smaller than 90% of the current broker size.
  

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The time when the cluster was last updated.