Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iam ]

upload-server-certificate

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 more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide .

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

Note

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 upload-server-certificate . 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 Calling the API by Making HTTP Query Requests in the IAM User Guide .

Synopsis

  upload-server-certificate
[--path <value>]
--server-certificate-name <value>
--certificate-body <value>
--private-key <value>
[--certificate-chain <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--path (string)

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 (/). The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (u0021) thru the DEL character (u007F), including most punctuation characters, digits, and upper and lowercased letters.

Note

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/ ).

--server-certificate-name (string)

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

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

--certificate-body (string)

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

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (u0020) through end of the ASCII character range (u00FF). It also includes the special characters tab (u0009), line feed (u000A), and carriage return (u000D).

--private-key (string)

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

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (u0020) through end of the ASCII character range (u00FF). It also includes the special characters tab (u0009), line feed (u000A), and carriage return (u000D).

--certificate-chain (string)

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

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (u0020) through end of the ASCII character range (u00FF). It also includes the special characters tab (u0009), line feed (u000A), and carriage return (u000D).

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Examples

To upload a server certificate to your AWS account

The following upload-server-certificate command uploads a server certificate to your AWS account:

aws iam upload-server-certificate --server-certificate-name myServerCertificate --certificate-body file://public_key_cert_file.pem --private-key file://my_private_key.pem --certificate-chain file://my_certificate_chain_file.pem

The certificate is in the file public_key_cert_file.pem, and your private key is in the file my_private_key.pem. When the file has finished uploading, it is available under the name myServerCertificate. The certificate chain provided by the certificate authority (CA) is included as the my_certificate_chain_file.pem file.

Note that the parameters that contain file names are preceded with file://. This tells the command that the parameter value is a file name. You can include a complete path following file://.

For more information, see Creating, Uploading, and Deleting Server Certificates in the Using IAM guide.

Output

ServerCertificateMetadata -> (structure)

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

Path -> (string)

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

ServerCertificateName -> (string)

The name that identifies the server certificate.

ServerCertificateId -> (string)

The stable and unique string identifying the server certificate. For more information about IDs, see IAM Identifiers in the Using IAM guide.

Arn -> (string)

The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

UploadDate -> (timestamp)

The date when the server certificate was uploaded.

Expiration -> (timestamp)

The date on which the certificate is set to expire.