aws_workspaces_directory

account_id

Type: STRING

active_directory_config

Type: STRUCT
Provider name: ActiveDirectoryConfig
Description: Information about the Active Directory config.

• domain_name
  Type: STRING
  Provider name: DomainName
  Description: The name of the domain.
  
• service_account_secret_arn
  Type: STRING
  Provider name: ServiceAccountSecretArn
  Description: Indicates the secret ARN on the service account.
  

alias

Type: STRING
Provider name: Alias
Description: The directory alias.

certificate_based_auth_properties

Type: STRUCT
Provider name: CertificateBasedAuthProperties
Description: The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

• certificate_authority_arn
  Type: STRING
  Provider name: CertificateAuthorityArn
  Description: The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.
  
• status
  Type: STRING
  Provider name: Status
  Description: The status of the certificate-based authentication properties.
  

customer_user_name

Type: STRING
Provider name: CustomerUserName
Description: The user name for the service account.

directory_id

Type: STRING
Provider name: DirectoryId
Description: The directory identifier.

directory_name

Type: STRING
Provider name: DirectoryName
Description: The name of the directory.

directory_type

Type: STRING
Provider name: DirectoryType
Description: The directory type.

dns_ip_addresses

Type: UNORDERED_LIST_STRING
Provider name: DnsIpAddresses
Description: The IP addresses of the DNS servers for the directory.

error_message

Type: STRING
Provider name: ErrorMessage
Description: The error message returned.

iam_role_id

Type: STRING
Provider name: IamRoleId
Description: The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

idc_config

Type: STRUCT
Provider name: IDCConfig
Description: Specifies details about identity center configurations.

• application_arn
  Type: STRING
  Provider name: ApplicationArn
  Description: The Amazon Resource Name (ARN) of the application.
  
• instance_arn
  Type: STRING
  Provider name: InstanceArn
  Description: The Amazon Resource Name (ARN) of the identity center instance.
  

ip_group_ids

Type: UNORDERED_LIST_STRING
Provider name: ipGroupIds
Description: The identifiers of the IP access control groups associated with the directory.

microsoft_entra_config

Type: STRUCT
Provider name: MicrosoftEntraConfig
Description: Specifies details about Microsoft Entra configurations.

• application_config_secret_arn
  Type: STRING
  Provider name: ApplicationConfigSecretArn
  Description: The Amazon Resource Name (ARN) of the application config.
  
• tenant_id
  Type: STRING
  Provider name: TenantId
  Description: The identifier of the tenant.
  

registration_code

Type: STRING
Provider name: RegistrationCode
Description: The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

saml_properties

Type: STRUCT
Provider name: SamlProperties
Description: Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

• relay_state_parameter_name
  Type: STRING
  Provider name: RelayStateParameterName
  Description: The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session. To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
  
• status
  Type: STRING
  Provider name: Status
  Description: Indicates the status of SAML 2.0 authentication. These statuses include the following.
  • If the setting is DISABLED, end users will be directed to login with their directory credentials.
  • If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.
  • If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
• user_access_url
  Type: STRING
  Provider name: UserAccessUrl
  Description: The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
  

selfservice_permissions

Type: STRUCT
Provider name: SelfservicePermissions
Description: The default self-service permissions for WorkSpaces in the directory.

• change_compute_type
  Type: STRING
  Provider name: ChangeComputeType
  Description: Specifies whether users can change the compute type (bundle) for their WorkSpace.
  
• increase_volume_size
  Type: STRING
  Provider name: IncreaseVolumeSize
  Description: Specifies whether users can increase the volume size of the drives on their WorkSpace.
  
• rebuild_workspace
  Type: STRING
  Provider name: RebuildWorkspace
  Description: Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
  
• restart_workspace
  Type: STRING
  Provider name: RestartWorkspace
  Description: Specifies whether users can restart their WorkSpace.
  
• switch_running_mode
  Type: STRING
  Provider name: SwitchRunningMode
  Description: Specifies whether users can switch the running mode of their WorkSpace.
  

state

Type: STRING
Provider name: State
Description: The state of the directory’s registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn’t returned, then the directory has been successfully deregistered.

streaming_properties

Type: STRUCT
Provider name: StreamingProperties
Description: The streaming properties to configure.

• 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 directory is enabled or disabled.
    
  • preferred_protocol
    Type: STRING
    Provider name: PreferredProtocol
    Description: Indicates the preferred protocol for Global Accelerator.
    
• storage_connectors
  Type: UNORDERED_LIST_STRUCT
  Provider name: StorageConnectors
  Description: Indicates the storage connector used
  
  • connector_type
    Type: STRING
    Provider name: ConnectorType
    Description: The type of connector used to save user files.
    
  • status
    Type: STRING
    Provider name: Status
    Description: Indicates if the storage connetor is enabled or disabled.
    
• streaming_experience_preferred_protocol
  Type: STRING
  Provider name: StreamingExperiencePreferredProtocol
  Description: Indicates the type of preferred protocol for the streaming experience.
  
• user_settings
  Type: UNORDERED_LIST_STRUCT
  Provider name: UserSettings
  Description: Indicates the permission settings asscoiated with the user.
  
  • action
    Type: STRING
    Provider name: Action
    Description: Indicates the type of action.
    
  • maximum_length
    Type: INT32
    Provider name: MaximumLength
    Description: Indicates the maximum character length for the specified user setting.
    
  • permission
    Type: STRING
    Provider name: Permission
    Description: Indicates if the setting is enabled or disabled.
    

subnet_ids

Type: UNORDERED_LIST_STRING
Provider name: SubnetIds
Description: The identifiers of the subnets used with the directory.

tags

Type: UNORDERED_LIST_STRING

tenancy

Type: STRING
Provider name: Tenancy
Description: Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

user_identity_type

Type: STRING
Provider name: UserIdentityType
Description: Indicates the identity type of the specifired user.

workspace_access_properties

Type: STRUCT
Provider name: WorkspaceAccessProperties
Description: The devices and operating systems that users can use to access WorkSpaces.

• device_type_android
  Type: STRING
  Provider name: DeviceTypeAndroid
  Description: Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
  
• device_type_chrome_os
  Type: STRING
  Provider name: DeviceTypeChromeOs
  Description: Indicates whether users can use Chromebooks to access their WorkSpaces.
  
• device_type_ios
  Type: STRING
  Provider name: DeviceTypeIos
  Description: Indicates whether users can use iOS devices to access their WorkSpaces.
  
• device_type_linux
  Type: STRING
  Provider name: DeviceTypeLinux
  Description: Indicates whether users can use Linux clients to access their WorkSpaces.
  
• device_type_osx
  Type: STRING
  Provider name: DeviceTypeOsx
  Description: Indicates whether users can use macOS clients to access their WorkSpaces.
  
• device_type_web
  Type: STRING
  Provider name: DeviceTypeWeb
  Description: Indicates whether users can access their WorkSpaces through a web browser.
  
• device_type_windows
  Type: STRING
  Provider name: DeviceTypeWindows
  Description: Indicates whether users can use Windows clients to access their WorkSpaces.
  
• device_type_zero_client
  Type: STRING
  Provider name: DeviceTypeZeroClient
  Description: Indicates whether users can use zero client devices to access their WorkSpaces.
  

workspace_creation_properties

Type: STRUCT
Provider name: WorkspaceCreationProperties
Description: The default creation properties for all WorkSpaces in the directory.

• custom_security_group_id
  Type: STRING
  Provider name: CustomSecurityGroupId
  Description: The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
  
• default_ou
  Type: STRING
  Provider name: DefaultOu
  Description: The organizational unit (OU) in the directory for the WorkSpace machine accounts.
  
• enable_internet_access
  Type: BOOLEAN
  Provider name: EnableInternetAccess
  Description: Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you’re using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
  
• enable_maintenance_mode
  Type: BOOLEAN
  Provider name: EnableMaintenanceMode
  Description: Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
  
• enable_work_docs
  Type: BOOLEAN
  Provider name: EnableWorkDocs
  Description: Specifies whether the directory is enabled for Amazon WorkDocs.
  
• instance_iam_role_arn
  Type: STRING
  Provider name: InstanceIamRoleArn
  Description: Indicates the IAM role ARN of the instance.
  
• user_enabled_as_local_administrator
  Type: BOOLEAN
  Provider name: UserEnabledAsLocalAdministrator
  Description: Specifies whether WorkSpace users are local administrators on their WorkSpaces.
  

workspace_directory_description

Type: STRING
Provider name: WorkspaceDirectoryDescription
Description: The description of the WorkSpace directory

workspace_directory_name

Type: STRING
Provider name: WorkspaceDirectoryName
Description: The name fo the WorkSpace directory.

workspace_security_group_id

Type: STRING
Provider name: WorkspaceSecurityGroupId
Description: The identifier of the security group that is assigned to new WorkSpaces.

workspace_type

Type: STRING
Provider name: WorkspaceType
Description: Indicates whether the directory’s WorkSpace type is personal or pools.