aws_workspaces_workspace

account_id

Type: STRING

bundle_id

Type: STRING
Provider name: BundleId
Description: The identifier of the bundle used to create the WorkSpace.

computer_name

Type: STRING
Provider name: ComputerName
Description: The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

data_replication_settings

Type: STRUCT
Provider name: DataReplicationSettings
Description: Indicates the settings of the data replication.

• data_replication
  Type: STRING
  Provider name: DataReplication
  Description: Indicates whether data replication is enabled, and if enabled, the type of data replication.
  
• recovery_snapshot_time
  Type: TIMESTAMP
  Provider name: RecoverySnapshotTime
  Description: The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
  

directory_id

Type: STRING
Provider name: DirectoryId
Description: The identifier of the Directory Service directory for the WorkSpace.

error_code

Type: STRING
Provider name: ErrorCode
Description: The error code that is returned if the WorkSpace cannot be created.

error_message

Type: STRING
Provider name: ErrorMessage
Description: The text of the error message that is returned if the WorkSpace cannot be created.

ip_address

Type: STRING
Provider name: IpAddress
Description: The IP address of the WorkSpace.

modification_states

Type: UNORDERED_LIST_STRUCT
Provider name: ModificationStates
Description: The modification states of the WorkSpace.

• resource
  Type: STRING
  Provider name: Resource
  Description: The resource.
  
• state
  Type: STRING
  Provider name: State
  Description: The modification state.
  

related_workspaces

Type: UNORDERED_LIST_STRUCT
Provider name: RelatedWorkspaces
Description: The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

• region
  Type: STRING
  Provider name: Region
  Description: The Region of the related WorkSpace.
  
• state
  Type: STRING
  Provider name: State
  Description: Indicates the state of the WorkSpace.
  
• type
  Type: STRING
  Provider name: Type
  Description: Indicates the type of WorkSpace.
  
• workspace_id
  Type: STRING
  Provider name: WorkspaceId
  Description: The identifier of the related WorkSpace.
  

root_volume_encryption_enabled

Type: BOOLEAN
Provider name: RootVolumeEncryptionEnabled
Description: Indicates whether the data stored on the root volume is encrypted.

standby_workspaces_properties

Type: UNORDERED_LIST_STRUCT
Provider name: StandbyWorkspacesProperties
Description: The properties of the standby WorkSpace

• data_replication
  Type: STRING
  Provider name: DataReplication
  Description: Indicates whether data replication is enabled, and if enabled, the type of data replication.
  
• recovery_snapshot_time
  Type: TIMESTAMP
  Provider name: RecoverySnapshotTime
  Description: The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
  
• standby_workspace_id
  Type: STRING
  Provider name: StandbyWorkspaceId
  Description: The identifier of the standby WorkSpace
  

state

Type: STRING
Provider name: State
Description: The operational state of the WorkSpace.

• PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
• AVAILABLE – The WorkSpace is running and has passed the health checks.
• IMPAIRED – Refer to UNHEALTHY state.
• UNHEALTHY – The WorkSpace is not responding to health checks.
• REBOOTING – The WorkSpace is being rebooted (restarted).
• STARTING – The WorkSpace is starting up and health checks are being run.
• REBUILDING – The WorkSpace is being rebuilt.
• RESTORING – The WorkSpace is being restored.
• MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
• ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
• TERMINATING – The WorkSpace is being deleted.
• TERMINATED – The WorkSpace has been deleted.
• SUSPENDED – The WorkSpace has been suspended for image creation.
• UPDATING – The WorkSpace is undergoing an update.
• STOPPING – The WorkSpace is being stopped.
• STOPPED – The WorkSpace has been stopped.
• ERROR – The WorkSpace is an error state (for example, an error occurred during startup).

subnet_id

Type: STRING
Provider name: SubnetId
Description: The identifier of the subnet for the WorkSpace.

tags

Type: UNORDERED_LIST_STRING

user_name

Type: STRING
Provider name: UserName
Description: The user for the WorkSpace.

user_volume_encryption_enabled

Type: BOOLEAN
Provider name: UserVolumeEncryptionEnabled
Description: Indicates whether the data stored on the user volume is encrypted.

volume_encryption_key

Type: STRING
Provider name: VolumeEncryptionKey
Description: The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

workspace_id

Type: STRING
Provider name: WorkspaceId
Description: The identifier of the WorkSpace.

workspace_name

Type: STRING
Provider name: WorkspaceName
Description: The name of the user-decoupled WorkSpace.

workspace_properties

Type: STRUCT
Provider name: WorkspaceProperties
Description: The properties of the WorkSpace.

• compute_type_name
  Type: STRING
  Provider name: ComputeTypeName
  Description: The compute type. For more information, see Amazon WorkSpaces Bundles.
  
• global_accelerator
  Type: STRUCT
  Provider name: GlobalAccelerator
  Description: Indicates the Global Accelerator properties.
  
  • mode
    Type: STRING
    Provider name: Mode
    Description: Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.
    
  • preferred_protocol
    Type: STRING
    Provider name: PreferredProtocol
    Description: Indicates the preferred protocol for Global Accelerator.
    
• operating_system_name
  Type: STRING
  Provider name: OperatingSystemName
  Description: The name of the operating system.
  
• protocols
  Type: UNORDERED_LIST_STRING
  Provider name: Protocols
  Description: The protocol. For more information, see Protocols for Amazon WorkSpaces.
  • Only available for WorkSpaces created with PCoIP bundles.
  • The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).
  • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
  
  
• root_volume_size_gib
  Type: INT32
  Provider name: RootVolumeSizeGib
  Description: 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
  Type: STRING
  Provider name: RunningMode
  Description: The running mode. For more information, see Manage the WorkSpace Running Mode. The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core. Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
  
• running_mode_auto_stop_timeout_in_minutes
  Type: INT32
  Provider name: RunningModeAutoStopTimeoutInMinutes
  Description: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
  
• user_volume_size_gib
  Type: INT32
  Provider name: UserVolumeSizeGib
  Description: 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.