/AWS1/CL_WSPWORKSPACEREQUEST¶
Describes the information used to create a WorkSpace.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_directoryid TYPE /AWS1/WSPDIRECTORYID /AWS1/WSPDIRECTORYID¶
The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
iv_username TYPE /AWS1/WSPUSERNAME /AWS1/WSPUSERNAME¶
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.
iv_bundleid TYPE /AWS1/WSPBUNDLEID /AWS1/WSPBUNDLEID¶
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
Optional arguments:¶
iv_volumeencryptionkey TYPE /AWS1/WSPVOLUMEENCRYPTIONKEY /AWS1/WSPVOLUMEENCRYPTIONKEY¶
The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
iv_uservolumeencenabled TYPE /AWS1/WSPBOOLEANOBJECT /AWS1/WSPBOOLEANOBJECT¶
Indicates whether the data stored on the user volume is encrypted.
iv_rootvolumeencenabled TYPE /AWS1/WSPBOOLEANOBJECT /AWS1/WSPBOOLEANOBJECT¶
Indicates whether the data stored on the root volume is encrypted.
io_workspaceproperties TYPE REF TO /AWS1/CL_WSPWORKSPACEPRPS /AWS1/CL_WSPWORKSPACEPRPS¶
The WorkSpace properties.
it_tags TYPE /AWS1/CL_WSPTAG=>TT_TAGLIST TT_TAGLIST¶
The tags for the WorkSpace.
iv_workspacename TYPE /AWS1/WSPWORKSPACENAME /AWS1/WSPWORKSPACENAME¶
The name of the user-decoupled WorkSpace.
WorkspaceNameis required ifUserNameis[UNDEFINED]for user-decoupled WorkSpaces.WorkspaceNameis not applicable ifUserNameis specified for user-assigned WorkSpaces.
iv_ipv6address TYPE /AWS1/WSPIPV6ADDRESS /AWS1/WSPIPV6ADDRESS¶
The IPv6 address for the WorkSpace.
Queryable Attributes¶
DirectoryId¶
The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DIRECTORYID() |
Getter for DIRECTORYID, with configurable default |
ASK_DIRECTORYID() |
Getter for DIRECTORYID w/ exceptions if field has no value |
HAS_DIRECTORYID() |
Determine if DIRECTORYID has a value |
UserName¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERNAME() |
Getter for USERNAME, with configurable default |
ASK_USERNAME() |
Getter for USERNAME w/ exceptions if field has no value |
HAS_USERNAME() |
Determine if USERNAME has a value |
BundleId¶
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BUNDLEID() |
Getter for BUNDLEID, with configurable default |
ASK_BUNDLEID() |
Getter for BUNDLEID w/ exceptions if field has no value |
HAS_BUNDLEID() |
Determine if BUNDLEID has a value |
VolumeEncryptionKey¶
The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VOLUMEENCRYPTIONKEY() |
Getter for VOLUMEENCRYPTIONKEY, with configurable default |
ASK_VOLUMEENCRYPTIONKEY() |
Getter for VOLUMEENCRYPTIONKEY w/ exceptions if field has no |
HAS_VOLUMEENCRYPTIONKEY() |
Determine if VOLUMEENCRYPTIONKEY has a value |
UserVolumeEncryptionEnabled¶
Indicates whether the data stored on the user volume is encrypted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERVOLUMEENCENABLED() |
Getter for USERVOLUMEENCRYPTIONENABLED, with configurable de |
ASK_USERVOLUMEENCENABLED() |
Getter for USERVOLUMEENCRYPTIONENABLED w/ exceptions if fiel |
HAS_USERVOLUMEENCENABLED() |
Determine if USERVOLUMEENCRYPTIONENABLED has a value |
RootVolumeEncryptionEnabled¶
Indicates whether the data stored on the root volume is encrypted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROOTVOLUMEENCENABLED() |
Getter for ROOTVOLUMEENCRYPTIONENABLED, with configurable de |
ASK_ROOTVOLUMEENCENABLED() |
Getter for ROOTVOLUMEENCRYPTIONENABLED w/ exceptions if fiel |
HAS_ROOTVOLUMEENCENABLED() |
Determine if ROOTVOLUMEENCRYPTIONENABLED has a value |
WorkspaceProperties¶
The WorkSpace properties.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WORKSPACEPROPERTIES() |
Getter for WORKSPACEPROPERTIES |
Tags¶
The tags for the WorkSpace.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
WorkspaceName¶
The name of the user-decoupled WorkSpace.
WorkspaceNameis required ifUserNameis[UNDEFINED]for user-decoupled WorkSpaces.WorkspaceNameis not applicable ifUserNameis specified for user-assigned WorkSpaces.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WORKSPACENAME() |
Getter for WORKSPACENAME, with configurable default |
ASK_WORKSPACENAME() |
Getter for WORKSPACENAME w/ exceptions if field has no value |
HAS_WORKSPACENAME() |
Determine if WORKSPACENAME has a value |
Ipv6Address¶
The IPv6 address for the WorkSpace.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPV6ADDRESS() |
Getter for IPV6ADDRESS, with configurable default |
ASK_IPV6ADDRESS() |
Getter for IPV6ADDRESS w/ exceptions if field has no value |
HAS_IPV6ADDRESS() |
Determine if IPV6ADDRESS has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_WORKSPACEREQUESTLIST¶
TYPES TT_WORKSPACEREQUESTLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_WSPWORKSPACEREQUEST WITH DEFAULT KEY
.