Class: Aws::WorkSpaces::Types::WorkspaceRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::WorkSpaces::Types::WorkspaceRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-workspaces/types.rb
Overview
When making an API call, you may pass WorkspaceRequest data as a hash:
{
directory_id: "DirectoryId", # required
user_name: "UserName", # required
bundle_id: "BundleId", # required
volume_encryption_key: "VolumeEncryptionKey",
user_volume_encryption_enabled: false,
root_volume_encryption_enabled: false,
workspace_properties: {
running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
running_mode_auto_stop_timeout_in_minutes: 1,
root_volume_size_gib: 1,
user_volume_size_gib: 1,
compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO
},
tags: [
{
key: "TagKey", # required
value: "TagValue",
},
],
}
Describes the information used to create a WorkSpace.
Instance Attribute Summary collapse
-
#bundle_id ⇒ String
The identifier of the bundle for the WorkSpace.
-
#directory_id ⇒ String
The identifier of the AWS Directory Service directory 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 username 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 KMS key used to encrypt data stored on your 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.
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'lib/aws-sdk-workspaces/types.rb', line 2007 class WorkspaceRequest < Struct.new( :directory_id, :user_name, :bundle_id, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_properties, :tags) include Aws::Structure end |
#directory_id ⇒ String
The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'lib/aws-sdk-workspaces/types.rb', line 2007 class WorkspaceRequest < Struct.new( :directory_id, :user_name, :bundle_id, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_properties, :tags) include Aws::Structure end |
#root_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the root volume is encrypted.
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'lib/aws-sdk-workspaces/types.rb', line 2007 class WorkspaceRequest < Struct.new( :directory_id, :user_name, :bundle_id, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_properties, :tags) include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
The tags for the WorkSpace.
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'lib/aws-sdk-workspaces/types.rb', line 2007 class WorkspaceRequest < Struct.new( :directory_id, :user_name, :bundle_id, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_properties, :tags) include Aws::Structure end |
#user_name ⇒ String
The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'lib/aws-sdk-workspaces/types.rb', line 2007 class WorkspaceRequest < Struct.new( :directory_id, :user_name, :bundle_id, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_properties, :tags) include Aws::Structure end |
#user_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the user volume is encrypted.
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'lib/aws-sdk-workspaces/types.rb', line 2007 class WorkspaceRequest < Struct.new( :directory_id, :user_name, :bundle_id, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_properties, :tags) include Aws::Structure end |
#volume_encryption_key ⇒ String
The KMS key used to encrypt data stored on your WorkSpace.
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'lib/aws-sdk-workspaces/types.rb', line 2007 class WorkspaceRequest < Struct.new( :directory_id, :user_name, :bundle_id, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_properties, :tags) include Aws::Structure end |
#workspace_properties ⇒ Types::WorkspaceProperties
The WorkSpace properties.
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'lib/aws-sdk-workspaces/types.rb', line 2007 class WorkspaceRequest < Struct.new( :directory_id, :user_name, :bundle_id, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_properties, :tags) include Aws::Structure end |