Class CfnServerCertificate
A CloudFormation AWS::IAM::ServerCertificate
.
Inherited Members
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.AWS.IAM.dll
Syntax (csharp)
public class CfnServerCertificate : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnServerCertificate
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
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 UploadServerCertificate
. For information about setting up signatures and authorization through the API, see Signing AWS API requests in the AWS 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 .
CloudformationResource: AWS::IAM::ServerCertificate
ExampleMetadata: fixture=_generated
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"
} }
});
Synopsis
Constructors
CfnServerCertificate(Construct, String, ICfnServerCertificateProps) | Create a new |
CfnServerCertificate(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnServerCertificate(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the Amazon Resource Name (ARN) for the specified |
CertificateBody | The contents of the public key certificate. |
CertificateChain | The contents of the public key certificate chain. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Path | The path for the server certificate. |
PrivateKey | The contents of the private key in PEM-encoded format. |
ServerCertificateName | The name for the server certificate. |
Tags | A list of tags that are attached to the server certificate. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnServerCertificateProps
- resource properties.
CfnServerCertificate(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnServerCertificate(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnServerCertificate(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnServerCertificate(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::ServerCertificate
resource.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CertificateBody
The contents of the public key certificate.
public virtual string CertificateBody { get; set; }
Property Value
System.String
Remarks
CertificateChain
The contents of the public key certificate chain.
public virtual string CertificateChain { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Path
The path for the server certificate.
public virtual string Path { get; set; }
Property Value
System.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 path
parameter. The path must begin with /cloudfront
and must include a trailing slash (for example, /cloudfront/test/
).
PrivateKey
The contents of the private key in PEM-encoded format.
public virtual string PrivateKey { get; set; }
Property Value
System.String
Remarks
The regex pattern used to validate this parameter is a string of characters consisting of the following:
ServerCertificateName
The name for the server certificate.
public virtual string ServerCertificateName { get; set; }
Property Value
System.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: _+=,.@-
Tags
A list of tags that are attached to the server certificate.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information about tagging, see Tagging IAM resources in the IAM User Guide .
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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>