1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. vmwareengine
  5. getCluster
Google Cloud Classic v7.23.0 published on Wednesday, May 15, 2024 by Pulumi

gcp.vmwareengine.getCluster

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.23.0 published on Wednesday, May 15, 2024 by Pulumi

    Use this data source to get details about a cluster resource.

    To get more information about private cloud cluster, see:

    Example Usage

    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/v7/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.

    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)
    // Output-based functions aren't available in Java yet
    
    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:

    Id string
    The provider-assigned unique ID for this managed resource.
    Management bool
    Name string
    NodeTypeConfigs List<GetClusterNodeTypeConfig>
    Parent string
    State string
    Uid string
    Id string
    The provider-assigned unique ID for this managed resource.
    Management bool
    Name string
    NodeTypeConfigs []GetClusterNodeTypeConfig
    Parent string
    State string
    Uid string
    id String
    The provider-assigned unique ID for this managed resource.
    management Boolean
    name String
    nodeTypeConfigs List<GetClusterNodeTypeConfig>
    parent String
    state String
    uid String
    id string
    The provider-assigned unique ID for this managed resource.
    management boolean
    name string
    nodeTypeConfigs GetClusterNodeTypeConfig[]
    parent string
    state string
    uid string
    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
    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

    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.
    gcp logo
    Google Cloud Classic v7.23.0 published on Wednesday, May 15, 2024 by Pulumi