Amazonka.WorkSpaces.Types.WorkspaceDirectory

Documentation

data WorkspaceDirectory

Describes a directory that is used with Amazon WorkSpaces.

See: newWorkspaceDirectory smart constructor.

Constructors

WorkspaceDirectory'

Fields

• alias :: Maybe Text

  The directory alias.

• certificateBasedAuthProperties :: Maybe CertificateBasedAuthProperties

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

• customerUserName :: Maybe Text

  The user name for the service account.

• directoryId :: Maybe Text

  The directory identifier.

• directoryName :: Maybe Text

  The name of the directory.

• directoryType :: Maybe WorkspaceDirectoryType

  The directory type.

• dnsIpAddresses :: Maybe [Text]

  The IP addresses of the DNS servers for the directory.

• iamRoleId :: Maybe Text

  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.

• registrationCode :: Maybe Text

  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 :: Maybe SamlProperties

  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.

• selfservicePermissions :: Maybe SelfservicePermissions

  The default self-service permissions for WorkSpaces in the directory.

• state :: Maybe WorkspaceDirectoryState

  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.

• subnetIds :: Maybe [Text]

  The identifiers of the subnets used with the directory.

• tenancy :: Maybe Tenancy

  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.

• workspaceAccessProperties :: Maybe WorkspaceAccessProperties

  The devices and operating systems that users can use to access WorkSpaces.

• workspaceCreationProperties :: Maybe DefaultWorkspaceCreationProperties

  The default creation properties for all WorkSpaces in the directory.

• workspaceSecurityGroupId :: Maybe Text

  The identifier of the security group that is assigned to new WorkSpaces.

• ipGroupIds :: Maybe [Text]

  The identifiers of the IP access control groups associated with the directory.

Instances

FromJSON WorkspaceDirectory

Defined in Amazonka.WorkSpaces.Types.WorkspaceDirectory

Methods

parseJSON :: Value -> Parser WorkspaceDirectory

parseJSONList :: Value -> Parser [WorkspaceDirectory]

Generic WorkspaceDirectory

Defined in Amazonka.WorkSpaces.Types.WorkspaceDirectory

Associated Types

type Rep WorkspaceDirectory :: Type -> Type

Methods

from :: WorkspaceDirectory -> Rep WorkspaceDirectory x

to :: Rep WorkspaceDirectory x -> WorkspaceDirectory

Read WorkspaceDirectory

Defined in Amazonka.WorkSpaces.Types.WorkspaceDirectory

Methods

readsPrec :: Int -> ReadS WorkspaceDirectory

readList :: ReadS [WorkspaceDirectory]

readPrec :: ReadPrec WorkspaceDirectory

readListPrec :: ReadPrec [WorkspaceDirectory]

Show WorkspaceDirectory

Defined in Amazonka.WorkSpaces.Types.WorkspaceDirectory

Methods

showsPrec :: Int -> WorkspaceDirectory -> ShowS

show :: WorkspaceDirectory -> String

showList :: [WorkspaceDirectory] -> ShowS

NFData WorkspaceDirectory

Defined in Amazonka.WorkSpaces.Types.WorkspaceDirectory

Methods

rnf :: WorkspaceDirectory -> ()

Eq WorkspaceDirectory

Defined in Amazonka.WorkSpaces.Types.WorkspaceDirectory

Methods

(==) :: WorkspaceDirectory -> WorkspaceDirectory -> Bool

(/=) :: WorkspaceDirectory -> WorkspaceDirectory -> Bool

Hashable WorkspaceDirectory

Defined in Amazonka.WorkSpaces.Types.WorkspaceDirectory

Methods

hashWithSalt :: Int -> WorkspaceDirectory -> Int

hash :: WorkspaceDirectory -> Int

type Rep WorkspaceDirectory

Defined in Amazonka.WorkSpaces.Types.WorkspaceDirectory

type Rep WorkspaceDirectory = D1 ('MetaData "WorkspaceDirectory" "Amazonka.WorkSpaces.Types.WorkspaceDirectory" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "WorkspaceDirectory'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "certificateBasedAuthProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateBasedAuthProperties))) :*: (S1 ('MetaSel ('Just "customerUserName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "directoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "directoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkspaceDirectoryType))) :*: (S1 ('MetaSel ('Just "dnsIpAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "iamRoleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "registrationCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "samlProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SamlProperties)) :*: S1 ('MetaSel ('Just "selfservicePermissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SelfservicePermissions))) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkspaceDirectoryState)) :*: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "tenancy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Tenancy)) :*: S1 ('MetaSel ('Just "workspaceAccessProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkspaceAccessProperties))) :*: (S1 ('MetaSel ('Just "workspaceCreationProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultWorkspaceCreationProperties)) :*: (S1 ('MetaSel ('Just "workspaceSecurityGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ipGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))))

newWorkspaceDirectory :: WorkspaceDirectory

Create a value of WorkspaceDirectory with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alias:WorkspaceDirectory', workspaceDirectory_alias - The directory alias.

$sel:certificateBasedAuthProperties:WorkspaceDirectory', workspaceDirectory_certificateBasedAuthProperties - The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

$sel:customerUserName:WorkspaceDirectory', workspaceDirectory_customerUserName - The user name for the service account.

$sel:directoryId:WorkspaceDirectory', workspaceDirectory_directoryId - The directory identifier.

$sel:directoryName:WorkspaceDirectory', workspaceDirectory_directoryName - The name of the directory.

$sel:directoryType:WorkspaceDirectory', workspaceDirectory_directoryType - The directory type.

$sel:dnsIpAddresses:WorkspaceDirectory', workspaceDirectory_dnsIpAddresses - The IP addresses of the DNS servers for the directory.

$sel:iamRoleId:WorkspaceDirectory', workspaceDirectory_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.

$sel:registrationCode:WorkspaceDirectory', workspaceDirectory_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.

$sel:samlProperties:WorkspaceDirectory', workspaceDirectory_samlProperties - 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.

$sel:selfservicePermissions:WorkspaceDirectory', workspaceDirectory_selfservicePermissions - The default self-service permissions for WorkSpaces in the directory.

$sel:state:WorkspaceDirectory', workspaceDirectory_state - 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.

$sel:subnetIds:WorkspaceDirectory', workspaceDirectory_subnetIds - The identifiers of the subnets used with the directory.

$sel:tenancy:WorkspaceDirectory', workspaceDirectory_tenancy - 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.

$sel:workspaceAccessProperties:WorkspaceDirectory', workspaceDirectory_workspaceAccessProperties - The devices and operating systems that users can use to access WorkSpaces.

$sel:workspaceCreationProperties:WorkspaceDirectory', workspaceDirectory_workspaceCreationProperties - The default creation properties for all WorkSpaces in the directory.

$sel:workspaceSecurityGroupId:WorkspaceDirectory', workspaceDirectory_workspaceSecurityGroupId - The identifier of the security group that is assigned to new WorkSpaces.

$sel:ipGroupIds:WorkspaceDirectory', workspaceDirectory_ipGroupIds - The identifiers of the IP access control groups associated with the directory.

workspaceDirectory_alias :: Lens' WorkspaceDirectory (Maybe Text)

The directory alias.

workspaceDirectory_certificateBasedAuthProperties :: Lens' WorkspaceDirectory (Maybe CertificateBasedAuthProperties)

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

workspaceDirectory_customerUserName :: Lens' WorkspaceDirectory (Maybe Text)

The user name for the service account.

workspaceDirectory_directoryId :: Lens' WorkspaceDirectory (Maybe Text)

The directory identifier.

workspaceDirectory_directoryName :: Lens' WorkspaceDirectory (Maybe Text)

The name of the directory.

workspaceDirectory_directoryType :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryType)

The directory type.

workspaceDirectory_dnsIpAddresses :: Lens' WorkspaceDirectory (Maybe [Text])

The IP addresses of the DNS servers for the directory.

workspaceDirectory_iamRoleId :: Lens' WorkspaceDirectory (Maybe Text)

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.

workspaceDirectory_registrationCode :: Lens' WorkspaceDirectory (Maybe Text)

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

workspaceDirectory_samlProperties :: Lens' WorkspaceDirectory (Maybe SamlProperties)

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.

workspaceDirectory_selfservicePermissions :: Lens' WorkspaceDirectory (Maybe SelfservicePermissions)

The default self-service permissions for WorkSpaces in the directory.

workspaceDirectory_state :: Lens' WorkspaceDirectory (Maybe WorkspaceDirectoryState)

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.

workspaceDirectory_subnetIds :: Lens' WorkspaceDirectory (Maybe [Text])

The identifiers of the subnets used with the directory.

workspaceDirectory_tenancy :: Lens' WorkspaceDirectory (Maybe Tenancy)

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.

workspaceDirectory_workspaceAccessProperties :: Lens' WorkspaceDirectory (Maybe WorkspaceAccessProperties)

The devices and operating systems that users can use to access WorkSpaces.

workspaceDirectory_workspaceCreationProperties :: Lens' WorkspaceDirectory (Maybe DefaultWorkspaceCreationProperties)

The default creation properties for all WorkSpaces in the directory.

workspaceDirectory_workspaceSecurityGroupId :: Lens' WorkspaceDirectory (Maybe Text)

The identifier of the security group that is assigned to new WorkSpaces.

workspaceDirectory_ipGroupIds :: Lens' WorkspaceDirectory (Maybe [Text])

The identifiers of the IP access control groups associated with the directory.