1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. vmwareengine
  5. Cluster
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.vmwareengine.Cluster

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

    A cluster in a private cloud.

    To get more information about Cluster, see:

    Example Usage

    Vmware Engine Cluster Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const cluster_nw = new gcp.vmwareengine.Network("cluster-nw", {
        name: "pc-nw",
        type: "STANDARD",
        location: "global",
        description: "PC network description.",
    });
    const cluster_pc = new gcp.vmwareengine.PrivateCloud("cluster-pc", {
        location: "us-west1-a",
        name: "sample-pc",
        description: "Sample test PC.",
        networkConfig: {
            managementCidr: "192.168.30.0/24",
            vmwareEngineNetwork: cluster_nw.id,
        },
        managementCluster: {
            clusterId: "sample-mgmt-cluster",
            nodeTypeConfigs: [{
                nodeTypeId: "standard-72",
                nodeCount: 3,
            }],
        },
    });
    const vmw_engine_ext_cluster = new gcp.vmwareengine.Cluster("vmw-engine-ext-cluster", {
        name: "ext-cluster",
        parent: cluster_pc.id,
        nodeTypeConfigs: [{
            nodeTypeId: "standard-72",
            nodeCount: 3,
        }],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    cluster_nw = gcp.vmwareengine.Network("cluster-nw",
        name="pc-nw",
        type="STANDARD",
        location="global",
        description="PC network description.")
    cluster_pc = gcp.vmwareengine.PrivateCloud("cluster-pc",
        location="us-west1-a",
        name="sample-pc",
        description="Sample test PC.",
        network_config=gcp.vmwareengine.PrivateCloudNetworkConfigArgs(
            management_cidr="192.168.30.0/24",
            vmware_engine_network=cluster_nw.id,
        ),
        management_cluster=gcp.vmwareengine.PrivateCloudManagementClusterArgs(
            cluster_id="sample-mgmt-cluster",
            node_type_configs=[gcp.vmwareengine.PrivateCloudManagementClusterNodeTypeConfigArgs(
                node_type_id="standard-72",
                node_count=3,
            )],
        ))
    vmw_engine_ext_cluster = gcp.vmwareengine.Cluster("vmw-engine-ext-cluster",
        name="ext-cluster",
        parent=cluster_pc.id,
        node_type_configs=[gcp.vmwareengine.ClusterNodeTypeConfigArgs(
            node_type_id="standard-72",
            node_count=3,
        )])
    
    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.NewNetwork(ctx, "cluster-nw", &vmwareengine.NetworkArgs{
    			Name:        pulumi.String("pc-nw"),
    			Type:        pulumi.String("STANDARD"),
    			Location:    pulumi.String("global"),
    			Description: pulumi.String("PC network description."),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = vmwareengine.NewPrivateCloud(ctx, "cluster-pc", &vmwareengine.PrivateCloudArgs{
    			Location:    pulumi.String("us-west1-a"),
    			Name:        pulumi.String("sample-pc"),
    			Description: pulumi.String("Sample test PC."),
    			NetworkConfig: &vmwareengine.PrivateCloudNetworkConfigArgs{
    				ManagementCidr:      pulumi.String("192.168.30.0/24"),
    				VmwareEngineNetwork: cluster_nw.ID(),
    			},
    			ManagementCluster: &vmwareengine.PrivateCloudManagementClusterArgs{
    				ClusterId: pulumi.String("sample-mgmt-cluster"),
    				NodeTypeConfigs: vmwareengine.PrivateCloudManagementClusterNodeTypeConfigArray{
    					&vmwareengine.PrivateCloudManagementClusterNodeTypeConfigArgs{
    						NodeTypeId: pulumi.String("standard-72"),
    						NodeCount:  pulumi.Int(3),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = vmwareengine.NewCluster(ctx, "vmw-engine-ext-cluster", &vmwareengine.ClusterArgs{
    			Name:   pulumi.String("ext-cluster"),
    			Parent: cluster_pc.ID(),
    			NodeTypeConfigs: vmwareengine.ClusterNodeTypeConfigArray{
    				&vmwareengine.ClusterNodeTypeConfigArgs{
    					NodeTypeId: pulumi.String("standard-72"),
    					NodeCount:  pulumi.Int(3),
    				},
    			},
    		})
    		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 cluster_nw = new Gcp.VMwareEngine.Network("cluster-nw", new()
        {
            Name = "pc-nw",
            Type = "STANDARD",
            Location = "global",
            Description = "PC network description.",
        });
    
        var cluster_pc = new Gcp.VMwareEngine.PrivateCloud("cluster-pc", new()
        {
            Location = "us-west1-a",
            Name = "sample-pc",
            Description = "Sample test PC.",
            NetworkConfig = new Gcp.VMwareEngine.Inputs.PrivateCloudNetworkConfigArgs
            {
                ManagementCidr = "192.168.30.0/24",
                VmwareEngineNetwork = cluster_nw.Id,
            },
            ManagementCluster = new Gcp.VMwareEngine.Inputs.PrivateCloudManagementClusterArgs
            {
                ClusterId = "sample-mgmt-cluster",
                NodeTypeConfigs = new[]
                {
                    new Gcp.VMwareEngine.Inputs.PrivateCloudManagementClusterNodeTypeConfigArgs
                    {
                        NodeTypeId = "standard-72",
                        NodeCount = 3,
                    },
                },
            },
        });
    
        var vmw_engine_ext_cluster = new Gcp.VMwareEngine.Cluster("vmw-engine-ext-cluster", new()
        {
            Name = "ext-cluster",
            Parent = cluster_pc.Id,
            NodeTypeConfigs = new[]
            {
                new Gcp.VMwareEngine.Inputs.ClusterNodeTypeConfigArgs
                {
                    NodeTypeId = "standard-72",
                    NodeCount = 3,
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.vmwareengine.Network;
    import com.pulumi.gcp.vmwareengine.NetworkArgs;
    import com.pulumi.gcp.vmwareengine.PrivateCloud;
    import com.pulumi.gcp.vmwareengine.PrivateCloudArgs;
    import com.pulumi.gcp.vmwareengine.inputs.PrivateCloudNetworkConfigArgs;
    import com.pulumi.gcp.vmwareengine.inputs.PrivateCloudManagementClusterArgs;
    import com.pulumi.gcp.vmwareengine.Cluster;
    import com.pulumi.gcp.vmwareengine.ClusterArgs;
    import com.pulumi.gcp.vmwareengine.inputs.ClusterNodeTypeConfigArgs;
    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) {
            var cluster_nw = new Network("cluster-nw", NetworkArgs.builder()
                .name("pc-nw")
                .type("STANDARD")
                .location("global")
                .description("PC network description.")
                .build());
    
            var cluster_pc = new PrivateCloud("cluster-pc", PrivateCloudArgs.builder()
                .location("us-west1-a")
                .name("sample-pc")
                .description("Sample test PC.")
                .networkConfig(PrivateCloudNetworkConfigArgs.builder()
                    .managementCidr("192.168.30.0/24")
                    .vmwareEngineNetwork(cluster_nw.id())
                    .build())
                .managementCluster(PrivateCloudManagementClusterArgs.builder()
                    .clusterId("sample-mgmt-cluster")
                    .nodeTypeConfigs(PrivateCloudManagementClusterNodeTypeConfigArgs.builder()
                        .nodeTypeId("standard-72")
                        .nodeCount(3)
                        .build())
                    .build())
                .build());
    
            var vmw_engine_ext_cluster = new Cluster("vmw-engine-ext-cluster", ClusterArgs.builder()
                .name("ext-cluster")
                .parent(cluster_pc.id())
                .nodeTypeConfigs(ClusterNodeTypeConfigArgs.builder()
                    .nodeTypeId("standard-72")
                    .nodeCount(3)
                    .build())
                .build());
    
        }
    }
    
    resources:
      vmw-engine-ext-cluster:
        type: gcp:vmwareengine:Cluster
        properties:
          name: ext-cluster
          parent: ${["cluster-pc"].id}
          nodeTypeConfigs:
            - nodeTypeId: standard-72
              nodeCount: 3
      cluster-pc:
        type: gcp:vmwareengine:PrivateCloud
        properties:
          location: us-west1-a
          name: sample-pc
          description: Sample test PC.
          networkConfig:
            managementCidr: 192.168.30.0/24
            vmwareEngineNetwork: ${["cluster-nw"].id}
          managementCluster:
            clusterId: sample-mgmt-cluster
            nodeTypeConfigs:
              - nodeTypeId: standard-72
                nodeCount: 3
      cluster-nw:
        type: gcp:vmwareengine:Network
        properties:
          name: pc-nw
          type: STANDARD
          location: global
          description: PC network description.
    

    Vmware Engine Cluster Full

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const cluster_nw = new gcp.vmwareengine.Network("cluster-nw", {
        name: "pc-nw",
        type: "STANDARD",
        location: "global",
        description: "PC network description.",
    });
    const cluster_pc = new gcp.vmwareengine.PrivateCloud("cluster-pc", {
        location: "us-west1-a",
        name: "sample-pc",
        description: "Sample test PC.",
        networkConfig: {
            managementCidr: "192.168.30.0/24",
            vmwareEngineNetwork: cluster_nw.id,
        },
        managementCluster: {
            clusterId: "sample-mgmt-cluster",
            nodeTypeConfigs: [{
                nodeTypeId: "standard-72",
                nodeCount: 3,
                customCoreCount: 32,
            }],
        },
    });
    const vmw_ext_cluster = new gcp.vmwareengine.Cluster("vmw-ext-cluster", {
        name: "ext-cluster",
        parent: cluster_pc.id,
        nodeTypeConfigs: [{
            nodeTypeId: "standard-72",
            nodeCount: 3,
            customCoreCount: 32,
        }],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    cluster_nw = gcp.vmwareengine.Network("cluster-nw",
        name="pc-nw",
        type="STANDARD",
        location="global",
        description="PC network description.")
    cluster_pc = gcp.vmwareengine.PrivateCloud("cluster-pc",
        location="us-west1-a",
        name="sample-pc",
        description="Sample test PC.",
        network_config=gcp.vmwareengine.PrivateCloudNetworkConfigArgs(
            management_cidr="192.168.30.0/24",
            vmware_engine_network=cluster_nw.id,
        ),
        management_cluster=gcp.vmwareengine.PrivateCloudManagementClusterArgs(
            cluster_id="sample-mgmt-cluster",
            node_type_configs=[gcp.vmwareengine.PrivateCloudManagementClusterNodeTypeConfigArgs(
                node_type_id="standard-72",
                node_count=3,
                custom_core_count=32,
            )],
        ))
    vmw_ext_cluster = gcp.vmwareengine.Cluster("vmw-ext-cluster",
        name="ext-cluster",
        parent=cluster_pc.id,
        node_type_configs=[gcp.vmwareengine.ClusterNodeTypeConfigArgs(
            node_type_id="standard-72",
            node_count=3,
            custom_core_count=32,
        )])
    
    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.NewNetwork(ctx, "cluster-nw", &vmwareengine.NetworkArgs{
    			Name:        pulumi.String("pc-nw"),
    			Type:        pulumi.String("STANDARD"),
    			Location:    pulumi.String("global"),
    			Description: pulumi.String("PC network description."),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = vmwareengine.NewPrivateCloud(ctx, "cluster-pc", &vmwareengine.PrivateCloudArgs{
    			Location:    pulumi.String("us-west1-a"),
    			Name:        pulumi.String("sample-pc"),
    			Description: pulumi.String("Sample test PC."),
    			NetworkConfig: &vmwareengine.PrivateCloudNetworkConfigArgs{
    				ManagementCidr:      pulumi.String("192.168.30.0/24"),
    				VmwareEngineNetwork: cluster_nw.ID(),
    			},
    			ManagementCluster: &vmwareengine.PrivateCloudManagementClusterArgs{
    				ClusterId: pulumi.String("sample-mgmt-cluster"),
    				NodeTypeConfigs: vmwareengine.PrivateCloudManagementClusterNodeTypeConfigArray{
    					&vmwareengine.PrivateCloudManagementClusterNodeTypeConfigArgs{
    						NodeTypeId:      pulumi.String("standard-72"),
    						NodeCount:       pulumi.Int(3),
    						CustomCoreCount: pulumi.Int(32),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = vmwareengine.NewCluster(ctx, "vmw-ext-cluster", &vmwareengine.ClusterArgs{
    			Name:   pulumi.String("ext-cluster"),
    			Parent: cluster_pc.ID(),
    			NodeTypeConfigs: vmwareengine.ClusterNodeTypeConfigArray{
    				&vmwareengine.ClusterNodeTypeConfigArgs{
    					NodeTypeId:      pulumi.String("standard-72"),
    					NodeCount:       pulumi.Int(3),
    					CustomCoreCount: pulumi.Int(32),
    				},
    			},
    		})
    		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 cluster_nw = new Gcp.VMwareEngine.Network("cluster-nw", new()
        {
            Name = "pc-nw",
            Type = "STANDARD",
            Location = "global",
            Description = "PC network description.",
        });
    
        var cluster_pc = new Gcp.VMwareEngine.PrivateCloud("cluster-pc", new()
        {
            Location = "us-west1-a",
            Name = "sample-pc",
            Description = "Sample test PC.",
            NetworkConfig = new Gcp.VMwareEngine.Inputs.PrivateCloudNetworkConfigArgs
            {
                ManagementCidr = "192.168.30.0/24",
                VmwareEngineNetwork = cluster_nw.Id,
            },
            ManagementCluster = new Gcp.VMwareEngine.Inputs.PrivateCloudManagementClusterArgs
            {
                ClusterId = "sample-mgmt-cluster",
                NodeTypeConfigs = new[]
                {
                    new Gcp.VMwareEngine.Inputs.PrivateCloudManagementClusterNodeTypeConfigArgs
                    {
                        NodeTypeId = "standard-72",
                        NodeCount = 3,
                        CustomCoreCount = 32,
                    },
                },
            },
        });
    
        var vmw_ext_cluster = new Gcp.VMwareEngine.Cluster("vmw-ext-cluster", new()
        {
            Name = "ext-cluster",
            Parent = cluster_pc.Id,
            NodeTypeConfigs = new[]
            {
                new Gcp.VMwareEngine.Inputs.ClusterNodeTypeConfigArgs
                {
                    NodeTypeId = "standard-72",
                    NodeCount = 3,
                    CustomCoreCount = 32,
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.vmwareengine.Network;
    import com.pulumi.gcp.vmwareengine.NetworkArgs;
    import com.pulumi.gcp.vmwareengine.PrivateCloud;
    import com.pulumi.gcp.vmwareengine.PrivateCloudArgs;
    import com.pulumi.gcp.vmwareengine.inputs.PrivateCloudNetworkConfigArgs;
    import com.pulumi.gcp.vmwareengine.inputs.PrivateCloudManagementClusterArgs;
    import com.pulumi.gcp.vmwareengine.Cluster;
    import com.pulumi.gcp.vmwareengine.ClusterArgs;
    import com.pulumi.gcp.vmwareengine.inputs.ClusterNodeTypeConfigArgs;
    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) {
            var cluster_nw = new Network("cluster-nw", NetworkArgs.builder()
                .name("pc-nw")
                .type("STANDARD")
                .location("global")
                .description("PC network description.")
                .build());
    
            var cluster_pc = new PrivateCloud("cluster-pc", PrivateCloudArgs.builder()
                .location("us-west1-a")
                .name("sample-pc")
                .description("Sample test PC.")
                .networkConfig(PrivateCloudNetworkConfigArgs.builder()
                    .managementCidr("192.168.30.0/24")
                    .vmwareEngineNetwork(cluster_nw.id())
                    .build())
                .managementCluster(PrivateCloudManagementClusterArgs.builder()
                    .clusterId("sample-mgmt-cluster")
                    .nodeTypeConfigs(PrivateCloudManagementClusterNodeTypeConfigArgs.builder()
                        .nodeTypeId("standard-72")
                        .nodeCount(3)
                        .customCoreCount(32)
                        .build())
                    .build())
                .build());
    
            var vmw_ext_cluster = new Cluster("vmw-ext-cluster", ClusterArgs.builder()
                .name("ext-cluster")
                .parent(cluster_pc.id())
                .nodeTypeConfigs(ClusterNodeTypeConfigArgs.builder()
                    .nodeTypeId("standard-72")
                    .nodeCount(3)
                    .customCoreCount(32)
                    .build())
                .build());
    
        }
    }
    
    resources:
      vmw-ext-cluster:
        type: gcp:vmwareengine:Cluster
        properties:
          name: ext-cluster
          parent: ${["cluster-pc"].id}
          nodeTypeConfigs:
            - nodeTypeId: standard-72
              nodeCount: 3
              customCoreCount: 32
      cluster-pc:
        type: gcp:vmwareengine:PrivateCloud
        properties:
          location: us-west1-a
          name: sample-pc
          description: Sample test PC.
          networkConfig:
            managementCidr: 192.168.30.0/24
            vmwareEngineNetwork: ${["cluster-nw"].id}
          managementCluster:
            clusterId: sample-mgmt-cluster
            nodeTypeConfigs:
              - nodeTypeId: standard-72
                nodeCount: 3
                customCoreCount: 32
      cluster-nw:
        type: gcp:vmwareengine:Network
        properties:
          name: pc-nw
          type: STANDARD
          location: global
          description: PC network description.
    

    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,
                parent: Optional[str] = None,
                name: Optional[str] = None,
                node_type_configs: Optional[Sequence[ClusterNodeTypeConfigArgs]] = 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: gcp:vmwareengine: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 exampleclusterResourceResourceFromVmwareenginecluster = new Gcp.VMwareEngine.Cluster("exampleclusterResourceResourceFromVmwareenginecluster", new()
    {
        Parent = "string",
        Name = "string",
        NodeTypeConfigs = new[]
        {
            new Gcp.VMwareEngine.Inputs.ClusterNodeTypeConfigArgs
            {
                NodeCount = 0,
                NodeTypeId = "string",
                CustomCoreCount = 0,
            },
        },
    });
    
    example, err := vmwareengine.NewCluster(ctx, "exampleclusterResourceResourceFromVmwareenginecluster", &vmwareengine.ClusterArgs{
    	Parent: pulumi.String("string"),
    	Name:   pulumi.String("string"),
    	NodeTypeConfigs: vmwareengine.ClusterNodeTypeConfigArray{
    		&vmwareengine.ClusterNodeTypeConfigArgs{
    			NodeCount:       pulumi.Int(0),
    			NodeTypeId:      pulumi.String("string"),
    			CustomCoreCount: pulumi.Int(0),
    		},
    	},
    })
    
    var exampleclusterResourceResourceFromVmwareenginecluster = new Cluster("exampleclusterResourceResourceFromVmwareenginecluster", ClusterArgs.builder()
        .parent("string")
        .name("string")
        .nodeTypeConfigs(ClusterNodeTypeConfigArgs.builder()
            .nodeCount(0)
            .nodeTypeId("string")
            .customCoreCount(0)
            .build())
        .build());
    
    examplecluster_resource_resource_from_vmwareenginecluster = gcp.vmwareengine.Cluster("exampleclusterResourceResourceFromVmwareenginecluster",
        parent="string",
        name="string",
        node_type_configs=[gcp.vmwareengine.ClusterNodeTypeConfigArgs(
            node_count=0,
            node_type_id="string",
            custom_core_count=0,
        )])
    
    const exampleclusterResourceResourceFromVmwareenginecluster = new gcp.vmwareengine.Cluster("exampleclusterResourceResourceFromVmwareenginecluster", {
        parent: "string",
        name: "string",
        nodeTypeConfigs: [{
            nodeCount: 0,
            nodeTypeId: "string",
            customCoreCount: 0,
        }],
    });
    
    type: gcp:vmwareengine:Cluster
    properties:
        name: string
        nodeTypeConfigs:
            - customCoreCount: 0
              nodeCount: 0
              nodeTypeId: string
        parent: string
    

    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:

    Parent string
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    Name string
    The ID of the Cluster.


    NodeTypeConfigs List<ClusterNodeTypeConfig>
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.
    Parent string
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    Name string
    The ID of the Cluster.


    NodeTypeConfigs []ClusterNodeTypeConfigArgs
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.
    parent String
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    name String
    The ID of the Cluster.


    nodeTypeConfigs List<ClusterNodeTypeConfig>
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.
    parent string
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    name string
    The ID of the Cluster.


    nodeTypeConfigs ClusterNodeTypeConfig[]
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.
    parent str
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    name str
    The ID of the Cluster.


    node_type_configs Sequence[ClusterNodeTypeConfigArgs]
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.
    parent String
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    name String
    The ID of the Cluster.


    nodeTypeConfigs List<Property Map>
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.

    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.
    Management bool
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    State string
    State of the Cluster.
    Uid string
    System-generated unique identifier for the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Management bool
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    State string
    State of the Cluster.
    Uid string
    System-generated unique identifier for the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    management Boolean
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    state String
    State of the Cluster.
    uid String
    System-generated unique identifier for the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    management boolean
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    state string
    State of the Cluster.
    uid string
    System-generated unique identifier for the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    management bool
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    state str
    State of the Cluster.
    uid str
    System-generated unique identifier for the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    management Boolean
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    state String
    State of the Cluster.
    uid String
    System-generated unique identifier for the resource.

    Look up Existing Cluster Resource

    Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            management: Optional[bool] = None,
            name: Optional[str] = None,
            node_type_configs: Optional[Sequence[ClusterNodeTypeConfigArgs]] = None,
            parent: Optional[str] = None,
            state: Optional[str] = None,
            uid: Optional[str] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Management bool
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    Name string
    The ID of the Cluster.


    NodeTypeConfigs List<ClusterNodeTypeConfig>
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.
    Parent string
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    State string
    State of the Cluster.
    Uid string
    System-generated unique identifier for the resource.
    Management bool
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    Name string
    The ID of the Cluster.


    NodeTypeConfigs []ClusterNodeTypeConfigArgs
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.
    Parent string
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    State string
    State of the Cluster.
    Uid string
    System-generated unique identifier for the resource.
    management Boolean
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    name String
    The ID of the Cluster.


    nodeTypeConfigs List<ClusterNodeTypeConfig>
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.
    parent String
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    state String
    State of the Cluster.
    uid String
    System-generated unique identifier for the resource.
    management boolean
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    name string
    The ID of the Cluster.


    nodeTypeConfigs ClusterNodeTypeConfig[]
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.
    parent string
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    state string
    State of the Cluster.
    uid string
    System-generated unique identifier for the resource.
    management bool
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    name str
    The ID of the Cluster.


    node_type_configs Sequence[ClusterNodeTypeConfigArgs]
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.
    parent str
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    state str
    State of the Cluster.
    uid str
    System-generated unique identifier for the resource.
    management Boolean
    True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
    name String
    The ID of the Cluster.


    nodeTypeConfigs List<Property Map>
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType). Structure is documented below.
    parent String
    The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud
    state String
    State of the Cluster.
    uid String
    System-generated unique identifier for the resource.

    Supporting Types

    ClusterNodeTypeConfig, ClusterNodeTypeConfigArgs

    NodeCount int
    The number of nodes of this type in the cluster.
    NodeTypeId string
    The identifier for this object. Format specified above.
    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
    The identifier for this object. Format specified above.
    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 Integer
    The number of nodes of this type in the cluster.
    nodeTypeId String
    The identifier for this object. Format specified above.
    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 number
    The number of nodes of this type in the cluster.
    nodeTypeId string
    The identifier for this object. Format specified above.
    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.
    node_count int
    The number of nodes of this type in the cluster.
    node_type_id str
    The identifier for this object. Format specified above.
    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.
    nodeCount Number
    The number of nodes of this type in the cluster.
    nodeTypeId String
    The identifier for this object. Format specified above.
    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.

    Import

    Cluster can be imported using any of these accepted formats:

    • {{parent}}/clusters/{{name}}

    When using the pulumi import command, Cluster can be imported using one of the formats above. For example:

    $ pulumi import gcp:vmwareengine/cluster:Cluster default {{parent}}/clusters/{{name}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.27.0 published on Thursday, Jun 13, 2024 by Pulumi