Package software.amazon.awscdk.services.acmpca

Interface CfnCertificateAuthorityProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCertificateAuthorityProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:10.308Z")
@Stability(Stable)
public interface CfnCertificateAuthorityProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCertificateAuthority.

Example:

 CfnCertificateAuthority cfnCertificateAuthority = CfnCertificateAuthority.Builder.create(this, "CA")
         .type("ROOT")
         .keyAlgorithm("RSA_2048")
         .signingAlgorithm("SHA256WITHRSA")
         .subject(SubjectProperty.builder()
                 .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")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCertificateAuthorityProps.Builder	A builder for CfnCertificateAuthorityProps
static final class	CfnCertificateAuthorityProps.Jsii$Proxy	An implementation for CfnCertificateAuthorityProps

Method Summary

Modifier and Type	Method	Description
static CfnCertificateAuthorityProps.Builder	builder()
default Object	getCsrExtensions()	Specifies information to be added to the extension section of the certificate signing request (CSR).
String	getKeyAlgorithm()	Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.
default String	getKeyStorageSecurityStandard()	Specifies a cryptographic key management compliance standard used for handling CA keys.
default Object	getRevocationConfiguration()	Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.
String	getSigningAlgorithm()	Name of the algorithm your private CA uses to sign certificate requests.
Object	getSubject()	Structure that contains X.500 distinguished name information for your private CA.
default List<CfnTag>	getTags()	Key-value pairs that will be attached to the new private CA.
String	getType()	Type of your private CA.
default String	getUsageMode()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKeyAlgorithm

@Stability(Stable)
@NotNull
String getKeyAlgorithm()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-keyalgorithm

getSigningAlgorithm

@Stability(Stable)
@NotNull
String getSigningAlgorithm()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-signingalgorithm

getSubject

@Stability(Stable)
@NotNull
Object getSubject()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-subject

getType

@Stability(Stable)
@NotNull
String getType()

Type of your private CA.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-type

getCsrExtensions

@Stability(Stable)
@Nullable
default Object getCsrExtensions()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-csrextensions

getKeyStorageSecurityStandard

@Stability(Stable)
@Nullable
default String getKeyStorageSecurityStandard()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-keystoragesecuritystandard

getRevocationConfiguration

@Stability(Stable)
@Nullable
default Object getRevocationConfiguration()

Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-revocationconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-tags

getUsageMode

@Stability(Stable)
@Nullable
default String getUsageMode()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-usagemode

builder

@Stability(Stable)
static CfnCertificateAuthorityProps.Builder builder()

Returns:

a CfnCertificateAuthorityProps.Builder of CfnCertificateAuthorityProps