Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WorkSpaces.Types.WorkspaceCreationProperties

Description

Synopsis

Documentation

data WorkspaceCreationProperties Source #

Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

See: newWorkspaceCreationProperties smart constructor.

Constructors

WorkspaceCreationProperties'

Fields

customSecurityGroupId :: Maybe Text
The identifier of your custom security group.
userEnabledAsLocalAdministrator :: Maybe Bool
Indicates whether users are local administrators of their WorkSpaces.
enableWorkDocs :: Maybe Bool
Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
enableMaintenanceMode :: Maybe Bool
Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
enableInternetAccess :: Maybe Bool
Indicates whether internet access is enabled for your WorkSpaces.
defaultOu :: Maybe Text
The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.
- To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
- The API doesn't validate whether the OU exists.

Instances

Instances details

Eq WorkspaceCreationProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.WorkspaceCreationProperties Methods (==) :: WorkspaceCreationProperties -> WorkspaceCreationProperties -> Bool # (/=) :: WorkspaceCreationProperties -> WorkspaceCreationProperties -> Bool #
Read WorkspaceCreationProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.WorkspaceCreationProperties Methods readsPrec :: Int -> ReadS WorkspaceCreationProperties # readList :: ReadS [WorkspaceCreationProperties] # readPrec :: ReadPrec WorkspaceCreationProperties # readListPrec :: ReadPrec [WorkspaceCreationProperties] #
Show WorkspaceCreationProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.WorkspaceCreationProperties Methods showsPrec :: Int -> WorkspaceCreationProperties -> ShowS # show :: WorkspaceCreationProperties -> String # showList :: [WorkspaceCreationProperties] -> ShowS #
Generic WorkspaceCreationProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.WorkspaceCreationProperties Associated Types type Rep WorkspaceCreationProperties :: Type -> Type # Methods from :: WorkspaceCreationProperties -> Rep WorkspaceCreationProperties x # to :: Rep WorkspaceCreationProperties x -> WorkspaceCreationProperties #
NFData WorkspaceCreationProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.WorkspaceCreationProperties Methods rnf :: WorkspaceCreationProperties -> () #
Hashable WorkspaceCreationProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.WorkspaceCreationProperties Methods hashWithSalt :: Int -> WorkspaceCreationProperties -> Int # hash :: WorkspaceCreationProperties -> Int #
ToJSON WorkspaceCreationProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.WorkspaceCreationProperties Methods toJSON :: WorkspaceCreationProperties -> Value # toEncoding :: WorkspaceCreationProperties -> Encoding # toJSONList :: [WorkspaceCreationProperties] -> Value # toEncodingList :: [WorkspaceCreationProperties] -> Encoding #
type Rep WorkspaceCreationProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.WorkspaceCreationProperties type Rep WorkspaceCreationProperties = D1 ('MetaData "WorkspaceCreationProperties" "Amazonka.WorkSpaces.Types.WorkspaceCreationProperties" "libZSservicesZSamazonka-workspacesZSamazonka-workspaces" 'False) (C1 ('MetaCons "WorkspaceCreationProperties'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customSecurityGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userEnabledAsLocalAdministrator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "enableWorkDocs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "enableMaintenanceMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "enableInternetAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "defaultOu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newWorkspaceCreationProperties :: WorkspaceCreationProperties Source #

Create a value of WorkspaceCreationProperties 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:customSecurityGroupId:WorkspaceCreationProperties', workspaceCreationProperties_customSecurityGroupId - The identifier of your custom security group.

$sel:userEnabledAsLocalAdministrator:WorkspaceCreationProperties', workspaceCreationProperties_userEnabledAsLocalAdministrator - Indicates whether users are local administrators of their WorkSpaces.

$sel:enableWorkDocs:WorkspaceCreationProperties', workspaceCreationProperties_enableWorkDocs - Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

$sel:enableMaintenanceMode:WorkspaceCreationProperties', workspaceCreationProperties_enableMaintenanceMode - Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

$sel:enableInternetAccess:WorkspaceCreationProperties', workspaceCreationProperties_enableInternetAccess - Indicates whether internet access is enabled for your WorkSpaces.

$sel:defaultOu:WorkspaceCreationProperties', workspaceCreationProperties_defaultOu - The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
The API doesn't validate whether the OU exists.

workspaceCreationProperties_customSecurityGroupId :: Lens' WorkspaceCreationProperties (Maybe Text) Source #

The identifier of your custom security group.

workspaceCreationProperties_userEnabledAsLocalAdministrator :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #

Indicates whether users are local administrators of their WorkSpaces.

workspaceCreationProperties_enableWorkDocs :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

workspaceCreationProperties_enableMaintenanceMode :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

workspaceCreationProperties_enableInternetAccess :: Lens' WorkspaceCreationProperties (Maybe Bool) Source #

Indicates whether internet access is enabled for your WorkSpaces.

workspaceCreationProperties_defaultOu :: Lens' WorkspaceCreationProperties (Maybe Text) Source #

The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
The API doesn't validate whether the OU exists.