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.74.0 (build 6d08790)",
           date="2023-05-19T23:09:29.749Z")
 @Stability(value=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")
         .certificateTransparencyLoggingPreference("certificateTransparencyLoggingPreference")
         .domainValidationOptions(List.of(DomainValidationOptionProperty.builder()
                 .domainName("domainName")
                 // the properties below are optional
                 .hostedZoneId("hostedZoneId")
                 .validationDomain("validationDomain")
                 .build()))
         .subjectAlternativeNames(List.of("subjectAlternativeNames"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .validationMethod("validationMethod")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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	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 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 Detail

getDomainName

@Stability(value=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.`.

getCertificateAuthorityArn

@Stability(value=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

getCertificateTransparencyLoggingPreference

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

You can opt out of certificate transparency logging by specifying the `DISABLED` option. Opt in by specifying `ENABLED` .

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.

getDomainValidationOptions

@Stability(value=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.

getSubjectAlternativeNames

@Stability(value=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.

getTags

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

Key-value pairs that can identify the certificate.

getValidationMethod

@Stability(value=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.

builder

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

Returns:

a CfnCertificateProps.Builder of CfnCertificateProps