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

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpaces::Types::WorkspaceRequest

Defined in:

gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

Describes the information used to create a WorkSpace.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bundle_id ⇒ String

  The identifier of the bundle for the WorkSpace.

• #directory_id ⇒ String

  The identifier of the Directory Service directory for the WorkSpace.

• #ipv_6_address ⇒ String

  The IPv6 address for the WorkSpace.

• #root_volume_encryption_enabled ⇒ Boolean

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

• #tags ⇒ Array<Types::Tag>

  The tags for the WorkSpace.

• #user_name ⇒ String

  The user name of the user for the WorkSpace.

• #user_volume_encryption_enabled ⇒ Boolean

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

• #volume_encryption_key ⇒ String

  The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.

• #workspace_name ⇒ String

  The name of the user-decoupled WorkSpace.

• #workspace_properties ⇒ Types::WorkspaceProperties

  The WorkSpace properties.

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)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6313

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,
  :ipv_6_address)
  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)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6313

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,
  :ipv_6_address)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_6_address ⇒ String

The IPv6 address for the WorkSpace.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6313

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,
  :ipv_6_address)
  SENSITIVE = []
  include Aws::Structure
end

#root_volume_encryption_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6313

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,
  :ipv_6_address)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags for the WorkSpace.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6313

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,
  :ipv_6_address)
  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)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6313

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,
  :ipv_6_address)
  SENSITIVE = []
  include Aws::Structure
end

#user_volume_encryption_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6313

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,
  :ipv_6_address)
  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)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6313

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,
  :ipv_6_address)
  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)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6313

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,
  :ipv_6_address)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_properties ⇒ Types::WorkspaceProperties

The WorkSpace properties.

Returns:

• (Types::WorkspaceProperties)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6313

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,
  :ipv_6_address)
  SENSITIVE = []
  include Aws::Structure
end