amazonka-iam-1.3.5: Amazon Identity and Access Management SDK.

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

Network.AWS.IAM.UploadServerCertificate

Contents

Description

Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

For information about the number of server certificates you can upload, see Limitations on IAM Entities in the IAM User Guide.

Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

See: AWS API Reference for UploadServerCertificate.

Synopsis

Creating a Request

uploadServerCertificate Source

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

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

Request Lenses

uscPath :: Lens' UploadServerCertificate (Maybe Text) Source

The path for the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the '--path' option. The path must begin with '\/cloudfront' and must include a trailing slash (for example, '\/cloudfront\/test\/').

uscCertificateChain :: Lens' UploadServerCertificate (Maybe Text) Source

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

uscServerCertificateName :: Lens' UploadServerCertificate Text Source

The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.

uscCertificateBody :: Lens' UploadServerCertificate Text Source

The contents of the public key certificate in PEM-encoded format.

uscPrivateKey :: Lens' UploadServerCertificate Text Source

The contents of the private key in PEM-encoded format.

Destructuring the Response

uploadServerCertificateResponse Source

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

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

Response Lenses

ursServerCertificateMetadata :: Lens' UploadServerCertificateResponse (Maybe ServerCertificateMetadata) Source

The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.