Class CfnCertificate
A CloudFormation AWS::ACMPCA::Certificate
.
Inherited Members
Namespace: Amazon.CDK.AWS.ACMPCA
Assembly: Amazon.CDK.AWS.ACMPCA.dll
Syntax (csharp)
public class CfnCertificate : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCertificate
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::ACMPCA::Certificate
resource is used to issue a certificate using your private certificate authority. For more information, see the IssueCertificate action.
CloudformationResource: AWS::ACMPCA::Certificate
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html
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.ACMPCA;
var cfnCertificate = new CfnCertificate(this, "MyCfnCertificate", new CfnCertificateProps {
CertificateAuthorityArn = "certificateAuthorityArn",
CertificateSigningRequest = "certificateSigningRequest",
SigningAlgorithm = "signingAlgorithm",
Validity = new ValidityProperty {
Type = "type",
Value = 123
},
// the properties below are optional
ApiPassthrough = new ApiPassthroughProperty {
Extensions = new ExtensionsProperty {
CertificatePolicies = new [] { new PolicyInformationProperty {
CertPolicyId = "certPolicyId",
// the properties below are optional
PolicyQualifiers = new [] { new PolicyQualifierInfoProperty {
PolicyQualifierId = "policyQualifierId",
Qualifier = new QualifierProperty {
CpsUri = "cpsUri"
}
} }
} },
CustomExtensions = new [] { new CustomExtensionProperty {
ObjectIdentifier = "objectIdentifier",
Value = "value",
// the properties below are optional
Critical = false
} },
ExtendedKeyUsage = new [] { new ExtendedKeyUsageProperty {
ExtendedKeyUsageObjectIdentifier = "extendedKeyUsageObjectIdentifier",
ExtendedKeyUsageType = "extendedKeyUsageType"
} },
KeyUsage = new KeyUsageProperty {
CrlSign = false,
DataEncipherment = false,
DecipherOnly = false,
DigitalSignature = false,
EncipherOnly = false,
KeyAgreement = false,
KeyCertSign = false,
KeyEncipherment = false,
NonRepudiation = false
},
SubjectAlternativeNames = new [] { new GeneralNameProperty {
DirectoryName = new SubjectProperty {
CommonName = "commonName",
Country = "country",
CustomAttributes = new [] { new CustomAttributeProperty {
ObjectIdentifier = "objectIdentifier",
Value = "value"
} },
DistinguishedNameQualifier = "distinguishedNameQualifier",
GenerationQualifier = "generationQualifier",
GivenName = "givenName",
Initials = "initials",
Locality = "locality",
Organization = "organization",
OrganizationalUnit = "organizationalUnit",
Pseudonym = "pseudonym",
SerialNumber = "serialNumber",
State = "state",
Surname = "surname",
Title = "title"
},
DnsName = "dnsName",
EdiPartyName = new EdiPartyNameProperty {
NameAssigner = "nameAssigner",
PartyName = "partyName"
},
IpAddress = "ipAddress",
OtherName = new OtherNameProperty {
TypeId = "typeId",
Value = "value"
},
RegisteredId = "registeredId",
Rfc822Name = "rfc822Name",
UniformResourceIdentifier = "uniformResourceIdentifier"
} }
},
Subject = new SubjectProperty {
CommonName = "commonName",
Country = "country",
CustomAttributes = new [] { new CustomAttributeProperty {
ObjectIdentifier = "objectIdentifier",
Value = "value"
} },
DistinguishedNameQualifier = "distinguishedNameQualifier",
GenerationQualifier = "generationQualifier",
GivenName = "givenName",
Initials = "initials",
Locality = "locality",
Organization = "organization",
OrganizationalUnit = "organizationalUnit",
Pseudonym = "pseudonym",
SerialNumber = "serialNumber",
State = "state",
Surname = "surname",
Title = "title"
}
},
TemplateArn = "templateArn",
ValidityNotBefore = new ValidityProperty {
Type = "type",
Value = 123
}
});
Synopsis
Constructors
CfnCertificate(Construct, String, ICfnCertificateProps) | Create a new |
CfnCertificate(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCertificate(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiPassthrough | Specifies X.509 certificate information to be included in the issued certificate. An |
AttrArn | The Amazon Resource Name (ARN) of the issued certificate. |
AttrCertificate | The issued Base64 PEM-encoded certificate. |
CertificateAuthorityArn | The Amazon Resource Name (ARN) for the private CA issues the certificate. |
CertificateSigningRequest | The certificate signing request (CSR) for the certificate. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
SigningAlgorithm | The name of the algorithm that will be used to sign the certificate to be issued. |
TemplateArn | Specifies a custom configuration template to use when issuing a certificate. |
Validity | The period of time during which the certificate will be valid. |
ValidityNotBefore | Information describing the start of the validity period of the certificate. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCertificate(Construct, String, ICfnCertificateProps)
Create a new AWS::ACMPCA::Certificate
.
public CfnCertificate(Construct scope, string id, ICfnCertificateProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnCertificateProps
- resource properties.
CfnCertificate(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCertificate(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCertificate(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCertificate(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApiPassthrough
Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough
or APICSRPassthrough
template variant must be selected, or else this parameter is ignored.
public virtual object ApiPassthrough { get; set; }
Property Value
System.Object
Remarks
AttrArn
The Amazon Resource Name (ARN) of the issued certificate.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCertificate
The issued Base64 PEM-encoded certificate.
public virtual string AttrCertificate { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Certificate
CertificateAuthorityArn
The Amazon Resource Name (ARN) for the private CA issues the certificate.
public virtual string CertificateAuthorityArn { get; set; }
Property Value
System.String
Remarks
CertificateSigningRequest
The certificate signing request (CSR) for the certificate.
public virtual string CertificateSigningRequest { 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
SigningAlgorithm
The name of the algorithm that will be used to sign the certificate to be issued.
public virtual string SigningAlgorithm { get; set; }
Property Value
System.String
Remarks
This parameter should not be confused with the SigningAlgorithm
parameter used to sign a CSR in the CreateCertificateAuthority
action.
The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
TemplateArn
Specifies a custom configuration template to use when issuing a certificate.
public virtual string TemplateArn { get; set; }
Property Value
System.String
Remarks
If this parameter is not provided, AWS Private CA defaults to the EndEntityCertificate/V1
template. For more information about AWS Private CA templates, see Using Templates .
Validity
The period of time during which the certificate will be valid.
public virtual object Validity { get; set; }
Property Value
System.Object
Remarks
ValidityNotBefore
Information describing the start of the validity period of the certificate.
public virtual object ValidityNotBefore { get; set; }
Property Value
System.Object
Remarks
This parameter sets the “Not Before" date for the certificate.
By default, when issuing a certificate, AWS Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore
parameter can be used to customize the “Not Before” value.
Unlike the Validity
parameter, the ValidityNotBefore
parameter is optional.
The ValidityNotBefore
value is expressed as an explicit date and time, using the Validity
type value ABSOLUTE
.
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>