Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. workstations
  5. workstations/v1
  6. Workstation

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/v1.Workstation

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

    Creates a new workstation.

    Create Workstation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Workstation(name: string, args: WorkstationArgs, opts?: CustomResourceOptions);
    @overload
def Workstation(resource_name: str,
                args: WorkstationArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Workstation(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                workstation_cluster_id: Optional[str] = None,
                workstation_config_id: Optional[str] = None,
                workstation_id: Optional[str] = None,
                annotations: Optional[Mapping[str, str]] = None,
                display_name: Optional[str] = None,
                env: Optional[Mapping[str, str]] = None,
                etag: Optional[str] = None,
                labels: Optional[Mapping[str, str]] = None,
                location: Optional[str] = None,
                name: Optional[str] = None,
                project: Optional[str] = None)
    func NewWorkstation(ctx *Context, name string, args WorkstationArgs, opts ...ResourceOption) (*Workstation, error)
    public Workstation(string name, WorkstationArgs args, CustomResourceOptions? opts = null)
    public Workstation(String name, WorkstationArgs args)
public Workstation(String name, WorkstationArgs args, CustomResourceOptions options)

    type: google-native:workstations/v1:Workstation
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 WorkstationArgs
    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 WorkstationArgs
    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 WorkstationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkstationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkstationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var workstationResource = new GoogleNative.Workstations.V1.Workstation("workstationResource", new()
{
    WorkstationClusterId = "string",
    WorkstationConfigId = "string",
    WorkstationId = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    Env = 
    {
        { "string", "string" },
    },
    Etag = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Name = "string",
    Project = "string",
});

    example, err := workstations.NewWorkstation(ctx, "workstationResource", &workstations.WorkstationArgs{
	WorkstationClusterId: pulumi.String("string"),
	WorkstationConfigId:  pulumi.String("string"),
	WorkstationId:        pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	Env: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Etag: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Project:  pulumi.String("string"),
})

    var workstationResource = new Workstation("workstationResource", WorkstationArgs.builder()
    .workstationClusterId("string")
    .workstationConfigId("string")
    .workstationId("string")
    .annotations(Map.of("string", "string"))
    .displayName("string")
    .env(Map.of("string", "string"))
    .etag("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .name("string")
    .project("string")
    .build());

    workstation_resource = google_native.workstations.v1.Workstation("workstationResource",
    workstation_cluster_id="string",
    workstation_config_id="string",
    workstation_id="string",
    annotations={
        "string": "string",
    },
    display_name="string",
    env={
        "string": "string",
    },
    etag="string",
    labels={
        "string": "string",
    },
    location="string",
    name="string",
    project="string")

    const workstationResource = new google_native.workstations.v1.Workstation("workstationResource", {
    workstationClusterId: "string",
    workstationConfigId: "string",
    workstationId: "string",
    annotations: {
        string: "string",
    },
    displayName: "string",
    env: {
        string: "string",
    },
    etag: "string",
    labels: {
        string: "string",
    },
    location: "string",
    name: "string",
    project: "string",
});

    type: google-native:workstations/v1:Workstation
properties:
    annotations:
        string: string
    displayName: string
    env:
        string: string
    etag: string
    labels:
        string: string
    location: string
    name: string
    project: string
    workstationClusterId: string
    workstationConfigId: string
    workstationId: string

    Workstation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Workstation resource accepts the following input properties:

    WorkstationClusterId string
    WorkstationConfigId string
    WorkstationId string
    Required. ID to use for the workstation.
    Annotations Dictionary<string, string>
    Optional. Client-specified annotations.
    DisplayName string
    Optional. Human-readable name for this workstation.
    Env Dictionary<string, string>
    Optional. Environment variables passed to the workstation container's entrypoint.
    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 and that are also propagated to the underlying Compute Engine resources.
    Location string
    Name string
    Identifier. Full name of this workstation.
    Project string
    WorkstationClusterId string
    WorkstationConfigId string
    WorkstationId string
    Required. ID to use for the workstation.
    Annotations map[string]string
    Optional. Client-specified annotations.
    DisplayName string
    Optional. Human-readable name for this workstation.
    Env map[string]string
    Optional. Environment variables passed to the workstation container's entrypoint.
    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 and that are also propagated to the underlying Compute Engine resources.
    Location string
    Name string
    Identifier. Full name of this workstation.
    Project string
    workstationClusterId String
    workstationConfigId String
    workstationId String
    Required. ID to use for the workstation.
    annotations Map<String,String>
    Optional. Client-specified annotations.
    displayName String
    Optional. Human-readable name for this workstation.
    env Map<String,String>
    Optional. Environment variables passed to the workstation container's entrypoint.
    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 and that are also propagated to the underlying Compute Engine resources.
    location String
    name String
    Identifier. Full name of this workstation.
    project String
    workstationClusterId string
    workstationConfigId string
    workstationId string
    Required. ID to use for the workstation.
    annotations {[key: string]: string}
    Optional. Client-specified annotations.
    displayName string
    Optional. Human-readable name for this workstation.
    env {[key: string]: string}
    Optional. Environment variables passed to the workstation container's entrypoint.
    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 and that are also propagated to the underlying Compute Engine resources.
    location string
    name string
    Identifier. Full name of this workstation.
    project string
    workstation_cluster_id str
    workstation_config_id str
    workstation_id str
    Required. ID to use for the workstation.
    annotations Mapping[str, str]
    Optional. Client-specified annotations.
    display_name str
    Optional. Human-readable name for this workstation.
    env Mapping[str, str]
    Optional. Environment variables passed to the workstation container's entrypoint.
    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 and that are also propagated to the underlying Compute Engine resources.
    location str
    name str
    Identifier. Full name of this workstation.
    project str
    workstationClusterId String
    workstationConfigId String
    workstationId String
    Required. ID to use for the workstation.
    annotations Map<String>
    Optional. Client-specified annotations.
    displayName String
    Optional. Human-readable name for this workstation.
    env Map<String>
    Optional. Environment variables passed to the workstation container's entrypoint.
    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 and that are also propagated to the underlying Compute Engine resources.
    location String
    name String
    Identifier. Full name of this workstation.
    project String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Workstation resource produces the following output properties:

    CreateTime string
    Time when this workstation was created.
    DeleteTime string
    Time when this workstation was soft-deleted.
    Host string
    Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.
    Id string
    The provider-assigned unique ID for this managed resource.
    Reconciling bool
    Indicates whether this workstation is currently being updated to match its intended state.
    StartTime string
    Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
    State string
    Current state of the workstation.
    Uid string
    A system-assigned unique identifier for this workstation.
    UpdateTime string
    Time when this workstation was most recently updated.
    CreateTime string
    Time when this workstation was created.
    DeleteTime string
    Time when this workstation was soft-deleted.
    Host string
    Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.
    Id string
    The provider-assigned unique ID for this managed resource.
    Reconciling bool
    Indicates whether this workstation is currently being updated to match its intended state.
    StartTime string
    Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
    State string
    Current state of the workstation.
    Uid string
    A system-assigned unique identifier for this workstation.
    UpdateTime string
    Time when this workstation was most recently updated.
    createTime String
    Time when this workstation was created.
    deleteTime String
    Time when this workstation was soft-deleted.
    host String
    Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.
    id String
    The provider-assigned unique ID for this managed resource.
    reconciling Boolean
    Indicates whether this workstation is currently being updated to match its intended state.
    startTime String
    Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
    state String
    Current state of the workstation.
    uid String
    A system-assigned unique identifier for this workstation.
    updateTime String
    Time when this workstation was most recently updated.
    createTime string
    Time when this workstation was created.
    deleteTime string
    Time when this workstation was soft-deleted.
    host string
    Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.
    id string
    The provider-assigned unique ID for this managed resource.
    reconciling boolean
    Indicates whether this workstation is currently being updated to match its intended state.
    startTime string
    Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
    state string
    Current state of the workstation.
    uid string
    A system-assigned unique identifier for this workstation.
    updateTime string
    Time when this workstation was most recently updated.
    create_time str
    Time when this workstation was created.
    delete_time str
    Time when this workstation was soft-deleted.
    host str
    Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.
    id str
    The provider-assigned unique ID for this managed resource.
    reconciling bool
    Indicates whether this workstation is currently being updated to match its intended state.
    start_time str
    Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
    state str
    Current state of the workstation.
    uid str
    A system-assigned unique identifier for this workstation.
    update_time str
    Time when this workstation was most recently updated.
    createTime String
    Time when this workstation was created.
    deleteTime String
    Time when this workstation was soft-deleted.
    host String
    Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.
    id String
    The provider-assigned unique ID for this managed resource.
    reconciling Boolean
    Indicates whether this workstation is currently being updated to match its intended state.
    startTime String
    Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
    state String
    Current state of the workstation.
    uid String
    A system-assigned unique identifier for this workstation.
    updateTime String
    Time when this workstation was most recently updated.

    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