Package 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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:43.066Z")
@Stability(Stable)
public interface CertificateProps
extends software.amazon.jsii.JsiiSerializable

Properties for your certificate.

Example:

 import software.amazon.awscdk.services.cloudwatch.*;
 HostedZone myHostedZone;
 Certificate certificate = Certificate.Builder.create(this, "Certificate")
         .domainName("hello.example.com")
         .validation(CertificateValidation.fromDns(myHostedZone))
         .build();
 certificate.metricDaysToExpiry().createAlarm(this, "Alarm", CreateAlarmOptions.builder()
         .comparisonOperator(ComparisonOperator.LESS_THAN_THRESHOLD)
         .evaluationPeriods(1)
         .threshold(45)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 CertificateValidation	getValidation()	How to validate this certificate.
default Map<String,String>	getValidationDomains()	Deprecated. use validation instead.
default ValidationMethod	getValidationMethod()	Deprecated. use validation instead.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

Fully-qualified domain name to request a certificate for.

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

getSubjectAlternativeNames

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

getValidation

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

How to validate this certificate.

Default: CertificateValidation.fromEmail()

getValidationDomains

@Stability(Deprecated)
@Deprecated
@Nullable
default Map<String,String> getValidationDomains()

Deprecated.

use validation instead.

(deprecated) What validation domain to use for every requested domain.

Has to be a superdomain of the requested domain.

Default: - Apex domain is used for every domain that's not overridden.

getValidationMethod

@Stability(Deprecated)
@Deprecated
@Nullable
default ValidationMethod getValidationMethod()

Deprecated.

use validation instead.

(deprecated) Validation method used to assert domain ownership.

Default: ValidationMethod.EMAIL

builder

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

Returns:

a CertificateProps.Builder of CertificateProps