Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. vmwareengine
  5. getPrivateCloud
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.vmwareengine.getPrivateCloud

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-gcp

    Use this data source to get details about a private cloud resource.

    To get more information about private cloud, see:

    Example Usage

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

const myPc = gcp.vmwareengine.getPrivateCloud({
    name: "my-pc",
    location: "us-central1-a",
});

    import pulumi
import pulumi_gcp as gcp

my_pc = gcp.vmwareengine.get_private_cloud(name="my-pc",
    location="us-central1-a")

    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.LookupPrivateCloud(ctx, &vmwareengine.LookupPrivateCloudArgs{
			Name:     "my-pc",
			Location: "us-central1-a",
		}, 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 myPc = Gcp.VMwareEngine.GetPrivateCloud.Invoke(new()
    {
        Name = "my-pc",
        Location = "us-central1-a",
    });

});

    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.GetPrivateCloudArgs;
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 myPc = VmwareengineFunctions.getPrivateCloud(GetPrivateCloudArgs.builder()
            .name("my-pc")
            .location("us-central1-a")
            .build());

    }
}

    variables:
  myPc:
    fn::invoke:
      Function: gcp:vmwareengine:getPrivateCloud
      Arguments:
        name: my-pc
        location: us-central1-a

    Using getPrivateCloud

    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 getPrivateCloud(args: GetPrivateCloudArgs, opts?: InvokeOptions): Promise<GetPrivateCloudResult>
function getPrivateCloudOutput(args: GetPrivateCloudOutputArgs, opts?: InvokeOptions): Output<GetPrivateCloudResult>
    def get_private_cloud(location: Optional[str] = None,
                      name: Optional[str] = None,
                      project: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetPrivateCloudResult
def get_private_cloud_output(location: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      project: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetPrivateCloudResult]
    func LookupPrivateCloud(ctx *Context, args *LookupPrivateCloudArgs, opts ...InvokeOption) (*LookupPrivateCloudResult, error)
func LookupPrivateCloudOutput(ctx *Context, args *LookupPrivateCloudOutputArgs, opts ...InvokeOption) LookupPrivateCloudResultOutput

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

    public static class GetPrivateCloud 
{
    public static Task<GetPrivateCloudResult> InvokeAsync(GetPrivateCloudArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateCloudResult> Invoke(GetPrivateCloudInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrivateCloudResult> getPrivateCloud(GetPrivateCloudArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Location string
    Location of the resource.

    Name string
    Name of the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Location string
    Location of the resource.

    Name string
    Name of the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    Location of the resource.

    name String
    Name of the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location string
    Location of the resource.

    name string
    Name of the resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location str
    Location of the resource.

    name str
    Name of the resource.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    Location of the resource.

    name String
    Name of the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    getPrivateCloud Result

    The following output properties are available:

    Supporting Types

    GetPrivateCloudHcx

    Fqdn string
    Fully qualified domain name of the appliance.
    InternalIp string
    Internal IP address of the appliance.
    State string
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    Version string
    Version of the appliance.
    Fqdn string
    Fully qualified domain name of the appliance.
    InternalIp string
    Internal IP address of the appliance.
    State string
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    Version string
    Version of the appliance.
    fqdn String
    Fully qualified domain name of the appliance.
    internalIp String
    Internal IP address of the appliance.
    state String
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version String
    Version of the appliance.
    fqdn string
    Fully qualified domain name of the appliance.
    internalIp string
    Internal IP address of the appliance.
    state string
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version string
    Version of the appliance.
    fqdn str
    Fully qualified domain name of the appliance.
    internal_ip str
    Internal IP address of the appliance.
    state str
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version str
    Version of the appliance.
    fqdn String
    Fully qualified domain name of the appliance.
    internalIp String
    Internal IP address of the appliance.
    state String
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version String
    Version of the appliance.

    GetPrivateCloudManagementCluster

    ClusterId string
    The user-provided identifier of the new Cluster. The identifier 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 (https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
    NodeTypeConfigs List<GetPrivateCloudManagementClusterNodeTypeConfig>
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
    StretchedClusterConfigs List<GetPrivateCloudManagementClusterStretchedClusterConfig>
    The stretched cluster configuration for the private cloud.
    ClusterId string
    The user-provided identifier of the new Cluster. The identifier 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 (https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
    NodeTypeConfigs []GetPrivateCloudManagementClusterNodeTypeConfig
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
    StretchedClusterConfigs []GetPrivateCloudManagementClusterStretchedClusterConfig
    The stretched cluster configuration for the private cloud.
    clusterId String
    The user-provided identifier of the new Cluster. The identifier 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 (https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
    nodeTypeConfigs List<GetPrivateCloudManagementClusterNodeTypeConfig>
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
    stretchedClusterConfigs List<GetPrivateCloudManagementClusterStretchedClusterConfig>
    The stretched cluster configuration for the private cloud.
    clusterId string
    The user-provided identifier of the new Cluster. The identifier 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 (https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
    nodeTypeConfigs GetPrivateCloudManagementClusterNodeTypeConfig[]
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
    stretchedClusterConfigs GetPrivateCloudManagementClusterStretchedClusterConfig[]
    The stretched cluster configuration for the private cloud.
    cluster_id str
    The user-provided identifier of the new Cluster. The identifier 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 (https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
    node_type_configs Sequence[GetPrivateCloudManagementClusterNodeTypeConfig]
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
    stretched_cluster_configs Sequence[GetPrivateCloudManagementClusterStretchedClusterConfig]
    The stretched cluster configuration for the private cloud.
    clusterId String
    The user-provided identifier of the new Cluster. The identifier 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 (https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
    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).
    stretchedClusterConfigs List<Property Map>
    The stretched cluster configuration for the private cloud.

    GetPrivateCloudManagementClusterNodeTypeConfig

    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. This cannot be changed once the PrivateCloud is created.
    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. This cannot be changed once the PrivateCloud is created.
    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. This cannot be changed once the PrivateCloud is created.
    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. This cannot be changed once the PrivateCloud is created.
    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. This cannot be changed once the PrivateCloud is created.
    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. This cannot be changed once the PrivateCloud is created.
    nodeCount Number
    The number of nodes of this type in the cluster.
    nodeTypeId String

    GetPrivateCloudManagementClusterStretchedClusterConfig

    PreferredLocation string
    Zone that will remain operational when connection between the two zones is lost.
    SecondaryLocation string
    Additional zone for a higher level of availability and load balancing.
    PreferredLocation string
    Zone that will remain operational when connection between the two zones is lost.
    SecondaryLocation string
    Additional zone for a higher level of availability and load balancing.
    preferredLocation String
    Zone that will remain operational when connection between the two zones is lost.
    secondaryLocation String
    Additional zone for a higher level of availability and load balancing.
    preferredLocation string
    Zone that will remain operational when connection between the two zones is lost.
    secondaryLocation string
    Additional zone for a higher level of availability and load balancing.
    preferred_location str
    Zone that will remain operational when connection between the two zones is lost.
    secondary_location str
    Additional zone for a higher level of availability and load balancing.
    preferredLocation String
    Zone that will remain operational when connection between the two zones is lost.
    secondaryLocation String
    Additional zone for a higher level of availability and load balancing.

    GetPrivateCloudNetworkConfig

    DnsServerIp string
    DNS Server IP of the Private Cloud.
    ManagementCidr string
    Management CIDR used by VMware management appliances.
    ManagementIpAddressLayoutVersion int
    The IP address layout version of the management IP address range. Possible versions include:

    • managementIpAddressLayoutVersion=1: Indicates the legacy IP address layout used by some existing private clouds. This is no longer supported for new private clouds as it does not support all features.
    • managementIpAddressLayoutVersion=2: Indicates the latest IP address layout used by all newly created private clouds. This version supports all current features.
    VmwareEngineNetwork string
    The relative resource name of the VMware Engine network attached to the private cloud. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    VmwareEngineNetworkCanonical string
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    DnsServerIp string
    DNS Server IP of the Private Cloud.
    ManagementCidr string
    Management CIDR used by VMware management appliances.
    ManagementIpAddressLayoutVersion int
    The IP address layout version of the management IP address range. Possible versions include:

    • managementIpAddressLayoutVersion=1: Indicates the legacy IP address layout used by some existing private clouds. This is no longer supported for new private clouds as it does not support all features.
    • managementIpAddressLayoutVersion=2: Indicates the latest IP address layout used by all newly created private clouds. This version supports all current features.
    VmwareEngineNetwork string
    The relative resource name of the VMware Engine network attached to the private cloud. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    VmwareEngineNetworkCanonical string
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    dnsServerIp String
    DNS Server IP of the Private Cloud.
    managementCidr String
    Management CIDR used by VMware management appliances.
    managementIpAddressLayoutVersion Integer
    The IP address layout version of the management IP address range. Possible versions include:

    • managementIpAddressLayoutVersion=1: Indicates the legacy IP address layout used by some existing private clouds. This is no longer supported for new private clouds as it does not support all features.
    • managementIpAddressLayoutVersion=2: Indicates the latest IP address layout used by all newly created private clouds. This version supports all current features.
    vmwareEngineNetwork String
    The relative resource name of the VMware Engine network attached to the private cloud. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    vmwareEngineNetworkCanonical String
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    dnsServerIp string
    DNS Server IP of the Private Cloud.
    managementCidr string
    Management CIDR used by VMware management appliances.
    managementIpAddressLayoutVersion number
    The IP address layout version of the management IP address range. Possible versions include:

    • managementIpAddressLayoutVersion=1: Indicates the legacy IP address layout used by some existing private clouds. This is no longer supported for new private clouds as it does not support all features.
    • managementIpAddressLayoutVersion=2: Indicates the latest IP address layout used by all newly created private clouds. This version supports all current features.
    vmwareEngineNetwork string
    The relative resource name of the VMware Engine network attached to the private cloud. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    vmwareEngineNetworkCanonical string
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    dns_server_ip str
    DNS Server IP of the Private Cloud.
    management_cidr str
    Management CIDR used by VMware management appliances.
    management_ip_address_layout_version int
    The IP address layout version of the management IP address range. Possible versions include:

    • managementIpAddressLayoutVersion=1: Indicates the legacy IP address layout used by some existing private clouds. This is no longer supported for new private clouds as it does not support all features.
    • managementIpAddressLayoutVersion=2: Indicates the latest IP address layout used by all newly created private clouds. This version supports all current features.
    vmware_engine_network str
    The relative resource name of the VMware Engine network attached to the private cloud. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    vmware_engine_network_canonical str
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    dnsServerIp String
    DNS Server IP of the Private Cloud.
    managementCidr String
    Management CIDR used by VMware management appliances.
    managementIpAddressLayoutVersion Number
    The IP address layout version of the management IP address range. Possible versions include:

    • managementIpAddressLayoutVersion=1: Indicates the legacy IP address layout used by some existing private clouds. This is no longer supported for new private clouds as it does not support all features.
    • managementIpAddressLayoutVersion=2: Indicates the latest IP address layout used by all newly created private clouds. This version supports all current features.
    vmwareEngineNetwork String
    The relative resource name of the VMware Engine network attached to the private cloud. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    vmwareEngineNetworkCanonical String
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}

    GetPrivateCloudNsx

    Fqdn string
    Fully qualified domain name of the appliance.
    InternalIp string
    Internal IP address of the appliance.
    State string
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    Version string
    Version of the appliance.
    Fqdn string
    Fully qualified domain name of the appliance.
    InternalIp string
    Internal IP address of the appliance.
    State string
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    Version string
    Version of the appliance.
    fqdn String
    Fully qualified domain name of the appliance.
    internalIp String
    Internal IP address of the appliance.
    state String
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version String
    Version of the appliance.
    fqdn string
    Fully qualified domain name of the appliance.
    internalIp string
    Internal IP address of the appliance.
    state string
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version string
    Version of the appliance.
    fqdn str
    Fully qualified domain name of the appliance.
    internal_ip str
    Internal IP address of the appliance.
    state str
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version str
    Version of the appliance.
    fqdn String
    Fully qualified domain name of the appliance.
    internalIp String
    Internal IP address of the appliance.
    state String
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version String
    Version of the appliance.

    GetPrivateCloudVcenter

    Fqdn string
    Fully qualified domain name of the appliance.
    InternalIp string
    Internal IP address of the appliance.
    State string
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    Version string
    Version of the appliance.
    Fqdn string
    Fully qualified domain name of the appliance.
    InternalIp string
    Internal IP address of the appliance.
    State string
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    Version string
    Version of the appliance.
    fqdn String
    Fully qualified domain name of the appliance.
    internalIp String
    Internal IP address of the appliance.
    state String
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version String
    Version of the appliance.
    fqdn string
    Fully qualified domain name of the appliance.
    internalIp string
    Internal IP address of the appliance.
    state string
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version string
    Version of the appliance.
    fqdn str
    Fully qualified domain name of the appliance.
    internal_ip str
    Internal IP address of the appliance.
    state str
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version str
    Version of the appliance.
    fqdn String
    Fully qualified domain name of the appliance.
    internalIp String
    Internal IP address of the appliance.
    state String
    State of the appliance. Possible values: ["ACTIVE", "CREATING"]
    version String
    Version of the appliance.

    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.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-gcp