Package software.amazon.awscdk.services.certificatemanager

Interface CfnCertificateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCertificateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:32.672Z")
@Stability(Stable)
public interface CfnCertificateProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.certificatemanager.*;
 CfnCertificateProps cfnCertificateProps = CfnCertificateProps.builder()
         .domainName("domainName")
         // the properties below are optional
         .certificateAuthorityArn("certificateAuthorityArn")
         .certificateExport("certificateExport")
         .certificateTransparencyLoggingPreference("certificateTransparencyLoggingPreference")
         .domainValidationOptions(List.of(DomainValidationOptionProperty.builder()
                 .domainName("domainName")
                 // the properties below are optional
                 .hostedZoneId("hostedZoneId")
                 .validationDomain("validationDomain")
                 .build()))
         .keyAlgorithm("keyAlgorithm")
         .subjectAlternativeNames(List.of("subjectAlternativeNames"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .validationMethod("validationMethod")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCertificateProps.Builder	builder()
default String	getCertificateAuthorityArn()	The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate.
default String	getCertificateExport()	You can opt out of allowing export of your certificate by specifying the DISABLED option.
default String	getCertificateTransparencyLoggingPreference()	You can opt out of certificate transparency logging by specifying the DISABLED option.
String	getDomainName()	The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate.
default Object	getDomainValidationOptions()	Domain information that domain name registrars use to verify your identity.
default String	getKeyAlgorithm()	Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.
default List<String>	getSubjectAlternativeNames()	Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate.
default List<CfnTag>	getTags()	Key-value pairs that can identify the certificate.
default String	getValidationMethod()	The method you want to use to validate that you own or control the domain associated with a public certificate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com , site.example.com , and images.example.com..

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainname

getCertificateAuthorityArn

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

The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate.

If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the AWS Private Certificate Authority user guide. The ARN must have the following form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificateauthorityarn

getCertificateExport

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

You can opt out of allowing export of your certificate by specifying the DISABLED option.

Allow export of your certificate by specifying the ENABLED option.

If you do not specify an export preference in a new CloudFormation template, it is the same as explicitly denying export of your certificate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificateexport

getCertificateTransparencyLoggingPreference

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

You can opt out of certificate transparency logging by specifying the DISABLED option.

Opt in by specifying ENABLED . This setting doces not apply to private certificates.

If you do not specify a certificate transparency logging preference on a new CloudFormation template, or if you remove the logging preference from an existing template, this is the same as explicitly enabling the preference.

Changing the certificate transparency logging preference will update the existing resource by calling UpdateCertificateOptions on the certificate. This action will not create a new resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificatetransparencyloggingpreference

getDomainValidationOptions

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

Domain information that domain name registrars use to verify your identity.

In order for a AWS::CertificateManager::Certificate to be provisioned and validated in CloudFormation automatically, the DomainName property needs to be identical to one of the DomainName property supplied in DomainValidationOptions, if the ValidationMethod is DNS. Failing to keep them like-for-like will result in failure to create the domain validation records in Route53.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCertificate.DomainValidationOptionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainvalidationoptions

getKeyAlgorithm

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

Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.

RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some AWS services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the AWS service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms .

Algorithms supported for an ACM certificate request include:

• RSA_2048
• EC_prime256v1
• EC_secp384r1

Other listed algorithms are for imported certificates only. > When you request a private PKI certificate signed by a CA from AWS Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

Default: RSA_2048

See Also:

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

getSubjectAlternativeNames

@Stability(Stable)
@Nullable
default List<String> getSubjectAlternativeNames()

Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate.

For example, you can add www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-subjectalternativenames

getTags

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

Key-value pairs that can identify the certificate.

See Also:

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

getValidationMethod

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

The method you want to use to validate that you own or control the domain associated with a public certificate.

You can validate with DNS or validate with email . We recommend that you use DNS validation.

If not specified, this property defaults to email validation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-validationmethod

builder

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

Returns:

a CfnCertificateProps.Builder of CfnCertificateProps