pulumi-aws-kotlin/com.pulumi.aws.workspaces.kotlin/WorkspaceArgs

WorkspaceArgs

data class WorkspaceArgs(val bundleId: Output<String>? = null, val directoryId: Output<String>? = null, val rootVolumeEncryptionEnabled: Output<Boolean>? = null, val tags: Output<Map<String, String>>? = null, val userName: Output<String>? = null, val userVolumeEncryptionEnabled: Output<Boolean>? = null, val volumeEncryptionKey: Output<String>? = null, val workspaceProperties: Output<WorkspaceWorkspacePropertiesArgs>? = null) : ConvertibleToJava<WorkspaceArgs>

Provides a workspace in AWS Workspaces Service

NOTE: AWS WorkSpaces service requires workspaces_DefaultRole IAM role to operate normally.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const valueWindows10 = aws.workspaces.getBundle({
    bundleId: "wsb-bh8rsxt14",
});
const workspaces = aws.kms.getKey({
    keyId: "alias/aws/workspaces",
});
const example = new aws.workspaces.Workspace("example", {
    directoryId: exampleAwsWorkspacesDirectory.id,
    bundleId: valueWindows10.then(valueWindows10 => valueWindows10.id),
    userName: "john.doe",
    rootVolumeEncryptionEnabled: true,
    userVolumeEncryptionEnabled: true,
    volumeEncryptionKey: workspaces.then(workspaces => workspaces.arn),
    workspaceProperties: {
        computeTypeName: "VALUE",
        userVolumeSizeGib: 10,
        rootVolumeSizeGib: 80,
        runningMode: "AUTO_STOP",
        runningModeAutoStopTimeoutInMinutes: 60,
    },
    tags: {
        Department: "IT",
    },
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
value_windows10 = aws.workspaces.get_bundle(bundle_id="wsb-bh8rsxt14")
workspaces = aws.kms.get_key(key_id="alias/aws/workspaces")
example = aws.workspaces.Workspace("example",
    directory_id=example_aws_workspaces_directory["id"],
    bundle_id=value_windows10.id,
    user_name="john.doe",
    root_volume_encryption_enabled=True,
    user_volume_encryption_enabled=True,
    volume_encryption_key=workspaces.arn,
    workspace_properties=aws.workspaces.WorkspaceWorkspacePropertiesArgs(
        compute_type_name="VALUE",
        user_volume_size_gib=10,
        root_volume_size_gib=80,
        running_mode="AUTO_STOP",
        running_mode_auto_stop_timeout_in_minutes=60,
    ),
    tags={
        "Department": "IT",
    })
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var valueWindows10 = Aws.Workspaces.GetBundle.Invoke(new()
    {
        BundleId = "wsb-bh8rsxt14",
    });
    var workspaces = Aws.Kms.GetKey.Invoke(new()
    {
        KeyId = "alias/aws/workspaces",
    });
    var example = new Aws.Workspaces.Workspace("example", new()
    {
        DirectoryId = exampleAwsWorkspacesDirectory.Id,
        BundleId = valueWindows10.Apply(getBundleResult => getBundleResult.Id),
        UserName = "john.doe",
        RootVolumeEncryptionEnabled = true,
        UserVolumeEncryptionEnabled = true,
        VolumeEncryptionKey = workspaces.Apply(getKeyResult => getKeyResult.Arn),
        WorkspaceProperties = new Aws.Workspaces.Inputs.WorkspaceWorkspacePropertiesArgs
        {
            ComputeTypeName = "VALUE",
            UserVolumeSizeGib = 10,
            RootVolumeSizeGib = 80,
            RunningMode = "AUTO_STOP",
            RunningModeAutoStopTimeoutInMinutes = 60,
        },
        Tags =
        {
            { "Department", "IT" },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/workspaces"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		valueWindows10, err := workspaces.GetBundle(ctx, &workspaces.GetBundleArgs{
			BundleId: pulumi.StringRef("wsb-bh8rsxt14"),
		}, nil)
		if err != nil {
			return err
		}
		workspaces, err := kms.LookupKey(ctx, &kms.LookupKeyArgs{
			KeyId: "alias/aws/workspaces",
		}, nil)
		if err != nil {
			return err
		}
		_, err = workspaces.NewWorkspace(ctx, "example", &workspaces.WorkspaceArgs{
			DirectoryId:                 pulumi.Any(exampleAwsWorkspacesDirectory.Id),
			BundleId:                    pulumi.String(valueWindows10.Id),
			UserName:                    pulumi.String("john.doe"),
			RootVolumeEncryptionEnabled: pulumi.Bool(true),
			UserVolumeEncryptionEnabled: pulumi.Bool(true),
			VolumeEncryptionKey:         pulumi.String(workspaces.Arn),
			WorkspaceProperties: &workspaces.WorkspaceWorkspacePropertiesArgs{
				ComputeTypeName:                     pulumi.String("VALUE"),
				UserVolumeSizeGib:                   pulumi.Int(10),
				RootVolumeSizeGib:                   pulumi.Int(80),
				RunningMode:                         pulumi.String("AUTO_STOP"),
				RunningModeAutoStopTimeoutInMinutes: pulumi.Int(60),
			},
			Tags: pulumi.StringMap{
				"Department": pulumi.String("IT"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workspaces.WorkspacesFunctions;
import com.pulumi.aws.workspaces.inputs.GetBundleArgs;
import com.pulumi.aws.kms.KmsFunctions;
import com.pulumi.aws.kms.inputs.GetKeyArgs;
import com.pulumi.aws.workspaces.Workspace;
import com.pulumi.aws.workspaces.WorkspaceArgs;
import com.pulumi.aws.workspaces.inputs.WorkspaceWorkspacePropertiesArgs;
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 valueWindows10 = WorkspacesFunctions.getBundle(GetBundleArgs.builder()
            .bundleId("wsb-bh8rsxt14")
            .build());
        final var workspaces = KmsFunctions.getKey(GetKeyArgs.builder()
            .keyId("alias/aws/workspaces")
            .build());
        var example = new Workspace("example", WorkspaceArgs.builder()
            .directoryId(exampleAwsWorkspacesDirectory.id())
            .bundleId(valueWindows10.applyValue(getBundleResult -> getBundleResult.id()))
            .userName("john.doe")
            .rootVolumeEncryptionEnabled(true)
            .userVolumeEncryptionEnabled(true)
            .volumeEncryptionKey(workspaces.applyValue(getKeyResult -> getKeyResult.arn()))
            .workspaceProperties(WorkspaceWorkspacePropertiesArgs.builder()
                .computeTypeName("VALUE")
                .userVolumeSizeGib(10)
                .rootVolumeSizeGib(80)
                .runningMode("AUTO_STOP")
                .runningModeAutoStopTimeoutInMinutes(60)
                .build())
            .tags(Map.of("Department", "IT"))
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:workspaces:Workspace
    properties:
      directoryId: ${exampleAwsWorkspacesDirectory.id}
      bundleId: ${valueWindows10.id}
      userName: john.doe
      rootVolumeEncryptionEnabled: true
      userVolumeEncryptionEnabled: true
      volumeEncryptionKey: ${workspaces.arn}
      workspaceProperties:
        computeTypeName: VALUE
        userVolumeSizeGib: 10
        rootVolumeSizeGib: 80
        runningMode: AUTO_STOP
        runningModeAutoStopTimeoutInMinutes: 60
      tags:
        Department: IT
variables:
  valueWindows10:
    fn::invoke:
      Function: aws:workspaces:getBundle
      Arguments:
        bundleId: wsb-bh8rsxt14
  workspaces:
    fn::invoke:
      Function: aws:kms:getKey
      Arguments:
        keyId: alias/aws/workspaces
Content copied to clipboard

Import

Using pulumi import, import Workspaces using their ID. For example:

$ pulumi import aws:workspaces/workspace:Workspace example ws-9z9zmbkhv
Content copied to clipboard

Constructors

Link copied to clipboard
fun WorkspaceArgs(bundleId: Output<String>? = null, directoryId: Output<String>? = null, rootVolumeEncryptionEnabled: Output<Boolean>? = null, tags: Output<Map<String, String>>? = null, userName: Output<String>? = null, userVolumeEncryptionEnabled: Output<Boolean>? = null, volumeEncryptionKey: Output<String>? = null, workspaceProperties: Output<WorkspaceWorkspacePropertiesArgs>? = null)

Functions

Link copied to clipboard
open override fun toJava(): WorkspaceArgs

Properties

Link copied to clipboard
val bundleId: Output<String>? = null

The ID of the bundle for the WorkSpace.

Link copied to clipboard
val directoryId: Output<String>? = null

The ID of the directory for the WorkSpace.

Link copied to clipboard
val rootVolumeEncryptionEnabled: Output<Boolean>? = null

Indicates whether the data stored on the root volume is encrypted.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

The tags for the WorkSpace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val userName: Output<String>? = null

The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace.

Link copied to clipboard
val userVolumeEncryptionEnabled: Output<Boolean>? = null

Indicates whether the data stored on the user volume is encrypted.

Link copied to clipboard
val volumeEncryptionKey: Output<String>? = null

The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.

Link copied to clipboard
val workspaceProperties: Output<WorkspaceWorkspacePropertiesArgs>? = null

The WorkSpace properties.