Container for the parameters to the UploadServerCertificate operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.IdentityManagement.AmazonIdentityManagementServiceRequest
Amazon.IdentityManagement.Model.UploadServerCertificateRequest
Namespace: Amazon.IdentityManagement.Model
Assembly: AWSSDK.IdentityManagement.dll
Version: 3.x.y.z
Syntax
public class UploadServerCertificateRequest : AmazonIdentityManagementServiceRequest IAmazonWebServiceRequest
The UploadServerCertificateRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UploadServerCertificateRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
|
UploadServerCertificateRequest(string, string, string) |
Instantiates UploadServerCertificateRequest with the parameterized properties |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CertificateBody | System.String |
Gets and sets the property 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:
|
|
|
CertificateChain | System.String |
Gets and sets the property 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:
|
|
|
Path | System.String |
Gets and sets the property 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 ! (
If you are uploading a server certificate specifically for use with Amazon CloudFront
distributions, you must specify a path using the |
|
|
PrivateKey | System.String |
Gets and sets the property 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:
|
|
|
ServerCertificateName | System.String |
Gets and sets the property 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: _+=,.@- |
|
|
Tags | System.Collections.Generic.List<Amazon.IdentityManagement.Model.Tag> |
Gets and sets the property 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. |
Examples
The following upload-server-certificate command uploads a server certificate to your AWS account:
To upload a server certificate to your AWS account
var client = new AmazonIdentityManagementServiceClient();
var response = client.UploadServerCertificate(new UploadServerCertificateRequest
{
CertificateBody = "-----BEGIN CERTIFICATE-----<a very long certificate text string>-----END CERTIFICATE-----",
Path = "/company/servercerts/",
PrivateKey = "-----BEGIN DSA PRIVATE KEY-----<a very long private key string>-----END DSA PRIVATE KEY-----",
ServerCertificateName = "ProdServerCert"
});
ServerCertificateMetadata serverCertificateMetadata = response.ServerCertificateMetadata;
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5