aws-cdk-lib.aws_acmpca.CfnCertificateProps

interface CfnCertificateProps

LanguageType name
.NETAmazon.CDK.AWS.ACMPCA.CfnCertificateProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsacmpca#CfnCertificateProps
Javasoftware.amazon.awscdk.services.acmpca.CfnCertificateProps
Pythonaws_cdk.aws_acmpca.CfnCertificateProps
TypeScript aws-cdk-lib » aws_acmpca » CfnCertificateProps

Properties for defining a CfnCertificate.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_acmpca as acmpca } from 'aws-cdk-lib';
const cfnCertificateProps: acmpca.CfnCertificateProps = {
  certificateAuthorityArn: 'certificateAuthorityArn',
  certificateSigningRequest: 'certificateSigningRequest',
  signingAlgorithm: 'signingAlgorithm',
  validity: {
    type: 'type',
    value: 123,
  },

  // the properties below are optional
  apiPassthrough: {
    extensions: {
      certificatePolicies: [{
        certPolicyId: 'certPolicyId',

        // the properties below are optional
        policyQualifiers: [{
          policyQualifierId: 'policyQualifierId',
          qualifier: {
            cpsUri: 'cpsUri',
          },
        }],
      }],
      customExtensions: [{
        objectIdentifier: 'objectIdentifier',
        value: 'value',

        // the properties below are optional
        critical: false,
      }],
      extendedKeyUsage: [{
        extendedKeyUsageObjectIdentifier: 'extendedKeyUsageObjectIdentifier',
        extendedKeyUsageType: 'extendedKeyUsageType',
      }],
      keyUsage: {
        crlSign: false,
        dataEncipherment: false,
        decipherOnly: false,
        digitalSignature: false,
        encipherOnly: false,
        keyAgreement: false,
        keyCertSign: false,
        keyEncipherment: false,
        nonRepudiation: false,
      },
      subjectAlternativeNames: [{
        directoryName: {
          commonName: 'commonName',
          country: 'country',
          customAttributes: [{
            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: {
          nameAssigner: 'nameAssigner',
          partyName: 'partyName',
        },
        ipAddress: 'ipAddress',
        otherName: {
          typeId: 'typeId',
          value: 'value',
        },
        registeredId: 'registeredId',
        rfc822Name: 'rfc822Name',
        uniformResourceIdentifier: 'uniformResourceIdentifier',
      }],
    },
    subject: {
      commonName: 'commonName',
      country: 'country',
      customAttributes: [{
        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: {
    type: 'type',
    value: 123,
  },
};

Properties

NameTypeDescription
certificateAuthorityArnstringThe Amazon Resource Name (ARN) for the private CA issues the certificate.
certificateSigningRequeststringThe certificate signing request (CSR) for the certificate.
signingAlgorithmstringThe name of the algorithm that will be used to sign the certificate to be issued.
validityIResolvable | ValidityPropertyThe period of time during which the certificate will be valid.
apiPassthrough?IResolvable | ApiPassthroughPropertySpecifies 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.
templateArn?stringSpecifies a custom configuration template to use when issuing a certificate.
validityNotBefore?IResolvable | ValidityPropertyInformation describing the start of the validity period of the certificate.

certificateAuthorityArn

Type: string

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


certificateSigningRequest

Type: string

The certificate signing request (CSR) for the certificate.


signingAlgorithm

Type: string

The name of the algorithm that will be used to sign the certificate to be issued.

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.


validity

Type: IResolvable | ValidityProperty

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


apiPassthrough?

Type: IResolvable | ApiPassthroughProperty (optional)

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.


templateArn?

Type: string (optional)

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

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 .


validityNotBefore?

Type: IResolvable | ValidityProperty (optional)

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

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 .