DirectoryState class

Input properties used for looking up and filtering Directory resources.

Constructors

DirectoryState({Input<DirectoryActiveDirectoryConfig?>? activeDirectoryConfig, Input<String?>? alias, Input<DirectoryCertificateBasedAuthProperties?>? certificateBasedAuthProperties, Input<String?>? customerUserName, Input<String?>? directoryId, Input<String?>? directoryName, Input<String?>? directoryType, Input<List<String>?>? dnsIpAddresses, Input<String?>? iamRoleId, Input<List<String>?>? ipGroupIds, Input<String?>? region, Input<String?>? registrationCode, Input<DirectorySamlProperties?>? samlProperties, Input<DirectorySelfServicePermissions?>? selfServicePermissions, Input<List<String>?>? subnetIds, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? tenancy, Input<String?>? userIdentityType, Input<DirectoryWorkspaceAccessProperties?>? workspaceAccessProperties, Input<DirectoryWorkspaceCreationProperties?>? workspaceCreationProperties, Input<String?>? workspaceDirectoryDescription, Input<String?>? workspaceDirectoryName, Input<String?>? workspaceSecurityGroupId, Input<String?>? workspaceType})
Creates a new DirectoryState. activeDirectoryConfig Configuration for Active Directory integration when workspaceType is set to POOLS. Defined below. alias The directory alias. certificateBasedAuthProperties Configuration of certificate-based authentication (CBA) integration. Requires SAML authentication to be enabled. Defined below. customerUserName The user name for the service account. directoryId The directory identifier for registration in WorkSpaces service. directoryName The name of the directory. directoryType The directory type. dnsIpAddresses The IP addresses of the DNS servers for the directory. iamRoleId 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. ipGroupIds The identifiers of the IP access control groups associated with the directory. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. registrationCode The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory. samlProperties Configuration of SAML authentication integration. Defined below. selfServicePermissions Permissions to enable or disable self-service capabilities when workspaceType is set to PERSONAL.. Defined below. subnetIds The identifiers of the subnets where the directory resides. tags A map of tags assigned to the WorkSpaces directory. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. tenancy Tenancy of the WorkSpaces directory. Valid values are DEDICATED or SHARED. userIdentityType Specifies the user identity type for the WorkSpaces directory. Valid values are CUSTOMER_MANAGED, AWS_DIRECTORY_SERVICE, AWS_IAM_IDENTITY_CENTER. workspaceAccessProperties Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below. workspaceCreationProperties Default properties that are used for creating WorkSpaces. Defined below. workspaceDirectoryDescription The description of the WorkSpaces directory when workspaceType is set to POOLS. workspaceDirectoryName The name of the WorkSpaces directory when workspaceType is set to POOLS. workspaceSecurityGroupId The identifier of the security group that is assigned to new WorkSpaces. workspaceType Specifies the type of WorkSpaces directory. Valid values are PERSONAL and POOLS. Default is PERSONAL.
const
DirectoryState.fromMap(Map<String, dynamic> map)
factory

Properties

activeDirectoryConfig → Input<DirectoryActiveDirectoryConfig?>?
Configuration for Active Directory integration when workspaceType is set to POOLS. Defined below.
final
alias → Input<String?>?
The directory alias.
final
certificateBasedAuthProperties → Input<DirectoryCertificateBasedAuthProperties?>?
Configuration of certificate-based authentication (CBA) integration. Requires SAML authentication to be enabled. Defined below.
final
customerUserName → Input<String?>?
The user name for the service account.
final
directoryId → Input<String?>?
The directory identifier for registration in WorkSpaces service.
final
directoryName → Input<String?>?
The name of the directory.
final
directoryType → Input<String?>?
The directory type.
final
dnsIpAddresses → Input<List<String>?>?
The IP addresses of the DNS servers for the directory.
final
hashCode → int
The hash code for this object.
no setterinherited
iamRoleId → Input<String?>?
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.
final
ipGroupIds → Input<List<String>?>?
The identifiers of the IP access control groups associated with the directory.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
registrationCode → Input<String?>?
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
samlProperties → Input<DirectorySamlProperties?>?
Configuration of SAML authentication integration. Defined below.
final
selfServicePermissions → Input<DirectorySelfServicePermissions?>?
Permissions to enable or disable self-service capabilities when workspaceType is set to PERSONAL.. Defined below.
final
subnetIds → Input<List<String>?>?
The identifiers of the subnets where the directory resides.
final
tags → Input<Map<String, String>?>?
A map of tags assigned to the WorkSpaces directory. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
tenancy → Input<String?>?
Tenancy of the WorkSpaces directory. Valid values are DEDICATED or SHARED.
final
userIdentityType → Input<String?>?
Specifies the user identity type for the WorkSpaces directory. Valid values are CUSTOMER_MANAGED, AWS_DIRECTORY_SERVICE, AWS_IAM_IDENTITY_CENTER.
final
workspaceAccessProperties → Input<DirectoryWorkspaceAccessProperties?>?
Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.
final
workspaceCreationProperties → Input<DirectoryWorkspaceCreationProperties?>?
Default properties that are used for creating WorkSpaces. Defined below.
final
workspaceDirectoryDescription → Input<String?>?
The description of the WorkSpaces directory when workspaceType is set to POOLS.
final
workspaceDirectoryName → Input<String?>?
The name of the WorkSpaces directory when workspaceType is set to POOLS.
final
workspaceSecurityGroupId → Input<String?>?
The identifier of the security group that is assigned to new WorkSpaces.
final
workspaceType → Input<String?>?
Specifies the type of WorkSpaces directory. Valid values are PERSONAL and POOLS. Default is PERSONAL.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited