amazonka-certificatemanager-1.6.0: Amazon Certificate Manager SDK.

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

Network.AWS.CertificateManager.ImportCertificate

Contents

Description

Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the AWS Certificate Manager User Guide .

Note the following guidelines when importing third party certificates:

  • You must enter the private key that matches the certificate you are importing.
  • The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
  • If the certificate you are importing is not self-signed, you must enter its certificate chain.
  • If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.
  • The certificate, private key, and certificate chain must be PEM-encoded.
  • The current time must be between the Not Before and Not After certificate fields.
  • The Issuer field must not be empty.
  • The OCSP authority URL, if present, must not exceed 1000 characters.
  • To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate.
  • When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by file:// . For example, you can specify a certificate saved in the C:temp folder as file://C:tempcertificate_to_import.pem . If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.
  • When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.

This operation returns the Amazon Resource Name (ARN) of the imported certificate.

Synopsis

Creating a Request

importCertificate #

Creates a value of ImportCertificate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • icCertificateARN - The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.
  • icCertificateChain - The PEM encoded certificate chain.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
  • icCertificate - The certificate to import.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
  • icPrivateKey - The private key that matches the public key in the certificate.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

data ImportCertificate #

See: importCertificate smart constructor.

Instances
Eq ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Data ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ImportCertificate -> c ImportCertificate #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ImportCertificate #

toConstr :: ImportCertificate -> Constr #

dataTypeOf :: ImportCertificate -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ImportCertificate) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ImportCertificate) #

gmapT :: (forall b. Data b => b -> b) -> ImportCertificate -> ImportCertificate #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ImportCertificate -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ImportCertificate -> r #

gmapQ :: (forall d. Data d => d -> u) -> ImportCertificate -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ImportCertificate -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ImportCertificate -> m ImportCertificate #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportCertificate -> m ImportCertificate #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportCertificate -> m ImportCertificate #

Show ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Generic ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Associated Types

type Rep ImportCertificate :: * -> * #

Hashable ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

ToJSON ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

AWSRequest ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Associated Types

type Rs ImportCertificate :: * #

ToHeaders ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

ToPath ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

ToQuery ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

NFData ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Methods

rnf :: ImportCertificate -> () #

type Rep ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

type Rep ImportCertificate = D1 (MetaData "ImportCertificate" "Network.AWS.CertificateManager.ImportCertificate" "amazonka-certificatemanager-1.6.0-7JB8JsCwrfRJtf8W91f9vY" False) (C1 (MetaCons "ImportCertificate'" PrefixI True) ((S1 (MetaSel (Just "_icCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_icCertificateChain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Base64))) :*: (S1 (MetaSel (Just "_icCertificate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Base64) :*: S1 (MetaSel (Just "_icPrivateKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Base64)))))
type Rs ImportCertificate # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Request Lenses

icCertificateARN :: Lens' ImportCertificate (Maybe Text) #

The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.

icCertificateChain :: Lens' ImportCertificate (Maybe ByteString) #

The PEM encoded certificate chain.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

icCertificate :: Lens' ImportCertificate ByteString #

The certificate to import.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

icPrivateKey :: Lens' ImportCertificate ByteString #

The private key that matches the public key in the certificate.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

Destructuring the Response

importCertificateResponse #

Creates a value of ImportCertificateResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ImportCertificateResponse #

See: importCertificateResponse smart constructor.

Instances
Eq ImportCertificateResponse # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Data ImportCertificateResponse # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ImportCertificateResponse -> c ImportCertificateResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ImportCertificateResponse #

toConstr :: ImportCertificateResponse -> Constr #

dataTypeOf :: ImportCertificateResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ImportCertificateResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ImportCertificateResponse) #

gmapT :: (forall b. Data b => b -> b) -> ImportCertificateResponse -> ImportCertificateResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ImportCertificateResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ImportCertificateResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ImportCertificateResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ImportCertificateResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ImportCertificateResponse -> m ImportCertificateResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportCertificateResponse -> m ImportCertificateResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportCertificateResponse -> m ImportCertificateResponse #

Read ImportCertificateResponse # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Show ImportCertificateResponse # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Generic ImportCertificateResponse # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

Associated Types

type Rep ImportCertificateResponse :: * -> * #

NFData ImportCertificateResponse # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

type Rep ImportCertificateResponse # 
Instance details

Defined in Network.AWS.CertificateManager.ImportCertificate

type Rep ImportCertificateResponse = D1 (MetaData "ImportCertificateResponse" "Network.AWS.CertificateManager.ImportCertificate" "amazonka-certificatemanager-1.6.0-7JB8JsCwrfRJtf8W91f9vY" False) (C1 (MetaCons "ImportCertificateResponse'" PrefixI True) (S1 (MetaSel (Just "_icrsCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_icrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

icrsResponseStatus :: Lens' ImportCertificateResponse Int #

  • - | The response status code.