gcp_bigtableadmin_cluster

ancestors

Type: UNORDERED_LIST_STRING

cluster_config

Type: STRUCT
Provider name: clusterConfig
Description: Configuration for this cluster.

• cluster_autoscaling_config
  Type: STRUCT
  Provider name: clusterAutoscalingConfig
  Description: Autoscaling configuration for this cluster.
  
  • autoscaling_limits
    Type: STRUCT
    Provider name: autoscalingLimits
    Description: Required. Autoscaling limits for this cluster.
    
    • max_serve_nodes
      Type: INT32
      Provider name: maxServeNodes
      Description: Required. Maximum number of nodes to scale up to.
      
    • min_serve_nodes
      Type: INT32
      Provider name: minServeNodes
      Description: Required. Minimum number of nodes to scale down to.
      
  • autoscaling_targets
    Type: STRUCT
    Provider name: autoscalingTargets
    Description: Required. Autoscaling targets for this cluster.
    
    • cpu_utilization_percent
      Type: INT32
      Provider name: cpuUtilizationPercent
      Description: The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80, otherwise it will return INVALID_ARGUMENT error.
      
    • storage_utilization_gib_per_node
      Type: INT32
      Provider name: storageUtilizationGibPerNode
      Description: The storage utilization that the Autoscaler should be trying to achieve. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16TiB) for an HDD cluster, otherwise it will return INVALID_ARGUMENT error. If this value is set to 0, it will be treated as if it were set to the default value: 2560 for SSD, 8192 for HDD.
      

default_storage_type

Type: STRING
Provider name: defaultStorageType
Description: Immutable. The type of storage used by this cluster to serve its parent instance’s tables, unless explicitly overridden.
Possible values:

• STORAGE_TYPE_UNSPECIFIED - The user did not specify a storage type.
  
• SSD - Flash (SSD) storage should be used.
  
• HDD - Magnetic drive (HDD) storage should be used.
  

encryption_config

Type: STRUCT
Provider name: encryptionConfig
Description: Immutable. The encryption configuration for CMEK-protected clusters.

• kms_key_name
  Type: STRING
  Provider name: kmsKeyName
  Description: Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. Values are of the form projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}
  

labels

Type: UNORDERED_LIST_STRING

location

Type: STRING
Provider name: location
Description: Immutable. The location where this cluster’s nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form projects/{project}/locations/{zone}.

name

Type: STRING
Provider name: name
Description: The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z*.

node_scaling_factor

Type: STRING
Provider name: nodeScalingFactor
Description: Immutable. The node scaling factor of this cluster.
Possible values:

• NODE_SCALING_FACTOR_UNSPECIFIED - No node scaling specified. Defaults to NODE_SCALING_FACTOR_1X.
  
• NODE_SCALING_FACTOR_1X - The cluster is running with a scaling factor of 1.
  
• NODE_SCALING_FACTOR_2X - The cluster is running with a scaling factor of 2. All node count values must be in increments of 2 with this scaling factor enabled, otherwise an INVALID_ARGUMENT error will be returned.
  

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

serve_nodes

Type: INT32
Provider name: serveNodes
Description: The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

state

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

• STATE_NOT_KNOWN - The state of the cluster could not be determined.
  
• READY - The cluster has been successfully created and is ready to serve requests.
  
• CREATING - The cluster is currently being created, and may be destroyed if the creation process encounters an error. A cluster may not be able to serve requests while being created.
  
• RESIZING - The cluster is currently being resized, and may revert to its previous node count if the process encounters an error. A cluster is still capable of serving requests while being resized, but may exhibit performance as if its number of allocated nodes is between the starting and requested states.
  
• DISABLED - The cluster has no backing nodes. The data (tables) still exist, but no operations can be performed on the cluster.
  

tags

Type: UNORDERED_LIST_STRING