google-native logo
Google Cloud Native v0.28.0, Feb 2 23

google-native.bigtableadmin/v2.Cluster

Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Create Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cluster_config: Optional[ClusterConfigArgs] = None,
            cluster_id: Optional[str] = None,
            default_storage_type: Optional[ClusterDefaultStorageType] = None,
            encryption_config: Optional[EncryptionConfigArgs] = None,
            instance_id: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            serve_nodes: Optional[int] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: google-native:bigtableadmin/v2:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Cluster resource accepts the following input properties:

ClusterId string

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

InstanceId string
ClusterConfig Pulumi.GoogleNative.BigtableAdmin.V2.Inputs.ClusterConfigArgs

Configuration for this cluster.

DefaultStorageType Pulumi.GoogleNative.BigtableAdmin.V2.ClusterDefaultStorageType

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

EncryptionConfig Pulumi.GoogleNative.BigtableAdmin.V2.Inputs.EncryptionConfigArgs

Immutable. The encryption configuration for CMEK-protected clusters.

Location string

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 string

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

Project string
ServeNodes int

The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

ClusterId string

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

InstanceId string
ClusterConfig ClusterConfigArgs

Configuration for this cluster.

DefaultStorageType ClusterDefaultStorageType

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

EncryptionConfig EncryptionConfigArgs

Immutable. The encryption configuration for CMEK-protected clusters.

Location string

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 string

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

Project string
ServeNodes int

The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

clusterId String

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

instanceId String
clusterConfig ClusterConfigArgs

Configuration for this cluster.

defaultStorageType ClusterDefaultStorageType

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

encryptionConfig EncryptionConfigArgs

Immutable. The encryption configuration for CMEK-protected clusters.

location String

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 String

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

project String
serveNodes Integer

The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

clusterId string

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

instanceId string
clusterConfig ClusterConfigArgs

Configuration for this cluster.

defaultStorageType ClusterDefaultStorageType

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

encryptionConfig EncryptionConfigArgs

Immutable. The encryption configuration for CMEK-protected clusters.

location string

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 string

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

project string
serveNodes number

The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

cluster_id str

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

instance_id str
cluster_config ClusterConfigArgs

Configuration for this cluster.

default_storage_type ClusterDefaultStorageType

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

encryption_config EncryptionConfigArgs

Immutable. The encryption configuration for CMEK-protected clusters.

location str

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 str

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

project str
serve_nodes int

The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

clusterId String

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

instanceId String
clusterConfig Property Map

Configuration for this cluster.

defaultStorageType "STORAGE_TYPE_UNSPECIFIED" | "SSD" | "HDD"

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

encryptionConfig Property Map

Immutable. The encryption configuration for CMEK-protected clusters.

location String

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 String

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

project String
serveNodes Number

The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

Outputs

All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

State string

The current state of the cluster.

Id string

The provider-assigned unique ID for this managed resource.

State string

The current state of the cluster.

id String

The provider-assigned unique ID for this managed resource.

state String

The current state of the cluster.

id string

The provider-assigned unique ID for this managed resource.

state string

The current state of the cluster.

id str

The provider-assigned unique ID for this managed resource.

state str

The current state of the cluster.

id String

The provider-assigned unique ID for this managed resource.

state String

The current state of the cluster.

Supporting Types

AutoscalingLimits

MaxServeNodes int

Maximum number of nodes to scale up to.

MinServeNodes int

Minimum number of nodes to scale down to.

MaxServeNodes int

Maximum number of nodes to scale up to.

MinServeNodes int

Minimum number of nodes to scale down to.

maxServeNodes Integer

Maximum number of nodes to scale up to.

minServeNodes Integer

Minimum number of nodes to scale down to.

maxServeNodes number

Maximum number of nodes to scale up to.

minServeNodes number

Minimum number of nodes to scale down to.

max_serve_nodes int

Maximum number of nodes to scale up to.

min_serve_nodes int

Minimum number of nodes to scale down to.

maxServeNodes Number

Maximum number of nodes to scale up to.

minServeNodes Number

Minimum number of nodes to scale down to.

AutoscalingLimitsResponse

MaxServeNodes int

Maximum number of nodes to scale up to.

MinServeNodes int

Minimum number of nodes to scale down to.

MaxServeNodes int

Maximum number of nodes to scale up to.

MinServeNodes int

Minimum number of nodes to scale down to.

maxServeNodes Integer

Maximum number of nodes to scale up to.

minServeNodes Integer

Minimum number of nodes to scale down to.

maxServeNodes number

Maximum number of nodes to scale up to.

minServeNodes number

Minimum number of nodes to scale down to.

max_serve_nodes int

Maximum number of nodes to scale up to.

min_serve_nodes int

Minimum number of nodes to scale down to.

maxServeNodes Number

Maximum number of nodes to scale up to.

minServeNodes Number

Minimum number of nodes to scale down to.

AutoscalingTargets

CpuUtilizationPercent int

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.

StorageUtilizationGibPerNode int

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.

CpuUtilizationPercent int

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.

StorageUtilizationGibPerNode int

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.

cpuUtilizationPercent Integer

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.

storageUtilizationGibPerNode Integer

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.

cpuUtilizationPercent number

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.

storageUtilizationGibPerNode number

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.

cpu_utilization_percent int

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 int

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.

cpuUtilizationPercent Number

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.

storageUtilizationGibPerNode Number

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.

AutoscalingTargetsResponse

CpuUtilizationPercent int

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.

StorageUtilizationGibPerNode int

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.

CpuUtilizationPercent int

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.

StorageUtilizationGibPerNode int

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.

cpuUtilizationPercent Integer

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.

storageUtilizationGibPerNode Integer

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.

cpuUtilizationPercent number

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.

storageUtilizationGibPerNode number

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.

cpu_utilization_percent int

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 int

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.

cpuUtilizationPercent Number

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.

storageUtilizationGibPerNode Number

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.

ClusterAutoscalingConfig

AutoscalingLimits AutoscalingLimits

Autoscaling limits for this cluster.

AutoscalingTargets AutoscalingTargets

Autoscaling targets for this cluster.

autoscalingLimits AutoscalingLimits

Autoscaling limits for this cluster.

autoscalingTargets AutoscalingTargets

Autoscaling targets for this cluster.

autoscalingLimits AutoscalingLimits

Autoscaling limits for this cluster.

autoscalingTargets AutoscalingTargets

Autoscaling targets for this cluster.

autoscaling_limits AutoscalingLimits

Autoscaling limits for this cluster.

autoscaling_targets AutoscalingTargets

Autoscaling targets for this cluster.

autoscalingLimits Property Map

Autoscaling limits for this cluster.

autoscalingTargets Property Map

Autoscaling targets for this cluster.

ClusterAutoscalingConfigResponse

AutoscalingLimits AutoscalingLimitsResponse

Autoscaling limits for this cluster.

AutoscalingTargets AutoscalingTargetsResponse

Autoscaling targets for this cluster.

autoscalingLimits AutoscalingLimitsResponse

Autoscaling limits for this cluster.

autoscalingTargets AutoscalingTargetsResponse

Autoscaling targets for this cluster.

autoscalingLimits AutoscalingLimitsResponse

Autoscaling limits for this cluster.

autoscalingTargets AutoscalingTargetsResponse

Autoscaling targets for this cluster.

autoscaling_limits AutoscalingLimitsResponse

Autoscaling limits for this cluster.

autoscaling_targets AutoscalingTargetsResponse

Autoscaling targets for this cluster.

autoscalingLimits Property Map

Autoscaling limits for this cluster.

autoscalingTargets Property Map

Autoscaling targets for this cluster.

ClusterConfig

ClusterAutoscalingConfig ClusterAutoscalingConfig

Autoscaling configuration for this cluster.

clusterAutoscalingConfig ClusterAutoscalingConfig

Autoscaling configuration for this cluster.

clusterAutoscalingConfig ClusterAutoscalingConfig

Autoscaling configuration for this cluster.

cluster_autoscaling_config ClusterAutoscalingConfig

Autoscaling configuration for this cluster.

clusterAutoscalingConfig Property Map

Autoscaling configuration for this cluster.

ClusterConfigResponse

ClusterAutoscalingConfig ClusterAutoscalingConfigResponse

Autoscaling configuration for this cluster.

clusterAutoscalingConfig ClusterAutoscalingConfigResponse

Autoscaling configuration for this cluster.

clusterAutoscalingConfig ClusterAutoscalingConfigResponse

Autoscaling configuration for this cluster.

cluster_autoscaling_config ClusterAutoscalingConfigResponse

Autoscaling configuration for this cluster.

clusterAutoscalingConfig Property Map

Autoscaling configuration for this cluster.

ClusterDefaultStorageType

StorageTypeUnspecified
STORAGE_TYPE_UNSPECIFIED

The user did not specify a storage type.

Ssd
SSD

Flash (SSD) storage should be used.

Hdd
HDD

Magnetic drive (HDD) storage should be used.

ClusterDefaultStorageTypeStorageTypeUnspecified
STORAGE_TYPE_UNSPECIFIED

The user did not specify a storage type.

ClusterDefaultStorageTypeSsd
SSD

Flash (SSD) storage should be used.

ClusterDefaultStorageTypeHdd
HDD

Magnetic drive (HDD) storage should be used.

StorageTypeUnspecified
STORAGE_TYPE_UNSPECIFIED

The user did not specify a storage type.

Ssd
SSD

Flash (SSD) storage should be used.

Hdd
HDD

Magnetic drive (HDD) storage should be used.

StorageTypeUnspecified
STORAGE_TYPE_UNSPECIFIED

The user did not specify a storage type.

Ssd
SSD

Flash (SSD) storage should be used.

Hdd
HDD

Magnetic drive (HDD) storage should be used.

STORAGE_TYPE_UNSPECIFIED
STORAGE_TYPE_UNSPECIFIED

The user did not specify a storage type.

SSD
SSD

Flash (SSD) storage should be used.

HDD
HDD

Magnetic drive (HDD) storage should be used.

"STORAGE_TYPE_UNSPECIFIED"
STORAGE_TYPE_UNSPECIFIED

The user did not specify a storage type.

"SSD"
SSD

Flash (SSD) storage should be used.

"HDD"
HDD

Magnetic drive (HDD) storage should be used.

EncryptionConfig

KmsKeyName string

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}

KmsKeyName string

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}

kmsKeyName String

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}

kmsKeyName string

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}

kms_key_name str

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}

kmsKeyName String

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}

EncryptionConfigResponse

KmsKeyName string

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}

KmsKeyName string

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}

kmsKeyName String

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}

kmsKeyName string

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}

kms_key_name str

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}

kmsKeyName String

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}

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0