Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. workstations
  5. workstations/v1beta
  6. getWorkstationCluster

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.workstations/v1beta.getWorkstationCluster

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

    Returns the requested workstation cluster.

    Using getWorkstationCluster

    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 getWorkstationCluster(args: GetWorkstationClusterArgs, opts?: InvokeOptions): Promise<GetWorkstationClusterResult>
function getWorkstationClusterOutput(args: GetWorkstationClusterOutputArgs, opts?: InvokeOptions): Output<GetWorkstationClusterResult>
    def get_workstation_cluster(location: Optional[str] = None,
                            project: Optional[str] = None,
                            workstation_cluster_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetWorkstationClusterResult
def get_workstation_cluster_output(location: Optional[pulumi.Input[str]] = None,
                            project: Optional[pulumi.Input[str]] = None,
                            workstation_cluster_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetWorkstationClusterResult]
    func LookupWorkstationCluster(ctx *Context, args *LookupWorkstationClusterArgs, opts ...InvokeOption) (*LookupWorkstationClusterResult, error)
func LookupWorkstationClusterOutput(ctx *Context, args *LookupWorkstationClusterOutputArgs, opts ...InvokeOption) LookupWorkstationClusterResultOutput

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

    public static class GetWorkstationCluster 
{
    public static Task<GetWorkstationClusterResult> InvokeAsync(GetWorkstationClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkstationClusterResult> Invoke(GetWorkstationClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkstationClusterResult> getWorkstationCluster(GetWorkstationClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:workstations/v1beta:getWorkstationCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getWorkstationCluster Result

    The following output properties are available:

    Annotations Dictionary<string, string>
    Optional. Client-specified annotations.
    Conditions List<Pulumi.GoogleNative.Workstations.V1Beta.Outputs.StatusResponse>
    Status conditions describing the workstation cluster's current state.
    ControlPlaneIp string
    The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.
    CreateTime string
    Time when this workstation cluster was created.
    Degraded bool
    Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
    DeleteTime string
    Time when this workstation cluster was soft-deleted.
    DisplayName string
    Optional. Human-readable name for this workstation cluster.
    DomainConfig Pulumi.GoogleNative.Workstations.V1Beta.Outputs.DomainConfigResponse
    Optional. Configuration options for a custom domain.
    Etag string
    Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
    Labels Dictionary<string, string>
    Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
    Name string
    Identifier. Full name of this workstation cluster.
    Network string
    Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
    PrivateClusterConfig Pulumi.GoogleNative.Workstations.V1Beta.Outputs.PrivateClusterConfigResponse
    Optional. Configuration for private workstation cluster.
    Reconciling bool
    Indicates whether this workstation cluster is currently being updated to match its intended state.
    Subnetwork string
    Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
    Uid string
    A system-assigned unique identifier for this workstation cluster.
    UpdateTime string
    Time when this workstation cluster was most recently updated.
    Annotations map[string]string
    Optional. Client-specified annotations.
    Conditions []StatusResponse
    Status conditions describing the workstation cluster's current state.
    ControlPlaneIp string
    The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.
    CreateTime string
    Time when this workstation cluster was created.
    Degraded bool
    Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
    DeleteTime string
    Time when this workstation cluster was soft-deleted.
    DisplayName string
    Optional. Human-readable name for this workstation cluster.
    DomainConfig DomainConfigResponse
    Optional. Configuration options for a custom domain.
    Etag string
    Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
    Labels map[string]string
    Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
    Name string
    Identifier. Full name of this workstation cluster.
    Network string
    Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
    PrivateClusterConfig PrivateClusterConfigResponse
    Optional. Configuration for private workstation cluster.
    Reconciling bool
    Indicates whether this workstation cluster is currently being updated to match its intended state.
    Subnetwork string
    Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
    Uid string
    A system-assigned unique identifier for this workstation cluster.
    UpdateTime string
    Time when this workstation cluster was most recently updated.
    annotations Map<String,String>
    Optional. Client-specified annotations.
    conditions List<StatusResponse>
    Status conditions describing the workstation cluster's current state.
    controlPlaneIp String
    The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.
    createTime String
    Time when this workstation cluster was created.
    degraded Boolean
    Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
    deleteTime String
    Time when this workstation cluster was soft-deleted.
    displayName String
    Optional. Human-readable name for this workstation cluster.
    domainConfig DomainConfigResponse
    Optional. Configuration options for a custom domain.
    etag String
    Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
    labels Map<String,String>
    Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
    name String
    Identifier. Full name of this workstation cluster.
    network String
    Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
    privateClusterConfig PrivateClusterConfigResponse
    Optional. Configuration for private workstation cluster.
    reconciling Boolean
    Indicates whether this workstation cluster is currently being updated to match its intended state.
    subnetwork String
    Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
    uid String
    A system-assigned unique identifier for this workstation cluster.
    updateTime String
    Time when this workstation cluster was most recently updated.
    annotations {[key: string]: string}
    Optional. Client-specified annotations.
    conditions StatusResponse[]
    Status conditions describing the workstation cluster's current state.
    controlPlaneIp string
    The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.
    createTime string
    Time when this workstation cluster was created.
    degraded boolean
    Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
    deleteTime string
    Time when this workstation cluster was soft-deleted.
    displayName string
    Optional. Human-readable name for this workstation cluster.
    domainConfig DomainConfigResponse
    Optional. Configuration options for a custom domain.
    etag string
    Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
    labels {[key: string]: string}
    Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
    name string
    Identifier. Full name of this workstation cluster.
    network string
    Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
    privateClusterConfig PrivateClusterConfigResponse
    Optional. Configuration for private workstation cluster.
    reconciling boolean
    Indicates whether this workstation cluster is currently being updated to match its intended state.
    subnetwork string
    Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
    uid string
    A system-assigned unique identifier for this workstation cluster.
    updateTime string
    Time when this workstation cluster was most recently updated.
    annotations Mapping[str, str]
    Optional. Client-specified annotations.
    conditions Sequence[StatusResponse]
    Status conditions describing the workstation cluster's current state.
    control_plane_ip str
    The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.
    create_time str
    Time when this workstation cluster was created.
    degraded bool
    Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
    delete_time str
    Time when this workstation cluster was soft-deleted.
    display_name str
    Optional. Human-readable name for this workstation cluster.
    domain_config DomainConfigResponse
    Optional. Configuration options for a custom domain.
    etag str
    Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
    labels Mapping[str, str]
    Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
    name str
    Identifier. Full name of this workstation cluster.
    network str
    Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
    private_cluster_config PrivateClusterConfigResponse
    Optional. Configuration for private workstation cluster.
    reconciling bool
    Indicates whether this workstation cluster is currently being updated to match its intended state.
    subnetwork str
    Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
    uid str
    A system-assigned unique identifier for this workstation cluster.
    update_time str
    Time when this workstation cluster was most recently updated.
    annotations Map<String>
    Optional. Client-specified annotations.
    conditions List<Property Map>
    Status conditions describing the workstation cluster's current state.
    controlPlaneIp String
    The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.
    createTime String
    Time when this workstation cluster was created.
    degraded Boolean
    Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
    deleteTime String
    Time when this workstation cluster was soft-deleted.
    displayName String
    Optional. Human-readable name for this workstation cluster.
    domainConfig Property Map
    Optional. Configuration options for a custom domain.
    etag String
    Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
    labels Map<String>
    Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
    name String
    Identifier. Full name of this workstation cluster.
    network String
    Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
    privateClusterConfig Property Map
    Optional. Configuration for private workstation cluster.
    reconciling Boolean
    Indicates whether this workstation cluster is currently being updated to match its intended state.
    subnetwork String
    Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
    uid String
    A system-assigned unique identifier for this workstation cluster.
    updateTime String
    Time when this workstation cluster was most recently updated.

    Supporting Types

    DomainConfigResponse

    Domain string
    Immutable. Domain used by Workstations for HTTP ingress.
    Domain string
    Immutable. Domain used by Workstations for HTTP ingress.
    domain String
    Immutable. Domain used by Workstations for HTTP ingress.
    domain string
    Immutable. Domain used by Workstations for HTTP ingress.
    domain str
    Immutable. Domain used by Workstations for HTTP ingress.
    domain String
    Immutable. Domain used by Workstations for HTTP ingress.

    PrivateClusterConfigResponse

    AllowedProjects List<string>
    Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
    ClusterHostname string
    Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
    EnablePrivateEndpoint bool
    Immutable. Whether Workstations endpoint is private.
    ServiceAttachmentUri string
    Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using Private Service Connect.
    AllowedProjects []string
    Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
    ClusterHostname string
    Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
    EnablePrivateEndpoint bool
    Immutable. Whether Workstations endpoint is private.
    ServiceAttachmentUri string
    Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using Private Service Connect.
    allowedProjects List<String>
    Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
    clusterHostname String
    Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
    enablePrivateEndpoint Boolean
    Immutable. Whether Workstations endpoint is private.
    serviceAttachmentUri String
    Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using Private Service Connect.
    allowedProjects string[]
    Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
    clusterHostname string
    Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
    enablePrivateEndpoint boolean
    Immutable. Whether Workstations endpoint is private.
    serviceAttachmentUri string
    Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using Private Service Connect.
    allowed_projects Sequence[str]
    Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
    cluster_hostname str
    Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
    enable_private_endpoint bool
    Immutable. Whether Workstations endpoint is private.
    service_attachment_uri str
    Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using Private Service Connect.
    allowedProjects List<String>
    Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
    clusterHostname String
    Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
    enablePrivateEndpoint Boolean
    Immutable. Whether Workstations endpoint is private.
    serviceAttachmentUri String
    Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using Private Service Connect.

    StatusResponse

    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details List<ImmutableDictionary<string, string>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details []map[string]string
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Integer
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String,String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code number
    The status code, which should be an enum value of google.rpc.Code.
    details {[key: string]: string}[]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code int
    The status code, which should be an enum value of google.rpc.Code.
    details Sequence[Mapping[str, str]]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message str
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Number
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

    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