libZSservicesZSamazonka-dsZSamazonka-ds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DirectoryService.CreateMicrosoftAD

Description

Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.

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

Synopsis

Creating a Request

data CreateMicrosoftAD Source #

Creates an Managed Microsoft AD directory.

See: newCreateMicrosoftAD smart constructor.

Constructors

CreateMicrosoftAD' 

Fields

  • edition :: Maybe DirectoryEdition

    Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

  • shortName :: Maybe Text

    The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

  • description :: Maybe Text

    A description for the directory. This label will appear on the Amazon Web Services console Directory Details page after the directory is created.

  • tags :: Maybe [Tag]

    The tags to be assigned to the Managed Microsoft AD directory.

  • name :: Text

    The fully qualified domain name for the Managed Microsoft AD directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.

  • password :: Sensitive Text

    The password for the default administrative user named Admin.

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

  • vpcSettings :: DirectoryVpcSettings

    Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

Instances

Instances details
Eq CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

(==) :: CreateMicrosoftAD -> CreateMicrosoftAD -> Bool #

(/=) :: CreateMicrosoftAD -> CreateMicrosoftAD -> Bool #

Show CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

showsPrec :: Int -> CreateMicrosoftAD -> ShowS #

show :: CreateMicrosoftAD -> String #

showList :: [CreateMicrosoftAD] -> ShowS #

Generic CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Associated Types

type Rep CreateMicrosoftAD :: Type -> Type #

Methods

from :: CreateMicrosoftAD -> Rep CreateMicrosoftAD x #

to :: Rep CreateMicrosoftAD x -> CreateMicrosoftAD #

NFData CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

rnf :: CreateMicrosoftAD -> () #

Hashable CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

hashWithSalt :: Int -> CreateMicrosoftAD -> Int #

hash :: CreateMicrosoftAD -> Int #

ToJSON CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

toJSON :: CreateMicrosoftAD -> Value #

toEncoding :: CreateMicrosoftAD -> Encoding #

toJSONList :: [CreateMicrosoftAD] -> Value #

toEncodingList :: [CreateMicrosoftAD] -> Encoding #

AWSRequest CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Associated Types

type AWSResponse CreateMicrosoftAD #

Methods

request :: CreateMicrosoftAD -> Request CreateMicrosoftAD #

response :: MonadResource m => Logger -> Service -> Proxy CreateMicrosoftAD -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateMicrosoftAD))) #

ToHeaders CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

toHeaders :: CreateMicrosoftAD -> [Header] #

ToPath CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

toPath :: CreateMicrosoftAD -> ByteString #

ToQuery CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

toQuery :: CreateMicrosoftAD -> QueryString #

type Rep CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

type Rep CreateMicrosoftAD = D1 ('MetaData "CreateMicrosoftAD" "Amazonka.DirectoryService.CreateMicrosoftAD" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "CreateMicrosoftAD'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "edition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DirectoryEdition)) :*: (S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "vpcSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DirectoryVpcSettings)))))
type AWSResponse CreateMicrosoftAD Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

type AWSResponse CreateMicrosoftAD = CreateMicrosoftADResponse

newCreateMicrosoftAD Source #

Arguments

:: Text

$sel:name:CreateMicrosoftAD'

-> Text

$sel:password:CreateMicrosoftAD'

-> DirectoryVpcSettings

$sel:vpcSettings:CreateMicrosoftAD'

-> CreateMicrosoftAD 

Create a value of CreateMicrosoftAD 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:edition:CreateMicrosoftAD', createMicrosoftAD_edition - Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

$sel:shortName:CreateMicrosoftAD', createMicrosoftAD_shortName - The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

$sel:description:CreateMicrosoftAD', createMicrosoftAD_description - A description for the directory. This label will appear on the Amazon Web Services console Directory Details page after the directory is created.

$sel:tags:CreateMicrosoftAD', createMicrosoftAD_tags - The tags to be assigned to the Managed Microsoft AD directory.

$sel:name:CreateMicrosoftAD', createMicrosoftAD_name - The fully qualified domain name for the Managed Microsoft AD directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.

$sel:password:CreateMicrosoftAD', createMicrosoftAD_password - The password for the default administrative user named Admin.

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

$sel:vpcSettings:CreateMicrosoftAD', createMicrosoftAD_vpcSettings - Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

Request Lenses

createMicrosoftAD_edition :: Lens' CreateMicrosoftAD (Maybe DirectoryEdition) Source #

Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

createMicrosoftAD_shortName :: Lens' CreateMicrosoftAD (Maybe Text) Source #

The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

createMicrosoftAD_description :: Lens' CreateMicrosoftAD (Maybe Text) Source #

A description for the directory. This label will appear on the Amazon Web Services console Directory Details page after the directory is created.

createMicrosoftAD_tags :: Lens' CreateMicrosoftAD (Maybe [Tag]) Source #

The tags to be assigned to the Managed Microsoft AD directory.

createMicrosoftAD_name :: Lens' CreateMicrosoftAD Text Source #

The fully qualified domain name for the Managed Microsoft AD directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.

createMicrosoftAD_password :: Lens' CreateMicrosoftAD Text Source #

The password for the default administrative user named Admin.

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

createMicrosoftAD_vpcSettings :: Lens' CreateMicrosoftAD DirectoryVpcSettings Source #

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

Destructuring the Response

data CreateMicrosoftADResponse Source #

Result of a CreateMicrosoftAD request.

See: newCreateMicrosoftADResponse smart constructor.

Constructors

CreateMicrosoftADResponse' 

Fields

Instances

Instances details
Eq CreateMicrosoftADResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

(==) :: CreateMicrosoftADResponse -> CreateMicrosoftADResponse -> Bool #

(/=) :: CreateMicrosoftADResponse -> CreateMicrosoftADResponse -> Bool #

Read CreateMicrosoftADResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

readsPrec :: Int -> ReadS CreateMicrosoftADResponse #

readList :: ReadS [CreateMicrosoftADResponse] #

readPrec :: ReadPrec CreateMicrosoftADResponse #

readListPrec :: ReadPrec [CreateMicrosoftADResponse] #

Show CreateMicrosoftADResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

showsPrec :: Int -> CreateMicrosoftADResponse -> ShowS #

show :: CreateMicrosoftADResponse -> String #

showList :: [CreateMicrosoftADResponse] -> ShowS #

Generic CreateMicrosoftADResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Associated Types

type Rep CreateMicrosoftADResponse :: Type -> Type #

Methods

from :: CreateMicrosoftADResponse -> Rep CreateMicrosoftADResponse x #

to :: Rep CreateMicrosoftADResponse x -> CreateMicrosoftADResponse #

NFData CreateMicrosoftADResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

Methods

rnf :: CreateMicrosoftADResponse -> () #

type Rep CreateMicrosoftADResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.CreateMicrosoftAD

type Rep CreateMicrosoftADResponse = D1 ('MetaData "CreateMicrosoftADResponse" "Amazonka.DirectoryService.CreateMicrosoftAD" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "CreateMicrosoftADResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateMicrosoftADResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateMicrosoftADResponse'

-> CreateMicrosoftADResponse 

Create a value of CreateMicrosoftADResponse 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:directoryId:CreateMicrosoftADResponse', createMicrosoftADResponse_directoryId - The identifier of the directory that was created.

$sel:httpStatus:CreateMicrosoftADResponse', createMicrosoftADResponse_httpStatus - The response's http status code.

Response Lenses

createMicrosoftADResponse_directoryId :: Lens' CreateMicrosoftADResponse (Maybe Text) Source #

The identifier of the directory that was created.

createMicrosoftADResponse_httpStatus :: Lens' CreateMicrosoftADResponse Int Source #

The response's http status code.