Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigtableadmin
  5. bigtableadmin/v2
  6. Cluster

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.bigtableadmin/v2.Cluster

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    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

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cluster_id: Optional[str] = None,
            instance_id: Optional[str] = None,
            cluster_config: Optional[ClusterConfigArgs] = None,
            default_storage_type: Optional[ClusterDefaultStorageType] = None,
            encryption_config: Optional[EncryptionConfigArgs] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            serve_nodes: Optional[int] = 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.

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleclusterResourceResourceFromBigtableadminv2 = new GoogleNative.BigtableAdmin.V2.Cluster("exampleclusterResourceResourceFromBigtableadminv2", new()
{
    ClusterId = "string",
    InstanceId = "string",
    ClusterConfig = new GoogleNative.BigtableAdmin.V2.Inputs.ClusterConfigArgs
    {
        ClusterAutoscalingConfig = new GoogleNative.BigtableAdmin.V2.Inputs.ClusterAutoscalingConfigArgs
        {
            AutoscalingLimits = new GoogleNative.BigtableAdmin.V2.Inputs.AutoscalingLimitsArgs
            {
                MaxServeNodes = 0,
                MinServeNodes = 0,
            },
            AutoscalingTargets = new GoogleNative.BigtableAdmin.V2.Inputs.AutoscalingTargetsArgs
            {
                CpuUtilizationPercent = 0,
                StorageUtilizationGibPerNode = 0,
            },
        },
    },
    DefaultStorageType = GoogleNative.BigtableAdmin.V2.ClusterDefaultStorageType.StorageTypeUnspecified,
    EncryptionConfig = new GoogleNative.BigtableAdmin.V2.Inputs.EncryptionConfigArgs
    {
        KmsKeyName = "string",
    },
    Location = "string",
    Name = "string",
    Project = "string",
    ServeNodes = 0,
});

    example, err := bigtableadmin.NewCluster(ctx, "exampleclusterResourceResourceFromBigtableadminv2", &bigtableadmin.ClusterArgs{
ClusterId: pulumi.String("string"),
InstanceId: pulumi.String("string"),
ClusterConfig: &bigtableadmin.ClusterConfigArgs{
ClusterAutoscalingConfig: &bigtableadmin.ClusterAutoscalingConfigArgs{
AutoscalingLimits: &bigtableadmin.AutoscalingLimitsArgs{
MaxServeNodes: pulumi.Int(0),
MinServeNodes: pulumi.Int(0),
},
AutoscalingTargets: &bigtableadmin.AutoscalingTargetsArgs{
CpuUtilizationPercent: pulumi.Int(0),
StorageUtilizationGibPerNode: pulumi.Int(0),
},
},
},
DefaultStorageType: bigtableadmin.ClusterDefaultStorageTypeStorageTypeUnspecified,
EncryptionConfig: &bigtableadmin.EncryptionConfigArgs{
KmsKeyName: pulumi.String("string"),
},
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
ServeNodes: pulumi.Int(0),
})

    var exampleclusterResourceResourceFromBigtableadminv2 = new Cluster("exampleclusterResourceResourceFromBigtableadminv2", ClusterArgs.builder()        
    .clusterId("string")
    .instanceId("string")
    .clusterConfig(ClusterConfigArgs.builder()
        .clusterAutoscalingConfig(ClusterAutoscalingConfigArgs.builder()
            .autoscalingLimits(AutoscalingLimitsArgs.builder()
                .maxServeNodes(0)
                .minServeNodes(0)
                .build())
            .autoscalingTargets(AutoscalingTargetsArgs.builder()
                .cpuUtilizationPercent(0)
                .storageUtilizationGibPerNode(0)
                .build())
            .build())
        .build())
    .defaultStorageType("STORAGE_TYPE_UNSPECIFIED")
    .encryptionConfig(EncryptionConfigArgs.builder()
        .kmsKeyName("string")
        .build())
    .location("string")
    .name("string")
    .project("string")
    .serveNodes(0)
    .build());

    examplecluster_resource_resource_from_bigtableadminv2 = google_native.bigtableadmin.v2.Cluster("exampleclusterResourceResourceFromBigtableadminv2",
    cluster_id="string",
    instance_id="string",
    cluster_config=google_native.bigtableadmin.v2.ClusterConfigArgs(
        cluster_autoscaling_config=google_native.bigtableadmin.v2.ClusterAutoscalingConfigArgs(
            autoscaling_limits=google_native.bigtableadmin.v2.AutoscalingLimitsArgs(
                max_serve_nodes=0,
                min_serve_nodes=0,
            ),
            autoscaling_targets=google_native.bigtableadmin.v2.AutoscalingTargetsArgs(
                cpu_utilization_percent=0,
                storage_utilization_gib_per_node=0,
            ),
        ),
    ),
    default_storage_type=google_native.bigtableadmin.v2.ClusterDefaultStorageType.STORAGE_TYPE_UNSPECIFIED,
    encryption_config=google_native.bigtableadmin.v2.EncryptionConfigArgs(
        kms_key_name="string",
    ),
    location="string",
    name="string",
    project="string",
    serve_nodes=0)

    const exampleclusterResourceResourceFromBigtableadminv2 = new google_native.bigtableadmin.v2.Cluster("exampleclusterResourceResourceFromBigtableadminv2", {
    clusterId: "string",
    instanceId: "string",
    clusterConfig: {
        clusterAutoscalingConfig: {
            autoscalingLimits: {
                maxServeNodes: 0,
                minServeNodes: 0,
            },
            autoscalingTargets: {
                cpuUtilizationPercent: 0,
                storageUtilizationGibPerNode: 0,
            },
        },
    },
    defaultStorageType: google_native.bigtableadmin.v2.ClusterDefaultStorageType.StorageTypeUnspecified,
    encryptionConfig: {
        kmsKeyName: "string",
    },
    location: "string",
    name: "string",
    project: "string",
    serveNodes: 0,
});

    type: google-native:bigtableadmin/v2:Cluster
properties:
    clusterConfig:
        clusterAutoscalingConfig:
            autoscalingLimits:
                maxServeNodes: 0
                minServeNodes: 0
            autoscalingTargets:
                cpuUtilizationPercent: 0
                storageUtilizationGibPerNode: 0
    clusterId: string
    defaultStorageType: STORAGE_TYPE_UNSPECIFIED
    encryptionConfig:
        kmsKeyName: string
    instanceId: string
    location: string
    name: string
    project: string
    serveNodes: 0

    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.ClusterConfig
    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.EncryptionConfig
    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 in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
    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 in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
    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 ClusterConfig
    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 EncryptionConfig
    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 in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
    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 ClusterConfig
    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 EncryptionConfig
    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 in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
    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 in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
    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 in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

    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, AutoscalingLimitsArgs

    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, AutoscalingLimitsResponseArgs

    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, AutoscalingTargetsArgs

    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, AutoscalingTargetsResponseArgs

    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, ClusterAutoscalingConfigArgs

    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, ClusterAutoscalingConfigResponseArgs

    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, ClusterConfigArgs

    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, ClusterConfigResponseArgs

    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, ClusterDefaultStorageTypeArgs

    StorageTypeUnspecified
    STORAGE_TYPE_UNSPECIFIEDThe user did not specify a storage type.
    Ssd
    SSDFlash (SSD) storage should be used.
    Hdd
    HDDMagnetic drive (HDD) storage should be used.
    ClusterDefaultStorageTypeStorageTypeUnspecified
    STORAGE_TYPE_UNSPECIFIEDThe user did not specify a storage type.
    ClusterDefaultStorageTypeSsd
    SSDFlash (SSD) storage should be used.
    ClusterDefaultStorageTypeHdd
    HDDMagnetic drive (HDD) storage should be used.
    StorageTypeUnspecified
    STORAGE_TYPE_UNSPECIFIEDThe user did not specify a storage type.
    Ssd
    SSDFlash (SSD) storage should be used.
    Hdd
    HDDMagnetic drive (HDD) storage should be used.
    StorageTypeUnspecified
    STORAGE_TYPE_UNSPECIFIEDThe user did not specify a storage type.
    Ssd
    SSDFlash (SSD) storage should be used.
    Hdd
    HDDMagnetic drive (HDD) storage should be used.
    STORAGE_TYPE_UNSPECIFIED
    STORAGE_TYPE_UNSPECIFIEDThe user did not specify a storage type.
    SSD
    SSDFlash (SSD) storage should be used.
    HDD
    HDDMagnetic drive (HDD) storage should be used.
    "STORAGE_TYPE_UNSPECIFIED"
    STORAGE_TYPE_UNSPECIFIEDThe user did not specify a storage type.
    "SSD"
    SSDFlash (SSD) storage should be used.
    "HDD"
    HDDMagnetic drive (HDD) storage should be used.

    EncryptionConfig, EncryptionConfigArgs

    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, EncryptionConfigResponseArgs

    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
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native