Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. vmwareengine
  5. vmwareengine/v1
  6. getCluster

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.vmwareengine/v1.getCluster

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Retrieves a Cluster resource by its resource name.

    Using getCluster

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

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

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

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

    fn::invoke:
  function: google-native:vmwareengine/v1:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    Location string
    PrivateCloudId string
    Project string
    ClusterId string
    Location string
    PrivateCloudId string
    Project string
    clusterId String
    location String
    privateCloudId String
    project String
    clusterId string
    location string
    privateCloudId string
    project string
    clusterId String
    location String
    privateCloudId String
    project String

    getCluster Result

    The following output properties are available:

    CreateTime string
    Creation time of this 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 resource name of this cluster. 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-central1-a/privateClouds/my-cloud/clusters/my-cluster
    NodeTypeConfigs Dictionary<string, string>
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
    State string
    State of the resource.
    StretchedClusterConfig Pulumi.GoogleNative.VMwareEngine.V1.Outputs.StretchedClusterConfigResponse
    Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud.
    Uid string
    System-generated unique identifier for the resource.
    UpdateTime string
    Last update time of this resource.
    CreateTime string
    Creation time of this 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 resource name of this cluster. 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-central1-a/privateClouds/my-cloud/clusters/my-cluster
    NodeTypeConfigs map[string]string
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
    State string
    State of the resource.
    StretchedClusterConfig StretchedClusterConfigResponse
    Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud.
    Uid string
    System-generated unique identifier for the resource.
    UpdateTime string
    Last update time of this resource.
    createTime String
    Creation time of this 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 resource name of this cluster. 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-central1-a/privateClouds/my-cloud/clusters/my-cluster
    nodeTypeConfigs Map<String,String>
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
    state String
    State of the resource.
    stretchedClusterConfig StretchedClusterConfigResponse
    Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud.
    uid String
    System-generated unique identifier for the resource.
    updateTime String
    Last update time of this resource.
    createTime string
    Creation time of this 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 resource name of this cluster. 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-central1-a/privateClouds/my-cloud/clusters/my-cluster
    nodeTypeConfigs {[key: string]: string}
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
    state string
    State of the resource.
    stretchedClusterConfig StretchedClusterConfigResponse
    Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud.
    uid string
    System-generated unique identifier for the resource.
    updateTime string
    Last update time of this resource.
    create_time str
    Creation time of this 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 resource name of this cluster. 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-central1-a/privateClouds/my-cloud/clusters/my-cluster
    node_type_configs Mapping[str, str]
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
    state str
    State of the resource.
    stretched_cluster_config StretchedClusterConfigResponse
    Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud.
    uid str
    System-generated unique identifier for the resource.
    update_time str
    Last update time of this resource.
    createTime String
    Creation time of this 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 resource name of this cluster. 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-central1-a/privateClouds/my-cloud/clusters/my-cluster
    nodeTypeConfigs Map<String>
    The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
    state String
    State of the resource.
    stretchedClusterConfig Property Map
    Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud.
    uid String
    System-generated unique identifier for the resource.
    updateTime String
    Last update time of this resource.

    Supporting Types

    StretchedClusterConfigResponse

    PreferredLocation string
    Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-a where {project} can either be a project number or a project ID.
    SecondaryLocation string
    Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-b where {project} can either be a project number or a project ID.
    PreferredLocation string
    Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-a where {project} can either be a project number or a project ID.
    SecondaryLocation string
    Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-b where {project} can either be a project number or a project ID.
    preferredLocation String
    Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-a where {project} can either be a project number or a project ID.
    secondaryLocation String
    Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-b where {project} can either be a project number or a project ID.
    preferredLocation string
    Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-a where {project} can either be a project number or a project ID.
    secondaryLocation string
    Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-b where {project} can either be a project number or a project ID.
    preferred_location str
    Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-a where {project} can either be a project number or a project ID.
    secondary_location str
    Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-b where {project} can either be a project number or a project ID.
    preferredLocation String
    Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-a where {project} can either be a project number or a project ID.
    secondaryLocation String
    Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: projects/{project}/locations/europe-west3-b where {project} can either be a project number or a project ID.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native