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.DirectoryService.RegisterCertificate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Registers a certificate for a secure LDAP or client certificate authentication.

Synopsis

data RegisterCertificate = RegisterCertificate' {
- clientCertAuthSettings :: Maybe ClientCertAuthSettings
- type' :: Maybe CertificateType
- directoryId :: Text
- certificateData :: Text
}
newRegisterCertificate :: Text -> Text -> RegisterCertificate
registerCertificate_clientCertAuthSettings :: Lens' RegisterCertificate (Maybe ClientCertAuthSettings)
registerCertificate_type :: Lens' RegisterCertificate (Maybe CertificateType)
registerCertificate_directoryId :: Lens' RegisterCertificate Text
registerCertificate_certificateData :: Lens' RegisterCertificate Text
data RegisterCertificateResponse = RegisterCertificateResponse' {
- certificateId :: Maybe Text
- httpStatus :: Int
}
newRegisterCertificateResponse :: Int -> RegisterCertificateResponse
registerCertificateResponse_certificateId :: Lens' RegisterCertificateResponse (Maybe Text)
registerCertificateResponse_httpStatus :: Lens' RegisterCertificateResponse Int

Creating a Request

data RegisterCertificate Source #

See: newRegisterCertificate smart constructor.

Constructors

RegisterCertificate'

Fields

clientCertAuthSettings :: Maybe ClientCertAuthSettings
A ClientCertAuthSettings object that contains client certificate authentication settings.
type' :: Maybe CertificateType
The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.
directoryId :: Text
The identifier of the directory.
certificateData :: Text
The certificate PEM string that needs to be registered.

Instances

Instances details

Eq RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate Methods (==) :: RegisterCertificate -> RegisterCertificate -> Bool # (/=) :: RegisterCertificate -> RegisterCertificate -> Bool #
Read RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate Methods readsPrec :: Int -> ReadS RegisterCertificate # readList :: ReadS [RegisterCertificate] # readPrec :: ReadPrec RegisterCertificate # readListPrec :: ReadPrec [RegisterCertificate] #
Show RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate Methods showsPrec :: Int -> RegisterCertificate -> ShowS # show :: RegisterCertificate -> String # showList :: [RegisterCertificate] -> ShowS #
Generic RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate Associated Types type Rep RegisterCertificate :: Type -> Type # Methods from :: RegisterCertificate -> Rep RegisterCertificate x # to :: Rep RegisterCertificate x -> RegisterCertificate #
NFData RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate Methods rnf :: RegisterCertificate -> () #
Hashable RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate Methods hashWithSalt :: Int -> RegisterCertificate -> Int # hash :: RegisterCertificate -> Int #
ToJSON RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate Methods toJSON :: RegisterCertificate -> Value # toEncoding :: RegisterCertificate -> Encoding # toJSONList :: [RegisterCertificate] -> Value # toEncodingList :: [RegisterCertificate] -> Encoding #
AWSRequest RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate Associated Types type AWSResponse RegisterCertificate # Methods request :: RegisterCertificate -> Request RegisterCertificate # response :: MonadResource m => Logger -> Service -> Proxy RegisterCertificate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterCertificate))) #
ToHeaders RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate Methods toHeaders :: RegisterCertificate -> [Header] #
ToPath RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate Methods toPath :: RegisterCertificate -> ByteString #
ToQuery RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate Methods toQuery :: RegisterCertificate -> QueryString #
type Rep RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate type Rep RegisterCertificate = D1 ('MetaData "RegisterCertificate" "Amazonka.DirectoryService.RegisterCertificate" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "RegisterCertificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientCertAuthSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientCertAuthSettings)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateType))) :: (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "certificateData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse RegisterCertificate Source #
Instance details Defined in Amazonka.DirectoryService.RegisterCertificate type AWSResponse RegisterCertificate = RegisterCertificateResponse

newRegisterCertificate Source #

Arguments

:: Text	`$sel:directoryId:RegisterCertificate'`
-> Text	`$sel:certificateData:RegisterCertificate'`
-> RegisterCertificate

Create a value of RegisterCertificate 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:clientCertAuthSettings:RegisterCertificate', registerCertificate_clientCertAuthSettings - A ClientCertAuthSettings object that contains client certificate authentication settings.

$sel:type':RegisterCertificate', registerCertificate_type - The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.

$sel:directoryId:RegisterCertificate', registerCertificate_directoryId - The identifier of the directory.

$sel:certificateData:RegisterCertificate', registerCertificate_certificateData - The certificate PEM string that needs to be registered.

Request Lenses

registerCertificate_clientCertAuthSettings :: Lens' RegisterCertificate (Maybe ClientCertAuthSettings) Source #

A ClientCertAuthSettings object that contains client certificate authentication settings.

registerCertificate_type :: Lens' RegisterCertificate (Maybe CertificateType) Source #

The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.

registerCertificate_directoryId :: Lens' RegisterCertificate Text Source #

The identifier of the directory.

registerCertificate_certificateData :: Lens' RegisterCertificate Text Source #

The certificate PEM string that needs to be registered.

Destructuring the Response

data RegisterCertificateResponse Source #

See: newRegisterCertificateResponse smart constructor.

Constructors

RegisterCertificateResponse'
Fields certificateId :: Maybe Text The identifier of the certificate. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newRegisterCertificateResponse Source #

Arguments

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

Create a value of RegisterCertificateResponse 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:certificateId:RegisterCertificateResponse', registerCertificateResponse_certificateId - The identifier of the certificate.

$sel:httpStatus:RegisterCertificateResponse', registerCertificateResponse_httpStatus - The response's http status code.

Response Lenses

registerCertificateResponse_certificateId :: Lens' RegisterCertificateResponse (Maybe Text) Source #

The identifier of the certificate.

registerCertificateResponse_httpStatus :: Lens' RegisterCertificateResponse Int Source #

The response's http status code.