Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DirectoryService.CreateTrust

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.

Synopsis

data CreateTrust = CreateTrust' {
- conditionalForwarderIpAddrs :: Maybe [Text]
- selectiveAuth :: Maybe SelectiveAuth
- trustType :: Maybe TrustType
- directoryId :: Text
- remoteDomainName :: Text
- trustPassword :: Sensitive Text
- trustDirection :: TrustDirection
}
newCreateTrust :: Text -> Text -> Text -> TrustDirection -> CreateTrust
createTrust_conditionalForwarderIpAddrs :: Lens' CreateTrust (Maybe [Text])
createTrust_selectiveAuth :: Lens' CreateTrust (Maybe SelectiveAuth)
createTrust_trustType :: Lens' CreateTrust (Maybe TrustType)
createTrust_directoryId :: Lens' CreateTrust Text
createTrust_remoteDomainName :: Lens' CreateTrust Text
createTrust_trustPassword :: Lens' CreateTrust Text
createTrust_trustDirection :: Lens' CreateTrust TrustDirection
data CreateTrustResponse = CreateTrustResponse' {
- trustId :: Maybe Text
- httpStatus :: Int
}
newCreateTrustResponse :: Int -> CreateTrustResponse
createTrustResponse_trustId :: Lens' CreateTrustResponse (Maybe Text)
createTrustResponse_httpStatus :: Lens' CreateTrustResponse Int

Creating a Request

data CreateTrust Source #

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.

See: newCreateTrust smart constructor.

Constructors

CreateTrust'

Fields

conditionalForwarderIpAddrs :: Maybe [Text]
The IP addresses of the remote DNS server associated with RemoteDomainName.
selectiveAuth :: Maybe SelectiveAuth
Optional parameter to enable selective authentication for the trust.
trustType :: Maybe TrustType
The trust relationship type. Forest is the default.
directoryId :: Text
The Directory ID of the Managed Microsoft AD directory for which to establish the trust relationship.
remoteDomainName :: Text
The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.
trustPassword :: Sensitive Text
The trust password. The must be the same password that was used when creating the trust relationship on the external domain.
trustDirection :: TrustDirection
The direction of the trust relationship.

Instances

Instances details

ToJSON CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods toJSON :: CreateTrust -> Value # toEncoding :: CreateTrust -> Encoding # toJSONList :: [CreateTrust] -> Value # toEncodingList :: [CreateTrust] -> Encoding #
ToHeaders CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods toHeaders :: CreateTrust -> [Header] #
ToPath CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods toPath :: CreateTrust -> ByteString #
ToQuery CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods toQuery :: CreateTrust -> QueryString #
AWSRequest CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Associated Types type AWSResponse CreateTrust # Methods request :: (Service -> Service) -> CreateTrust -> Request CreateTrust # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateTrust -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateTrust))) #
Generic CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Associated Types type Rep CreateTrust :: Type -> Type # Methods from :: CreateTrust -> Rep CreateTrust x # to :: Rep CreateTrust x -> CreateTrust #
Show CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods showsPrec :: Int -> CreateTrust -> ShowS # show :: CreateTrust -> String # showList :: [CreateTrust] -> ShowS #
NFData CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods rnf :: CreateTrust -> () #
Eq CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods (==) :: CreateTrust -> CreateTrust -> Bool # (/=) :: CreateTrust -> CreateTrust -> Bool #
Hashable CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods hashWithSalt :: Int -> CreateTrust -> Int # hash :: CreateTrust -> Int #
type AWSResponse CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust type AWSResponse CreateTrust = CreateTrustResponse
type Rep CreateTrust Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust type Rep CreateTrust = D1 ('MetaData "CreateTrust" "Amazonka.DirectoryService.CreateTrust" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "CreateTrust'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "conditionalForwarderIpAddrs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "selectiveAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SelectiveAuth)) :: S1 ('MetaSel ('Just "trustType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrustType)))) :: ((S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "remoteDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "trustPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: S1 ('MetaSel ('Just "trustDirection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TrustDirection)))))

newCreateTrust Source #

Arguments

:: Text	`CreateTrust`
-> Text	`CreateTrust`
-> Text	`$sel:trustPassword:CreateTrust'`
-> TrustDirection	`CreateTrust`
-> CreateTrust

Create a value of CreateTrust 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:conditionalForwarderIpAddrs:CreateTrust', createTrust_conditionalForwarderIpAddrs - The IP addresses of the remote DNS server associated with RemoteDomainName.

CreateTrust, createTrust_selectiveAuth - Optional parameter to enable selective authentication for the trust.

CreateTrust, createTrust_trustType - The trust relationship type. Forest is the default.

CreateTrust, createTrust_directoryId - The Directory ID of the Managed Microsoft AD directory for which to establish the trust relationship.

CreateTrust, createTrust_remoteDomainName - The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

$sel:trustPassword:CreateTrust', createTrust_trustPassword - The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

CreateTrust, createTrust_trustDirection - The direction of the trust relationship.

Request Lenses

createTrust_conditionalForwarderIpAddrs :: Lens' CreateTrust (Maybe [Text]) Source #

The IP addresses of the remote DNS server associated with RemoteDomainName.

createTrust_selectiveAuth :: Lens' CreateTrust (Maybe SelectiveAuth) Source #

Optional parameter to enable selective authentication for the trust.

createTrust_trustType :: Lens' CreateTrust (Maybe TrustType) Source #

The trust relationship type. Forest is the default.

createTrust_directoryId :: Lens' CreateTrust Text Source #

The Directory ID of the Managed Microsoft AD directory for which to establish the trust relationship.

createTrust_remoteDomainName :: Lens' CreateTrust Text Source #

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

createTrust_trustPassword :: Lens' CreateTrust Text Source #

The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

createTrust_trustDirection :: Lens' CreateTrust TrustDirection Source #

The direction of the trust relationship.

Destructuring the Response

data CreateTrustResponse Source #

The result of a CreateTrust request.

See: newCreateTrustResponse smart constructor.

Constructors

CreateTrustResponse'
Fields trustId :: Maybe Text A unique identifier for the trust relationship that was created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateTrustResponse Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Associated Types type Rep CreateTrustResponse :: Type -> Type # Methods from :: CreateTrustResponse -> Rep CreateTrustResponse x # to :: Rep CreateTrustResponse x -> CreateTrustResponse #
Read CreateTrustResponse Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods readsPrec :: Int -> ReadS CreateTrustResponse # readList :: ReadS [CreateTrustResponse] # readPrec :: ReadPrec CreateTrustResponse # readListPrec :: ReadPrec [CreateTrustResponse] #
Show CreateTrustResponse Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods showsPrec :: Int -> CreateTrustResponse -> ShowS # show :: CreateTrustResponse -> String # showList :: [CreateTrustResponse] -> ShowS #
NFData CreateTrustResponse Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods rnf :: CreateTrustResponse -> () #
Eq CreateTrustResponse Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust Methods (==) :: CreateTrustResponse -> CreateTrustResponse -> Bool # (/=) :: CreateTrustResponse -> CreateTrustResponse -> Bool #
type Rep CreateTrustResponse Source #
Instance details Defined in Amazonka.DirectoryService.CreateTrust type Rep CreateTrustResponse = D1 ('MetaData "CreateTrustResponse" "Amazonka.DirectoryService.CreateTrust" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "CreateTrustResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "trustId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateTrustResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateTrustResponse'`
-> CreateTrustResponse

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

CreateTrustResponse, createTrustResponse_trustId - A unique identifier for the trust relationship that was created.

$sel:httpStatus:CreateTrustResponse', createTrustResponse_httpStatus - The response's http status code.

Response Lenses

createTrustResponse_trustId :: Lens' CreateTrustResponse (Maybe Text) Source #

A unique identifier for the trust relationship that was created.

createTrustResponse_httpStatus :: Lens' CreateTrustResponse Int Source #

The response's http status code.