| 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.IAM.UploadServerCertificate
Description
Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
We recommend that you use Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the Certificate Manager User Guide.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
For information about the number of server certificates you can upload, see IAM and STS quotas 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, see
Signing Amazon Web Services API requests
in the Amazon Web Services General Reference. For general information
about using the Query API with IAM, see
Calling the API by making HTTP query requests
in the IAM User Guide.
Synopsis
- data UploadServerCertificate = UploadServerCertificate' {
- path :: Maybe Text
- certificateChain :: Maybe Text
- tags :: Maybe [Tag]
- serverCertificateName :: Text
- certificateBody :: Text
- privateKey :: Sensitive Text
- newUploadServerCertificate :: Text -> Text -> Text -> UploadServerCertificate
- uploadServerCertificate_path :: Lens' UploadServerCertificate (Maybe Text)
- uploadServerCertificate_certificateChain :: Lens' UploadServerCertificate (Maybe Text)
- uploadServerCertificate_tags :: Lens' UploadServerCertificate (Maybe [Tag])
- uploadServerCertificate_serverCertificateName :: Lens' UploadServerCertificate Text
- uploadServerCertificate_certificateBody :: Lens' UploadServerCertificate Text
- uploadServerCertificate_privateKey :: Lens' UploadServerCertificate Text
- data UploadServerCertificateResponse = UploadServerCertificateResponse' {}
- newUploadServerCertificateResponse :: Int -> UploadServerCertificateResponse
- uploadServerCertificateResponse_serverCertificateMetadata :: Lens' UploadServerCertificateResponse (Maybe ServerCertificateMetadata)
- uploadServerCertificateResponse_tags :: Lens' UploadServerCertificateResponse (Maybe [Tag])
- uploadServerCertificateResponse_httpStatus :: Lens' UploadServerCertificateResponse Int
Creating a Request
data UploadServerCertificate Source #
See: newUploadServerCertificate smart constructor.
Constructors
| UploadServerCertificate' | |
Fields
| |
Instances
newUploadServerCertificate Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UploadServerCertificate |
Create a value of UploadServerCertificate 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:path:UploadServerCertificate', uploadServerCertificate_path - The path for the server certificate. For more information about paths,
see
IAM identifiers
in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a
slash (/). This parameter allows (through its
regex pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that
must begin and end with forward slashes. In addition, it can contain any
ASCII character from the ! (\u0021) through the DEL character
(\u007F), including most punctuation characters, digits, and upper
and lowercased letters.
If you are uploading a server certificate specifically for use with
Amazon CloudFront distributions, you must specify a path using the
path parameter. The path must begin with /cloudfront and must
include a trailing slash (for example, /cloudfront/test/).
$sel:certificateChain:UploadServerCertificate', uploadServerCertificate_certificateChain - The contents of the certificate chain. This is typically a concatenation
of the PEM-encoded public key certificates of the chain.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
- Any printable ASCII character ranging from the space character
(
\u0020) through the end of the ASCII character range - The printable characters in the Basic Latin and Latin-1 Supplement
character set (through
\u00FF) - The special characters tab (
\u0009), line feed (\u000A), and carriage return (\u000D)
$sel:tags:UploadServerCertificate', uploadServerCertificate_tags - A list of tags that you want to attach to the new IAM server certificate
resource. Each tag consists of a key name and an associated value. For
more information about tagging, see
Tagging IAM resources
in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
$sel:serverCertificateName:UploadServerCertificate', uploadServerCertificate_serverCertificateName - The name for the server certificate. Do not include the path in this
value. The name of the certificate cannot contain any spaces.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
$sel:certificateBody:UploadServerCertificate', uploadServerCertificate_certificateBody - The contents of the public key certificate in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
- Any printable ASCII character ranging from the space character
(
\u0020) through the end of the ASCII character range - The printable characters in the Basic Latin and Latin-1 Supplement
character set (through
\u00FF) - The special characters tab (
\u0009), line feed (\u000A), and carriage return (\u000D)
$sel:privateKey:UploadServerCertificate', uploadServerCertificate_privateKey - The contents of the private key in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
- Any printable ASCII character ranging from the space character
(
\u0020) through the end of the ASCII character range - The printable characters in the Basic Latin and Latin-1 Supplement
character set (through
\u00FF) - The special characters tab (
\u0009), line feed (\u000A), and carriage return (\u000D)
Request Lenses
uploadServerCertificate_path :: Lens' UploadServerCertificate (Maybe Text) Source #
The path for the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a
slash (/). This parameter allows (through its
regex pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that
must begin and end with forward slashes. In addition, it can contain any
ASCII character from the ! (\u0021) through the DEL character
(\u007F), including most punctuation characters, digits, and upper
and lowercased letters.
If you are uploading a server certificate specifically for use with
Amazon CloudFront distributions, you must specify a path using the
path parameter. The path must begin with /cloudfront and must
include a trailing slash (for example, /cloudfront/test/).
uploadServerCertificate_certificateChain :: 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.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
- Any printable ASCII character ranging from the space character
(
\u0020) through the end of the ASCII character range - The printable characters in the Basic Latin and Latin-1 Supplement
character set (through
\u00FF) - The special characters tab (
\u0009), line feed (\u000A), and carriage return (\u000D)
uploadServerCertificate_tags :: Lens' UploadServerCertificate (Maybe [Tag]) Source #
A list of tags that you want to attach to the new IAM server certificate resource. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
uploadServerCertificate_serverCertificateName :: 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.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
uploadServerCertificate_certificateBody :: Lens' UploadServerCertificate Text Source #
The contents of the public key certificate in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
- Any printable ASCII character ranging from the space character
(
\u0020) through the end of the ASCII character range - The printable characters in the Basic Latin and Latin-1 Supplement
character set (through
\u00FF) - The special characters tab (
\u0009), line feed (\u000A), and carriage return (\u000D)
uploadServerCertificate_privateKey :: Lens' UploadServerCertificate Text Source #
The contents of the private key in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
- Any printable ASCII character ranging from the space character
(
\u0020) through the end of the ASCII character range - The printable characters in the Basic Latin and Latin-1 Supplement
character set (through
\u00FF) - The special characters tab (
\u0009), line feed (\u000A), and carriage return (\u000D)
Destructuring the Response
data UploadServerCertificateResponse Source #
Contains the response to a successful UploadServerCertificate request.
See: newUploadServerCertificateResponse smart constructor.
Constructors
| UploadServerCertificateResponse' | |
Fields
| |
Instances
newUploadServerCertificateResponse Source #
Create a value of UploadServerCertificateResponse 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:serverCertificateMetadata:UploadServerCertificateResponse', uploadServerCertificateResponse_serverCertificateMetadata - The meta information of the uploaded server certificate without its
certificate body, certificate chain, and private key.
$sel:tags:UploadServerCertificate', uploadServerCertificateResponse_tags - A list of tags that are attached to the new IAM server certificate. The
returned list of tags is sorted by tag key. For more information about
tagging, see
Tagging IAM resources
in the IAM User Guide.
$sel:httpStatus:UploadServerCertificateResponse', uploadServerCertificateResponse_httpStatus - The response's http status code.
Response Lenses
uploadServerCertificateResponse_serverCertificateMetadata :: Lens' UploadServerCertificateResponse (Maybe ServerCertificateMetadata) Source #
The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.
uploadServerCertificateResponse_tags :: Lens' UploadServerCertificateResponse (Maybe [Tag]) Source #
A list of tags that are attached to the new IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
uploadServerCertificateResponse_httpStatus :: Lens' UploadServerCertificateResponse Int Source #
The response's http status code.