Google Cloud v8.26.0, Apr 10 25

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi

gcp.vmwareengine.getCluster

Explore with Pulumi AI

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const myCluster = gcp.vmwareengine.getCluster({
    name: "my-cluster",
    parent: "project/locations/us-west1-a/privateClouds/my-cloud",
});

import pulumi
import pulumi_gcp as gcp

my_cluster = gcp.vmwareengine.get_cluster(name="my-cluster",
    parent="project/locations/us-west1-a/privateClouds/my-cloud")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/vmwareengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vmwareengine.LookupCluster(ctx, &vmwareengine.LookupClusterArgs{
			Name:   "my-cluster",
			Parent: "project/locations/us-west1-a/privateClouds/my-cloud",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var myCluster = Gcp.VMwareEngine.GetCluster.Invoke(new()
    {
        Name = "my-cluster",
        Parent = "project/locations/us-west1-a/privateClouds/my-cloud",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.vmwareengine.VmwareengineFunctions;
import com.pulumi.gcp.vmwareengine.inputs.GetClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var myCluster = VmwareengineFunctions.getCluster(GetClusterArgs.builder()
            .name("my-cluster")
            .parent("project/locations/us-west1-a/privateClouds/my-cloud")
            .build());

    }
}

variables:
  myCluster:
    fn::invoke:
      function: gcp:vmwareengine:getCluster
      arguments:
        name: my-cluster
        parent: project/locations/us-west1-a/privateClouds/my-cloud

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.

TypeScript
Python
Go
C#
Java
YAML

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>

def get_cluster(name: Optional[str] = None,
                parent: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(name: Optional[pulumi.Input[str]] = None,
                parent: 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)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

fn::invoke:
  function: gcp:vmwareengine/getCluster:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the resource.
Parent string: The resource name of the private cloud that this cluster belongs.

Name string: Name of the resource.
Parent string: The resource name of the private cloud that this cluster belongs.

name String: Name of the resource.
parent String: The resource name of the private cloud that this cluster belongs.

name string: Name of the resource.
parent string: The resource name of the private cloud that this cluster belongs.

name str: Name of the resource.
parent str: The resource name of the private cloud that this cluster belongs.

name String: Name of the resource.
parent String: The resource name of the private cloud that this cluster belongs.

getCluster Result

The following output properties are available:

AutoscalingSettings List<GetClusterAutoscalingSetting>
Id string: The provider-assigned unique ID for this managed resource.
Management bool
Name string
NodeTypeConfigs List<GetClusterNodeTypeConfig>
Parent string
State string
Uid string

AutoscalingSettings []GetClusterAutoscalingSetting
Id string: The provider-assigned unique ID for this managed resource.
Management bool
Name string
NodeTypeConfigs []GetClusterNodeTypeConfig
Parent string
State string
Uid string

autoscalingSettings List<GetClusterAutoscalingSetting>
id String: The provider-assigned unique ID for this managed resource.
management Boolean
name String
nodeTypeConfigs List<GetClusterNodeTypeConfig>
parent String
state String
uid String

autoscalingSettings GetClusterAutoscalingSetting[]
id string: The provider-assigned unique ID for this managed resource.
management boolean
name string
nodeTypeConfigs GetClusterNodeTypeConfig[]
parent string
state string
uid string

autoscaling_settings Sequence[GetClusterAutoscalingSetting]
id str: The provider-assigned unique ID for this managed resource.
management bool
name str
node_type_configs Sequence[GetClusterNodeTypeConfig]
parent str
state str
uid str

autoscalingSettings List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
management Boolean
name String
nodeTypeConfigs List<Property Map>
parent String
state String
uid String

Supporting Types

GetClusterAutoscalingSetting

AutoscalingPolicies List<GetClusterAutoscalingSettingAutoscalingPolicy>

The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements:

Only contains 1-63 alphanumeric characters and hyphens
Begins with an alphabetical character
Ends with a non-hyphen character
Not formatted as a UUID
Complies with RFC 1034 (section 3.5)

Currently the map must contain only one element that describes the autoscaling policy for compute nodes.

CoolDownPeriod string

The minimum duration between consecutive autoscale operations. It starts once addition or removal of nodes is fully completed. Minimum cool down period is 30m. Cool down period must be in whole minutes (for example, 30m, 31m, 50m). Mandatory for successful addition of autoscaling settings in cluster.

MaxClusterNodeCount int

Maximum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

MinClusterNodeCount int

Minimum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

AutoscalingPolicies []GetClusterAutoscalingSettingAutoscalingPolicy

The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements:

Only contains 1-63 alphanumeric characters and hyphens
Begins with an alphabetical character
Ends with a non-hyphen character
Not formatted as a UUID
Complies with RFC 1034 (section 3.5)

Currently the map must contain only one element that describes the autoscaling policy for compute nodes.

CoolDownPeriod string

MaxClusterNodeCount int

Maximum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

MinClusterNodeCount int

Minimum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

autoscalingPolicies List<GetClusterAutoscalingSettingAutoscalingPolicy>

The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements:

Only contains 1-63 alphanumeric characters and hyphens
Begins with an alphabetical character
Ends with a non-hyphen character
Not formatted as a UUID
Complies with RFC 1034 (section 3.5)

Currently the map must contain only one element that describes the autoscaling policy for compute nodes.

coolDownPeriod String

maxClusterNodeCount Integer

Maximum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

minClusterNodeCount Integer

Minimum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

autoscalingPolicies GetClusterAutoscalingSettingAutoscalingPolicy[]

The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements:

Only contains 1-63 alphanumeric characters and hyphens
Begins with an alphabetical character
Ends with a non-hyphen character
Not formatted as a UUID
Complies with RFC 1034 (section 3.5)

Currently the map must contain only one element that describes the autoscaling policy for compute nodes.

coolDownPeriod string

maxClusterNodeCount number

Maximum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

minClusterNodeCount number

Minimum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

autoscaling_policies Sequence[GetClusterAutoscalingSettingAutoscalingPolicy]

The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements:

Only contains 1-63 alphanumeric characters and hyphens
Begins with an alphabetical character
Ends with a non-hyphen character
Not formatted as a UUID
Complies with RFC 1034 (section 3.5)

Currently the map must contain only one element that describes the autoscaling policy for compute nodes.

cool_down_period str

max_cluster_node_count int

Maximum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

min_cluster_node_count int

Minimum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

autoscalingPolicies List<Property Map>

The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements:

Only contains 1-63 alphanumeric characters and hyphens
Begins with an alphabetical character
Ends with a non-hyphen character
Not formatted as a UUID
Complies with RFC 1034 (section 3.5)

Currently the map must contain only one element that describes the autoscaling policy for compute nodes.

coolDownPeriod String

maxClusterNodeCount Number

Maximum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

minClusterNodeCount Number

Minimum number of nodes of any type in a cluster. Mandatory for successful addition of autoscaling settings in cluster.

GetClusterAutoscalingSettingAutoscalingPolicy

AutoscalePolicyId string
ConsumedMemoryThresholds List<GetClusterAutoscalingSettingAutoscalingPolicyConsumedMemoryThreshold>: Utilization thresholds pertaining to amount of consumed memory.
CpuThresholds List<GetClusterAutoscalingSettingAutoscalingPolicyCpuThreshold>: Utilization thresholds pertaining to CPU utilization.
NodeTypeId string: The canonical identifier of the node type to add or remove.
ScaleOutSize int: Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters.
StorageThresholds List<GetClusterAutoscalingSettingAutoscalingPolicyStorageThreshold>: Utilization thresholds pertaining to amount of consumed storage.

AutoscalePolicyId string
ConsumedMemoryThresholds []GetClusterAutoscalingSettingAutoscalingPolicyConsumedMemoryThreshold: Utilization thresholds pertaining to amount of consumed memory.
CpuThresholds []GetClusterAutoscalingSettingAutoscalingPolicyCpuThreshold: Utilization thresholds pertaining to CPU utilization.
NodeTypeId string: The canonical identifier of the node type to add or remove.
ScaleOutSize int: Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters.
StorageThresholds []GetClusterAutoscalingSettingAutoscalingPolicyStorageThreshold: Utilization thresholds pertaining to amount of consumed storage.

autoscalePolicyId String
consumedMemoryThresholds List<GetClusterAutoscalingSettingAutoscalingPolicyConsumedMemoryThreshold>: Utilization thresholds pertaining to amount of consumed memory.
cpuThresholds List<GetClusterAutoscalingSettingAutoscalingPolicyCpuThreshold>: Utilization thresholds pertaining to CPU utilization.
nodeTypeId String: The canonical identifier of the node type to add or remove.
scaleOutSize Integer: Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters.
storageThresholds List<GetClusterAutoscalingSettingAutoscalingPolicyStorageThreshold>: Utilization thresholds pertaining to amount of consumed storage.

autoscalePolicyId string
consumedMemoryThresholds GetClusterAutoscalingSettingAutoscalingPolicyConsumedMemoryThreshold[]: Utilization thresholds pertaining to amount of consumed memory.
cpuThresholds GetClusterAutoscalingSettingAutoscalingPolicyCpuThreshold[]: Utilization thresholds pertaining to CPU utilization.
nodeTypeId string: The canonical identifier of the node type to add or remove.
scaleOutSize number: Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters.
storageThresholds GetClusterAutoscalingSettingAutoscalingPolicyStorageThreshold[]: Utilization thresholds pertaining to amount of consumed storage.

autoscale_policy_id str
consumed_memory_thresholds Sequence[GetClusterAutoscalingSettingAutoscalingPolicyConsumedMemoryThreshold]: Utilization thresholds pertaining to amount of consumed memory.
cpu_thresholds Sequence[GetClusterAutoscalingSettingAutoscalingPolicyCpuThreshold]: Utilization thresholds pertaining to CPU utilization.
node_type_id str: The canonical identifier of the node type to add or remove.
scale_out_size int: Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters.
storage_thresholds Sequence[GetClusterAutoscalingSettingAutoscalingPolicyStorageThreshold]: Utilization thresholds pertaining to amount of consumed storage.

autoscalePolicyId String
consumedMemoryThresholds List<Property Map>: Utilization thresholds pertaining to amount of consumed memory.
cpuThresholds List<Property Map>: Utilization thresholds pertaining to CPU utilization.
nodeTypeId String: The canonical identifier of the node type to add or remove.
scaleOutSize Number: Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters.
storageThresholds List<Property Map>: Utilization thresholds pertaining to amount of consumed storage.

GetClusterAutoscalingSettingAutoscalingPolicyConsumedMemoryThreshold

ScaleIn int: The utilization triggering the scale-in operation in percent.
ScaleOut int: The utilization triggering the scale-out operation in percent.

ScaleIn int: The utilization triggering the scale-in operation in percent.
ScaleOut int: The utilization triggering the scale-out operation in percent.

scaleIn Integer: The utilization triggering the scale-in operation in percent.
scaleOut Integer: The utilization triggering the scale-out operation in percent.

scaleIn number: The utilization triggering the scale-in operation in percent.
scaleOut number: The utilization triggering the scale-out operation in percent.

scale_in int: The utilization triggering the scale-in operation in percent.
scale_out int: The utilization triggering the scale-out operation in percent.

scaleIn Number: The utilization triggering the scale-in operation in percent.
scaleOut Number: The utilization triggering the scale-out operation in percent.

GetClusterAutoscalingSettingAutoscalingPolicyCpuThreshold

ScaleIn int: The utilization triggering the scale-in operation in percent.
ScaleOut int: The utilization triggering the scale-out operation in percent.

ScaleIn int: The utilization triggering the scale-in operation in percent.
ScaleOut int: The utilization triggering the scale-out operation in percent.

scaleIn Integer: The utilization triggering the scale-in operation in percent.
scaleOut Integer: The utilization triggering the scale-out operation in percent.

scaleIn number: The utilization triggering the scale-in operation in percent.
scaleOut number: The utilization triggering the scale-out operation in percent.

scale_in int: The utilization triggering the scale-in operation in percent.
scale_out int: The utilization triggering the scale-out operation in percent.

scaleIn Number: The utilization triggering the scale-in operation in percent.
scaleOut Number: The utilization triggering the scale-out operation in percent.

GetClusterAutoscalingSettingAutoscalingPolicyStorageThreshold

ScaleIn int: The utilization triggering the scale-in operation in percent.
ScaleOut int: The utilization triggering the scale-out operation in percent.

ScaleIn int: The utilization triggering the scale-in operation in percent.
ScaleOut int: The utilization triggering the scale-out operation in percent.

scaleIn Integer: The utilization triggering the scale-in operation in percent.
scaleOut Integer: The utilization triggering the scale-out operation in percent.

scaleIn number: The utilization triggering the scale-in operation in percent.
scaleOut number: The utilization triggering the scale-out operation in percent.

scale_in int: The utilization triggering the scale-in operation in percent.
scale_out int: The utilization triggering the scale-out operation in percent.

scaleIn Number: The utilization triggering the scale-in operation in percent.
scaleOut Number: The utilization triggering the scale-out operation in percent.

GetClusterNodeTypeConfig

CustomCoreCount int: Customized number of cores available to each node of the type. This number must always be one of 'nodeType.availableCustomCoreCounts'. If zero is provided max value from 'nodeType.availableCustomCoreCounts' will be used. Once the customer is created then corecount cannot be changed.
NodeCount int: The number of nodes of this type in the cluster.
NodeTypeId string

CustomCoreCount int: Customized number of cores available to each node of the type. This number must always be one of 'nodeType.availableCustomCoreCounts'. If zero is provided max value from 'nodeType.availableCustomCoreCounts' will be used. Once the customer is created then corecount cannot be changed.
NodeCount int: The number of nodes of this type in the cluster.
NodeTypeId string

customCoreCount Integer: Customized number of cores available to each node of the type. This number must always be one of 'nodeType.availableCustomCoreCounts'. If zero is provided max value from 'nodeType.availableCustomCoreCounts' will be used. Once the customer is created then corecount cannot be changed.
nodeCount Integer: The number of nodes of this type in the cluster.
nodeTypeId String

customCoreCount number: Customized number of cores available to each node of the type. This number must always be one of 'nodeType.availableCustomCoreCounts'. If zero is provided max value from 'nodeType.availableCustomCoreCounts' will be used. Once the customer is created then corecount cannot be changed.
nodeCount number: The number of nodes of this type in the cluster.
nodeTypeId string

custom_core_count int: Customized number of cores available to each node of the type. This number must always be one of 'nodeType.availableCustomCoreCounts'. If zero is provided max value from 'nodeType.availableCustomCoreCounts' will be used. Once the customer is created then corecount cannot be changed.
node_count int: The number of nodes of this type in the cluster.
node_type_id str

customCoreCount Number: Customized number of cores available to each node of the type. This number must always be one of 'nodeType.availableCustomCoreCounts'. If zero is provided max value from 'nodeType.availableCustomCoreCounts' will be used. Once the customer is created then corecount cannot be changed.
nodeCount Number: The number of nodes of this type in the cluster.
nodeTypeId String

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.vmwareengine.getCluster

On this page

On this page

Example Usage

Using getCluster

getCluster Result

Supporting Types

GetClusterAutoscalingSetting

GetClusterAutoscalingSettingAutoscalingPolicy

GetClusterAutoscalingSettingAutoscalingPolicyConsumedMemoryThreshold

GetClusterAutoscalingSettingAutoscalingPolicyCpuThreshold

GetClusterAutoscalingSettingAutoscalingPolicyStorageThreshold

GetClusterNodeTypeConfig

Package Details

On this page

On this page