software.amazon.awscdk.services.certificatemanager

Interface CertificateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DnsValidatedCertificateProps

All Known Implementing Classes:

CertificateProps.Jsii$Proxy, DnsValidatedCertificateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.962Z")
 @Stability(value=Stable)
public interface CertificateProps
extends software.amazon.jsii.JsiiSerializable

Properties for your certificate.

Example:

 HostedZone myHostedZone = HostedZone.Builder.create(this, "HostedZone")
         .zoneName("example.com")
         .build();
 Certificate.Builder.create(this, "Certificate")
         .domainName("hello.example.com")
         .validation(CertificateValidation.fromDns(myHostedZone))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CertificateProps.Builder	builder()
String	getDomainName() Fully-qualified domain name to request a certificate for.
default List<String>	getSubjectAlternativeNames() Alternative domain names on your certificate.
default Boolean	getTransparencyLoggingEnabled() Enable or disable transparency logging for this certificate.
default CertificateValidation	getValidation() How to validate this certificate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDomainName

@Stability(value=Stable)
 @NotNull
String getDomainName()

Fully-qualified domain name to request a certificate for.

May contain wildcards, such as *.domain.com.

getSubjectAlternativeNames

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

Alternative domain names on your certificate.

Use this to register alternative domain names that represent the same site.

Default: - No additional FQDNs will be included as alternative domain names.

getTransparencyLoggingEnabled

@Stability(value=Stable)
 @Nullable
default Boolean getTransparencyLoggingEnabled()

Enable or disable transparency logging for this certificate.

Once a certificate has been logged, it cannot be removed from the log. Opting out at that point will have no effect. If you opt out of logging when you request a certificate and then choose later to opt back in, your certificate will not be logged until it is renewed. If you want the certificate to be logged immediately, we recommend that you issue a new one.

Default: true

See Also:

https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency

getValidation

@Stability(value=Stable)
 @Nullable
default CertificateValidation getValidation()

How to validate this certificate.

Default: CertificateValidation.fromEmail()

builder

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

Returns:

a CertificateProps.Builder of CertificateProps