Class DnsValidatedCertificateProps.Builder
java.lang.Object
software.amazon.awscdk.services.certificatemanager.DnsValidatedCertificateProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<DnsValidatedCertificateProps>
- Enclosing interface:
DnsValidatedCertificateProps
@Stability(Stable)
public static final class DnsValidatedCertificateProps.Builder
extends Object
implements software.amazon.jsii.Builder<DnsValidatedCertificateProps>
A builder for
DnsValidatedCertificateProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.certificateName
(String certificateName) Sets the value ofCertificateProps.getCertificateName()
cleanupRoute53Records
(Boolean cleanupRoute53Records) Sets the value ofDnsValidatedCertificateProps.getCleanupRoute53Records()
customResourceRole
(IRole customResourceRole) Sets the value ofDnsValidatedCertificateProps.getCustomResourceRole()
domainName
(String domainName) Sets the value ofCertificateProps.getDomainName()
hostedZone
(IHostedZone hostedZone) Sets the value ofDnsValidatedCertificateProps.getHostedZone()
keyAlgorithm
(KeyAlgorithm keyAlgorithm) Sets the value ofCertificateProps.getKeyAlgorithm()
Sets the value ofDnsValidatedCertificateProps.getRegion()
route53Endpoint
(String route53Endpoint) Sets the value ofDnsValidatedCertificateProps.getRoute53Endpoint()
subjectAlternativeNames
(List<String> subjectAlternativeNames) Sets the value ofCertificateProps.getSubjectAlternativeNames()
transparencyLoggingEnabled
(Boolean transparencyLoggingEnabled) Sets the value ofCertificateProps.getTransparencyLoggingEnabled()
validation
(CertificateValidation validation) Sets the value ofCertificateProps.getValidation()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
hostedZone
Sets the value ofDnsValidatedCertificateProps.getHostedZone()
- Parameters:
hostedZone
- Route 53 Hosted Zone used to perform DNS validation of the request. This parameter is required. The zone must be authoritative for the domain name specified in the Certificate Request.- Returns:
this
-
cleanupRoute53Records
@Stability(Stable) public DnsValidatedCertificateProps.Builder cleanupRoute53Records(Boolean cleanupRoute53Records) Sets the value ofDnsValidatedCertificateProps.getCleanupRoute53Records()
- Parameters:
cleanupRoute53Records
- When set to true, when the DnsValidatedCertificate is deleted, the associated Route53 validation records are removed. CAUTION: If multiple certificates share the same domains (and same validation records), this can cause the other certificates to fail renewal and/or not validate. Not recommended for production use.- Returns:
this
-
customResourceRole
@Stability(Stable) public DnsValidatedCertificateProps.Builder customResourceRole(IRole customResourceRole) Sets the value ofDnsValidatedCertificateProps.getCustomResourceRole()
- Parameters:
customResourceRole
- Role to use for the custom resource that creates the validated certificate.- Returns:
this
-
region
Sets the value ofDnsValidatedCertificateProps.getRegion()
- Parameters:
region
- AWS region that will host the certificate. This is needed especially for certificates used for CloudFront distributions, which require the region to be us-east-1.- Returns:
this
-
route53Endpoint
@Stability(Stable) public DnsValidatedCertificateProps.Builder route53Endpoint(String route53Endpoint) Sets the value ofDnsValidatedCertificateProps.getRoute53Endpoint()
- Parameters:
route53Endpoint
- An endpoint of Route53 service, which is not necessary as AWS SDK could figure out the right endpoints for most regions, but for some regions such as those in aws-cn partition, the default endpoint is not working now, hence the right endpoint need to be specified through this prop. Route53 is not been officially launched in China, it is only available for AWS internal accounts now. To make DnsValidatedCertificate work for internal accounts now, a special endpoint needs to be provided.- Returns:
this
-
domainName
Sets the value ofCertificateProps.getDomainName()
- Parameters:
domainName
- Fully-qualified domain name to request a certificate for. This parameter is required. May contain wildcards, such as*.domain.com
.- Returns:
this
-
certificateName
@Stability(Stable) public DnsValidatedCertificateProps.Builder certificateName(String certificateName) Sets the value ofCertificateProps.getCertificateName()
- Parameters:
certificateName
- The Certificate name. Since the Certificate resource doesn't support providing a physical name, the value provided here will be recorded in theName
tag- Returns:
this
-
keyAlgorithm
@Stability(Stable) public DnsValidatedCertificateProps.Builder keyAlgorithm(KeyAlgorithm keyAlgorithm) Sets the value ofCertificateProps.getKeyAlgorithm()
- Parameters:
keyAlgorithm
- Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.- Returns:
this
-
subjectAlternativeNames
@Stability(Stable) public DnsValidatedCertificateProps.Builder subjectAlternativeNames(List<String> subjectAlternativeNames) Sets the value ofCertificateProps.getSubjectAlternativeNames()
- Parameters:
subjectAlternativeNames
- Alternative domain names on your certificate. Use this to register alternative domain names that represent the same site.- Returns:
this
-
transparencyLoggingEnabled
@Stability(Stable) public DnsValidatedCertificateProps.Builder transparencyLoggingEnabled(Boolean transparencyLoggingEnabled) Sets the value ofCertificateProps.getTransparencyLoggingEnabled()
- Parameters:
transparencyLoggingEnabled
- 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.- Returns:
this
-
validation
@Stability(Stable) public DnsValidatedCertificateProps.Builder validation(CertificateValidation validation) Sets the value ofCertificateProps.getValidation()
- Parameters:
validation
- How to validate this certificate.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<DnsValidatedCertificateProps>
- Returns:
- a new instance of
DnsValidatedCertificateProps
- Throws:
NullPointerException
- if any required attribute was not provided
-