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

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.getCluster

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

    Gets information about a cluster.

    Using getCluster

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
    def get_cluster(cluster_id: Optional[str] = None,
                instance_id: Optional[str] = None,
                project: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                instance_id: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

    > Note: This function is named LookupCluster in the Go SDK.

    public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:bigtableadmin/v2:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    InstanceId string
    Project string
    ClusterId string
    InstanceId string
    Project string
    clusterId String
    instanceId String
    project String
    clusterId string
    instanceId string
    project string
    clusterId String
    instanceId String
    project String

    getCluster Result

    The following output properties are available:

    ClusterConfig Pulumi.GoogleNative.BigtableAdmin.V2.Outputs.ClusterConfigResponse
    Configuration for this cluster.
    DefaultStorageType string
    Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
    EncryptionConfig Pulumi.GoogleNative.BigtableAdmin.V2.Outputs.EncryptionConfigResponse
    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*.
    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.
    State string
    The current state of the cluster.
    ClusterConfig ClusterConfigResponse
    Configuration for this cluster.
    DefaultStorageType string
    Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
    EncryptionConfig EncryptionConfigResponse
    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*.
    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.
    State string
    The current state of the cluster.
    clusterConfig ClusterConfigResponse
    Configuration for this cluster.
    defaultStorageType String
    Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
    encryptionConfig EncryptionConfigResponse
    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*.
    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.
    state String
    The current state of the cluster.
    clusterConfig ClusterConfigResponse
    Configuration for this cluster.
    defaultStorageType string
    Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
    encryptionConfig EncryptionConfigResponse
    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*.
    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.
    state string
    The current state of the cluster.
    cluster_config ClusterConfigResponse
    Configuration for this cluster.
    default_storage_type str
    Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
    encryption_config EncryptionConfigResponse
    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*.
    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.
    state str
    The current state of the cluster.
    clusterConfig Property Map
    Configuration for this cluster.
    defaultStorageType String
    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*.
    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.
    state String
    The current state of the cluster.

    Supporting Types

    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.

    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.

    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.

    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.

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