Table of Contents

Class CfnServerCertificate

Namespace
Amazon.CDK.AWS.IAM
Assembly
Amazon.CDK.AWS.IAM.dll

A CloudFormation AWS::IAM::ServerCertificate.

public class CfnServerCertificate : CfnResource, IInspectable
Inheritance
CfnServerCertificate
Implements
IInspectable

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IAM;

             var cfnServerCertificate = new CfnServerCertificate(this, "MyCfnServerCertificate", new CfnServerCertificateProps {
                 CertificateBody = "certificateBody",
                 CertificateChain = "certificateChain",
                 Path = "path",
                 PrivateKey = "privateKey",
                 ServerCertificateName = "serverCertificateName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Remarks

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.

We recommend that you use AWS Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to AWS resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the AWS 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 AWS 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 AWS 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 <code>UploadServerCertificate</code> . For information about setting up signatures and authorization through the API, see <a href="https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API requests</a> in the <em>AWS General Reference</em> . For general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html">Calling the API by making HTTP query requests</a> in the <em>IAM User Guide</em> .

CloudformationResource: AWS::IAM::ServerCertificate

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html

ExampleMetadata: fixture=_generated

Constructors

CfnServerCertificate(Construct, string, ICfnServerCertificateProps?)

Create a new AWS::IAM::ServerCertificate.

public CfnServerCertificate(Construct scope, string id, ICfnServerCertificateProps? props = null)

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnServerCertificateProps
  • resource properties.

Properties

AttrArn

Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::ServerCertificate resource.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CertificateBody

The contents of the public key certificate.

public virtual string? CertificateBody { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-certificatebody

CertificateChain

The contents of the public key certificate chain.

public virtual string? CertificateChain { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-certificatechain

CfnProperties 

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Path

The path for the server certificate.

public virtual string? Path { get; set; }

Property Value

string

Remarks

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 <code>path</code> parameter. The path must begin with <code>/cloudfront</code> and must include a trailing slash (for example, <code>/cloudfront/test/</code> ).

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-path

PrivateKey

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

public virtual string? PrivateKey { get; set; }

Property Value

string

Remarks

The regex pattern used to validate this parameter is a string of characters consisting of the following:

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-privatekey

    ServerCertificateName

    The name for the server certificate.

    public virtual string? ServerCertificateName { get; set; }

    Property Value

    string

    Remarks

    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: _+=,.@-

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-servercertificatename

    Tags

    A list of tags that are attached to the server certificate.

    public virtual TagManager Tags { get; }

    Property Value

    TagManager

    Remarks

    For more information about tagging, see Tagging IAM resources in the IAM User Guide .

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-tags

    Methods

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.

    public virtual void Inspect(TreeInspector inspector)

    Parameters

    inspector TreeInspector
    • tree inspector to collect and process attributes.

    RenderProperties(IDictionary<string, object>) 

    protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

    Parameters

    props IDictionary<string, object>

    Returns

    IDictionary<string, object>