Class CfnCertificate

The AWS::ACMPCA::Certificate resource is used to issue a certificate using your private certificate authority.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnCertificate

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.ACMPCA

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCertificate : CfnResource, IInspectable

Syntax (vb)

Public Class CfnCertificate Inherits CfnResource Implements IInspectable

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

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)

The AWS::ACMPCA::Certificate resource is used to issue a certificate using your private certificate authority.

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.
AttrArn	The Amazon Resource Name (ARN) of the issued certificate.
AttrCertificate	The issued Base64 PEM-encoded certificate.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CertificateAuthorityArn	The Amazon Resource Name (ARN) for the private CA issues the certificate.
CertificateSigningRequest	The certificate signing request (CSR) for the certificate.
CfnProperties	The AWS::ACMPCA::Certificate resource is used to issue a certificate using your private certificate authority.
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>)	The AWS::ACMPCA::Certificate resource is used to issue a certificate using your private certificate authority.

Constructors

CfnCertificate(Construct, string, ICfnCertificateProps)

The AWS::ACMPCA::Certificate resource is used to issue a certificate using your private certificate authority.

public CfnCertificate(Construct scope, string id, ICfnCertificateProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnCertificateProps

Resource properties.

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

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

object

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

AttrArn

The Amazon Resource Name (ARN) of the issued certificate.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCertificate

The issued Base64 PEM-encoded certificate.

public virtual string AttrCertificate { get; }

Property Value

string

Remarks

CloudformationAttribute: Certificate

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

CertificateAuthorityArn

The Amazon Resource Name (ARN) for the private CA issues the certificate.

public virtual string CertificateAuthorityArn { get; set; }

Property Value

string

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

CertificateSigningRequest

The certificate signing request (CSR) for the certificate.

public virtual string CertificateSigningRequest { get; set; }

Property Value

string

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::ACMPCA::Certificate resource is used to issue a certificate using your private certificate authority.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

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

string

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

TemplateArn

Specifies a custom configuration template to use when issuing a certificate.

public virtual string? TemplateArn { get; set; }

Property Value

string

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

Validity

The period of time during which the certificate will be valid.

public virtual object Validity { get; set; }

Property Value

object

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

ValidityNotBefore

Information describing the start of the validity period of the certificate.

public virtual object? ValidityNotBefore { get; set; }

Property Value

object

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

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.

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::ACMPCA::Certificate resource is used to issue a certificate using your private certificate authority.

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

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

For more information, see the IssueCertificate action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html

CloudformationResource: AWS::ACMPCA::Certificate

ExampleMetadata: fixture=_generated

Implements

IInspectable