Amazonka.DirectoryService.CreateDirectory

Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.

Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Creating a Request

data CreateDirectory

Contains the inputs for the CreateDirectory operation.

See: newCreateDirectory smart constructor.

Constructors

CreateDirectory'

Fields

• description :: Maybe Text

  A description for the directory.

• shortName :: Maybe Text

  The NetBIOS name of the directory, such as CORP.

• tags :: Maybe [Tag]

  The tags to be assigned to the Simple AD directory.

• vpcSettings :: Maybe DirectoryVpcSettings

  A DirectoryVpcSettings object that contains additional information for the operation.

• name :: Text

  The fully qualified name for the directory, such as corp.example.com.

• password :: Sensitive Text

  The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.

  If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

  The regex pattern for this string is made up of the following conditions:

  • Length (?=^.{8,64}$) – Must be between 8 and 64 characters

  AND any 3 of the following password complexity rules required by Active Directory:

  • Numbers and upper case and lowercase (?=.*\d)(?=.*[A-Z])(?=.*[a-z])
  • Numbers and special characters and lower case (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])
  • Special characters and upper case and lower case (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])
  • Numbers and upper case and special characters (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s])

  For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.

• size :: DirectorySize

  The size of the directory.

Instances

ToJSON CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

toJSON :: CreateDirectory -> Value

toEncoding :: CreateDirectory -> Encoding

toJSONList :: [CreateDirectory] -> Value

toEncodingList :: [CreateDirectory] -> Encoding

ToHeaders CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

toHeaders :: CreateDirectory -> [Header]

ToPath CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

toPath :: CreateDirectory -> ByteString

ToQuery CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

toQuery :: CreateDirectory -> QueryString

AWSRequest CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

Associated Types

type AWSResponse CreateDirectory

Methods

request :: (Service -> Service) -> CreateDirectory -> Request CreateDirectory

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDirectory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDirectory)))

Generic CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

Associated Types

type Rep CreateDirectory :: Type -> Type

Methods

from :: CreateDirectory -> Rep CreateDirectory x

to :: Rep CreateDirectory x -> CreateDirectory

Show CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

showsPrec :: Int -> CreateDirectory -> ShowS

show :: CreateDirectory -> String

showList :: [CreateDirectory] -> ShowS

NFData CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

rnf :: CreateDirectory -> ()

Eq CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

(==) :: CreateDirectory -> CreateDirectory -> Bool

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

Hashable CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

hashWithSalt :: Int -> CreateDirectory -> Int

hash :: CreateDirectory -> Int

type AWSResponse CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

type AWSResponse CreateDirectory = CreateDirectoryResponse

type Rep CreateDirectory

Defined in Amazonka.DirectoryService.CreateDirectory

type Rep CreateDirectory = D1 ('MetaData "CreateDirectory" "Amazonka.DirectoryService.CreateDirectory" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "CreateDirectory'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "vpcSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DirectoryVpcSettings)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DirectorySize)))))

newCreateDirectory

Arguments

:: Text

CreateDirectory

-> Text

$sel:password:CreateDirectory'

-> DirectorySize

CreateDirectory

-> CreateDirectory

Create a value of CreateDirectory 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:

CreateDirectory, createDirectory_description - A description for the directory.

CreateDirectory, createDirectory_shortName - The NetBIOS name of the directory, such as CORP.

$sel:tags:CreateDirectory', createDirectory_tags - The tags to be assigned to the Simple AD directory.

CreateDirectory, createDirectory_vpcSettings - A DirectoryVpcSettings object that contains additional information for the operation.

CreateDirectory, createDirectory_name - The fully qualified name for the directory, such as corp.example.com.

$sel:password:CreateDirectory', createDirectory_password - The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

The regex pattern for this string is made up of the following conditions:

• Length (?=^.{8,64}$) – Must be between 8 and 64 characters

AND any 3 of the following password complexity rules required by Active Directory:

• Numbers and upper case and lowercase (?=.*\d)(?=.*[A-Z])(?=.*[a-z])
• Numbers and special characters and lower case (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])
• Special characters and upper case and lower case (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])
• Numbers and upper case and special characters (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s])

For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.

CreateDirectory, createDirectory_size - The size of the directory.

Request Lenses

createDirectory_description :: Lens' CreateDirectory (Maybe Text)

A description for the directory.

createDirectory_shortName :: Lens' CreateDirectory (Maybe Text)

The NetBIOS name of the directory, such as CORP.

createDirectory_tags :: Lens' CreateDirectory (Maybe [Tag])

The tags to be assigned to the Simple AD directory.

createDirectory_vpcSettings :: Lens' CreateDirectory (Maybe DirectoryVpcSettings)

A DirectoryVpcSettings object that contains additional information for the operation.

createDirectory_name :: Lens' CreateDirectory Text

The fully qualified name for the directory, such as corp.example.com.

createDirectory_password :: Lens' CreateDirectory Text

The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

The regex pattern for this string is made up of the following conditions:

• Length (?=^.{8,64}$) – Must be between 8 and 64 characters

AND any 3 of the following password complexity rules required by Active Directory:

• Numbers and upper case and lowercase (?=.*\d)(?=.*[A-Z])(?=.*[a-z])
• Numbers and special characters and lower case (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])
• Special characters and upper case and lower case (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])
• Numbers and upper case and special characters (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s])

For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.

createDirectory_size :: Lens' CreateDirectory DirectorySize

The size of the directory.

Destructuring the Response

data CreateDirectoryResponse

Contains the results of the CreateDirectory operation.

See: newCreateDirectoryResponse smart constructor.

Constructors

CreateDirectoryResponse'

Fields

• directoryId :: Maybe Text

  The identifier of the directory that was created.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateDirectoryResponse

Defined in Amazonka.DirectoryService.CreateDirectory

Associated Types

type Rep CreateDirectoryResponse :: Type -> Type

Methods

from :: CreateDirectoryResponse -> Rep CreateDirectoryResponse x

to :: Rep CreateDirectoryResponse x -> CreateDirectoryResponse

Read CreateDirectoryResponse

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

readsPrec :: Int -> ReadS CreateDirectoryResponse

readList :: ReadS [CreateDirectoryResponse]

readPrec :: ReadPrec CreateDirectoryResponse

readListPrec :: ReadPrec [CreateDirectoryResponse]

Show CreateDirectoryResponse

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

showsPrec :: Int -> CreateDirectoryResponse -> ShowS

show :: CreateDirectoryResponse -> String

showList :: [CreateDirectoryResponse] -> ShowS

NFData CreateDirectoryResponse

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

rnf :: CreateDirectoryResponse -> ()

Eq CreateDirectoryResponse

Defined in Amazonka.DirectoryService.CreateDirectory

Methods

(==) :: CreateDirectoryResponse -> CreateDirectoryResponse -> Bool

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

type Rep CreateDirectoryResponse

Defined in Amazonka.DirectoryService.CreateDirectory

type Rep CreateDirectoryResponse = D1 ('MetaData "CreateDirectoryResponse" "Amazonka.DirectoryService.CreateDirectory" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "CreateDirectoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDirectoryResponse

Arguments

:: Int

$sel:httpStatus:CreateDirectoryResponse'

-> CreateDirectoryResponse

Create a value of CreateDirectoryResponse 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:

CreateDirectoryResponse, createDirectoryResponse_directoryId - The identifier of the directory that was created.

$sel:httpStatus:CreateDirectoryResponse', createDirectoryResponse_httpStatus - The response's http status code.

Response Lenses

createDirectoryResponse_directoryId :: Lens' CreateDirectoryResponse (Maybe Text)

The identifier of the directory that was created.

createDirectoryResponse_httpStatus :: Lens' CreateDirectoryResponse Int

The response's http status code.