aws-native.workspaces.getWorkspace

AWS Cloud Control v1.54.0, Feb 16 26

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.54.0 published on Monday, Feb 16, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.54.0 published on Monday, Feb 16, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Using getWorkspace

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 getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>

def get_workspace(workspace_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(workspace_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]

func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput

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

public static class GetWorkspace 
{
    public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:workspaces:getWorkspace
  arguments:
    # arguments dictionary

The following arguments are supported:

WorkspaceId string

WorkspaceId string

workspaceId String

workspaceId string

workspace_id str

workspaceId String

getWorkspace Result

The following output properties are available:

BundleId string: The identifier of the bundle for the WorkSpace.
Id string: The identifier of the WorkSpace, returned as a string.
RootVolumeEncryptionEnabled bool: Indicates whether the data stored on the root volume is encrypted.
Tags List<Pulumi.AwsNative.Outputs.Tag>: The tags for the WorkSpace.
UserVolumeEncryptionEnabled bool: Indicates whether the data stored on the user volume is encrypted.
VolumeEncryptionKey string: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
WorkspaceId string
WorkspaceProperties Pulumi.AwsNative.WorkSpaces.Outputs.WorkspaceProperties: The WorkSpace properties.

BundleId string: The identifier of the bundle for the WorkSpace.
Id string: The identifier of the WorkSpace, returned as a string.
RootVolumeEncryptionEnabled bool: Indicates whether the data stored on the root volume is encrypted.
Tags Tag: The tags for the WorkSpace.
UserVolumeEncryptionEnabled bool: Indicates whether the data stored on the user volume is encrypted.
VolumeEncryptionKey string: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
WorkspaceId string
WorkspaceProperties WorkspaceProperties: The WorkSpace properties.

bundleId String: The identifier of the bundle for the WorkSpace.
id String: The identifier of the WorkSpace, returned as a string.
rootVolumeEncryptionEnabled Boolean: Indicates whether the data stored on the root volume is encrypted.
tags List<Tag>: The tags for the WorkSpace.
userVolumeEncryptionEnabled Boolean: Indicates whether the data stored on the user volume is encrypted.
volumeEncryptionKey String: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspaceId String
workspaceProperties WorkspaceProperties: The WorkSpace properties.

bundleId string: The identifier of the bundle for the WorkSpace.
id string: The identifier of the WorkSpace, returned as a string.
rootVolumeEncryptionEnabled boolean: Indicates whether the data stored on the root volume is encrypted.
tags Tag[]: The tags for the WorkSpace.
userVolumeEncryptionEnabled boolean: Indicates whether the data stored on the user volume is encrypted.
volumeEncryptionKey string: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspaceId string
workspaceProperties WorkspaceProperties: The WorkSpace properties.

bundle_id str: The identifier of the bundle for the WorkSpace.
id str: The identifier of the WorkSpace, returned as a string.
root_volume_encryption_enabled bool: Indicates whether the data stored on the root volume is encrypted.
tags Sequence[root_Tag]: The tags for the WorkSpace.
user_volume_encryption_enabled bool: Indicates whether the data stored on the user volume is encrypted.
volume_encryption_key str: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspace_id str
workspace_properties WorkspaceProperties: The WorkSpace properties.

bundleId String: The identifier of the bundle for the WorkSpace.
id String: The identifier of the WorkSpace, returned as a string.
rootVolumeEncryptionEnabled Boolean: Indicates whether the data stored on the root volume is encrypted.
tags List<Property Map>: The tags for the WorkSpace.
userVolumeEncryptionEnabled Boolean: Indicates whether the data stored on the user volume is encrypted.
volumeEncryptionKey String: The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspaceId String
workspaceProperties Property Map: The WorkSpace properties.

Supporting Types

WorkspaceProperties

ComputeTypeName string: The compute type. For more information, see Amazon WorkSpaces Bundles .
RootVolumeSizeGib int: The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .
RunningMode string: The running mode. For more information, see Manage the WorkSpace Running Mode .
RunningModeAutoStopTimeoutInMinutes int: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
UserVolumeSizeGib int: The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

ComputeTypeName string: The compute type. For more information, see Amazon WorkSpaces Bundles .
RootVolumeSizeGib int: The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .
RunningMode string: The running mode. For more information, see Manage the WorkSpace Running Mode .
RunningModeAutoStopTimeoutInMinutes int: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
UserVolumeSizeGib int: The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

computeTypeName String: The compute type. For more information, see Amazon WorkSpaces Bundles .
rootVolumeSizeGib Integer: The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .
runningMode String: The running mode. For more information, see Manage the WorkSpace Running Mode .
runningModeAutoStopTimeoutInMinutes Integer: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
userVolumeSizeGib Integer: The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

computeTypeName string: The compute type. For more information, see Amazon WorkSpaces Bundles .
rootVolumeSizeGib number: The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .
runningMode string: The running mode. For more information, see Manage the WorkSpace Running Mode .
runningModeAutoStopTimeoutInMinutes number: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
userVolumeSizeGib number: The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

compute_type_name str: The compute type. For more information, see Amazon WorkSpaces Bundles .
root_volume_size_gib int: The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .
running_mode str: The running mode. For more information, see Manage the WorkSpace Running Mode .
running_mode_auto_stop_timeout_in_minutes int: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
user_volume_size_gib int: The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

computeTypeName String: The compute type. For more information, see Amazon WorkSpaces Bundles .
rootVolumeSizeGib Number: The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .
runningMode String: The running mode. For more information, see Manage the WorkSpace Running Mode .
runningModeAutoStopTimeoutInMinutes Number: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
userVolumeSizeGib Number: The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .