Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  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 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>
Copy
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]
Copy
func LookupWorkstationCluster(ctx *Context, args *LookupWorkstationClusterArgs, opts ...InvokeOption) (*LookupWorkstationClusterResult, error)
func LookupWorkstationClusterOutput(ctx *Context, args *LookupWorkstationClusterOutputArgs, opts ...InvokeOption) LookupWorkstationClusterResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetWorkstationClusterResult> getWorkstationCluster(GetWorkstationClusterArgs args, InvokeOptions options)
public static Output<GetWorkstationClusterResult> getWorkstationCluster(GetWorkstationClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:workstations/v1beta:getWorkstationCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
WorkstationClusterId This property is required. string
Project string
Location This property is required. string
WorkstationClusterId This property is required. string
Project string
location This property is required. String
workstationClusterId This property is required. String
project String
location This property is required. string
workstationClusterId This property is required. string
project string
location This property is required. str
workstation_cluster_id This property is required. str
project str
location This property is required. String
workstationClusterId This property is required. String
project String

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 This property is required. string
Immutable. Domain used by Workstations for HTTP ingress.
Domain This property is required. string
Immutable. Domain used by Workstations for HTTP ingress.
domain This property is required. String
Immutable. Domain used by Workstations for HTTP ingress.
domain This property is required. string
Immutable. Domain used by Workstations for HTTP ingress.
domain This property is required. str
Immutable. Domain used by Workstations for HTTP ingress.
domain This property is required. String
Immutable. Domain used by Workstations for HTTP ingress.

PrivateClusterConfigResponse

AllowedProjects This property is required. 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 This property is required. 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 This property is required. bool
Immutable. Whether Workstations endpoint is private.
ServiceAttachmentUri This property is required. 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 This property is required. []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 This property is required. 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 This property is required. bool
Immutable. Whether Workstations endpoint is private.
ServiceAttachmentUri This property is required. 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 This property is required. 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 This property is required. 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 This property is required. Boolean
Immutable. Whether Workstations endpoint is private.
serviceAttachmentUri This property is required. 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 This property is required. 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 This property is required. 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 This property is required. boolean
Immutable. Whether Workstations endpoint is private.
serviceAttachmentUri This property is required. 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 This property is required. 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 This property is required. 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 This property is required. bool
Immutable. Whether Workstations endpoint is private.
service_attachment_uri This property is required. 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 This property is required. 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 This property is required. 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 This property is required. Boolean
Immutable. Whether Workstations endpoint is private.
serviceAttachmentUri This property is required. 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 This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. 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 This property is required. 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 This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. []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 This property is required. 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 This property is required. Integer
The status code, which should be an enum value of google.rpc.Code.
details This property is required. 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 This property is required. 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 This property is required. number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. {[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 This property is required. 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 This property is required. int
The status code, which should be an enum value of google.rpc.Code.
details This property is required. 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 This property is required. 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 This property is required. Number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. 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 This property is required. 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 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