Class: Aws::WorkSpaces::Types::WorkspaceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

Describes the information used to create a WorkSpace.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_id ⇒ String

The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

Returns:

  • (String) 


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6034

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#directory_id ⇒ String

The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

Returns:

  • (String) 


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6034

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#root_volume_encryption_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6034

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags for the WorkSpace.

Returns:



6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6034

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#user_name ⇒ String

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

The username is not case-sensitive, but we recommend matching the case in the Directory Service directory to avoid potential incompatibilities.

The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces.

Returns:

  • (String) 


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6034

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#user_volume_encryption_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6034

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#volume_encryption_key ⇒ String

The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

Returns:

  • (String) 


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6034

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_name ⇒ String

The name of the user-decoupled WorkSpace.

WorkspaceName is required if UserName is [UNDEFINED] for user-decoupled WorkSpaces. WorkspaceName is not applicable if UserName is specified for user-assigned WorkSpaces.

Returns:

  • (String) 


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6034

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_properties ⇒ Types::WorkspaceProperties

The WorkSpace properties.

Returns:



6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6034

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags,
  :workspace_name)
  SENSITIVE = []
  include Aws::Structure
end