1.204.0

interface CfnCertificateAuthorityProps

LanguageType name
.NETAmazon.CDK.AWS.ACMPCA.CfnCertificateAuthorityProps
Javasoftware.amazon.awscdk.services.acmpca.CfnCertificateAuthorityProps
Pythonaws_cdk.aws_acmpca.CfnCertificateAuthorityProps
TypeScript @aws-cdk/aws-acmpca » CfnCertificateAuthorityProps

Properties for defining a CfnCertificateAuthority.

Example

const cfnCertificateAuthority = new acmpca.CfnCertificateAuthority(this, 'CA', {
  type: 'ROOT',
  keyAlgorithm: 'RSA_2048',
  signingAlgorithm: 'SHA256WITHRSA',
  subject: {
    country: 'US',
    organization: 'string',
    organizationalUnit: 'string',
    distinguishedNameQualifier: 'string',
    state: 'string',
    commonName: '123',
    serialNumber: 'string',
    locality: 'string',
    title: 'string',
    surname: 'string',
    givenName: 'string',
    initials: 'DG',
    pseudonym: 'string',
    generationQualifier: 'DBG',
  },
});

Properties

NameTypeDescription
keyAlgorithmstringType of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.
signingAlgorithmstringName of the algorithm your private CA uses to sign certificate requests.
subjectIResolvable | SubjectPropertyStructure that contains X.500 distinguished name information for your private CA.
typestringType of your private CA.
csrExtensions?IResolvable | CsrExtensionsPropertySpecifies information to be added to the extension section of the certificate signing request (CSR).
keyStorageSecurityStandard?stringSpecifies a cryptographic key management compliance standard used for handling CA keys.
revocationConfiguration?IResolvable | RevocationConfigurationPropertyCertificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate in the AWS Private CA API Reference and Setting up a certificate revocation method in the AWS Private CA User Guide .
tags?CfnTag[]Key-value pairs that will be attached to the new private CA.
usageMode?stringSpecifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly.

keyAlgorithm

Type: string

Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.

When you create a subordinate CA, you must use a key algorithm supported by the parent CA.

signingAlgorithm

Type: string

Name of the algorithm your private CA uses to sign certificate requests.

This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.

subject

Type: IResolvable | SubjectProperty

Structure that contains X.500 distinguished name information for your private CA.

type

Type: string

Type of your private CA.

csrExtensions?

Type: IResolvable | CsrExtensionsProperty (optional)

Specifies information to be added to the extension section of the certificate signing request (CSR).

keyStorageSecurityStandard?

Type: string (optional)

Specifies a cryptographic key management compliance standard used for handling CA keys.

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

Some AWS Regions do not support the default. When creating a CA in these Regions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for KeyStorageSecurityStandard . Failure to do this results in an InvalidArgsException with the message, "A certificate authority cannot be created in this region with the specified security standard."

For information about security standard support in various Regions, see Storage and security compliance of AWS Private CA private keys .

revocationConfiguration?

Type: IResolvable | RevocationConfigurationProperty (optional)

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate in the AWS Private CA API Reference and Setting up a certificate revocation method in the AWS Private CA User Guide .

The following requirements apply to revocation configurations.

  • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
  • In a CRL configuration, the S3BucketName parameter must conform to the Amazon S3 bucket naming rules .
  • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
  • In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

tags?

Type: CfnTag[] (optional)

Key-value pairs that will be attached to the new private CA.

You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags .

usageMode?

Type: string (optional)

Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly.

Short-lived certificate validity is limited to seven days.

The default value is GENERAL_PURPOSE.

← PreviousNext →