software.amazon.awscdk.services.certificatemanager

Class CfnCertificate.Builder

java.lang.Object

software.amazon.awscdk.services.certificatemanager.CfnCertificate.Builder

Enclosing class:

CfnCertificate

public static final class CfnCertificate.Builder
extends java.lang.Object

A fluent builder for CfnCertificate.

Method Summary

Modifier and Type	Method and Description
CfnCertificate	build()
CfnCertificate.Builder	certificateAuthorityArn(java.lang.String certificateAuthorityArn) The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate.
CfnCertificate.Builder	certificateTransparencyLoggingPreference(java.lang.String certificateTransparencyLoggingPreference) You can opt out of certificate transparency logging by specifying the `DISABLED` option.
static CfnCertificate.Builder	create(Construct scope, java.lang.String id)
CfnCertificate.Builder	domainName(java.lang.String domainName) The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate.
CfnCertificate.Builder	domainValidationOptions(IResolvable domainValidationOptions) Domain information that domain name registrars use to verify your identity.
CfnCertificate.Builder	domainValidationOptions(java.util.List<? extends java.lang.Object> domainValidationOptions) Domain information that domain name registrars use to verify your identity.
CfnCertificate.Builder	subjectAlternativeNames(java.util.List<java.lang.String> subjectAlternativeNames) Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate.
CfnCertificate.Builder	tags(java.util.List<? extends CfnTag> tags) Key-value pairs that can identify the certificate.
CfnCertificate.Builder	validationMethod(java.lang.String validationMethod) The method you want to use to validate that you own or control the domain associated with a public certificate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnCertificate.Builder create(Construct scope,
                                            java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnCertificate.DomainValidationOptionProperty.Builder.

domainName

public CfnCertificate.Builder domainName(java.lang.String domainName)

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.`.

Parameters:

domainName - 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.`. This parameter is required.

Returns:

this

certificateAuthorityArn

public CfnCertificate.Builder certificateAuthorityArn(java.lang.String certificateAuthorityArn)

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 Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:

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

Parameters:

certificateAuthorityArn - The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. This parameter is required.

Returns:

this

certificateTransparencyLoggingPreference

public CfnCertificate.Builder certificateTransparencyLoggingPreference(java.lang.String certificateTransparencyLoggingPreference)

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.

Parameters:

certificateTransparencyLoggingPreference - You can opt out of certificate transparency logging by specifying the `DISABLED` option. Opt in by specifying `ENABLED` . This parameter is required.

Returns:

this

domainValidationOptions

public CfnCertificate.Builder domainValidationOptions(IResolvable domainValidationOptions)

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.

Parameters:

domainValidationOptions - Domain information that domain name registrars use to verify your identity. This parameter is required.

Returns:

this

domainValidationOptions

public CfnCertificate.Builder domainValidationOptions(java.util.List<? extends java.lang.Object> domainValidationOptions)

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.

Parameters:

domainValidationOptions - Domain information that domain name registrars use to verify your identity. This parameter is required.

Returns:

this

subjectAlternativeNames

public CfnCertificate.Builder subjectAlternativeNames(java.util.List<java.lang.String> subjectAlternativeNames)

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.

Parameters:

subjectAlternativeNames - Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. This parameter is required.

Returns:

this

tags

public CfnCertificate.Builder tags(java.util.List<? extends CfnTag> tags)

Key-value pairs that can identify the certificate.

Parameters:

tags - Key-value pairs that can identify the certificate. This parameter is required.

Returns:

this

validationMethod

public CfnCertificate.Builder validationMethod(java.lang.String validationMethod)

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.

Parameters:

validationMethod - The method you want to use to validate that you own or control the domain associated with a public certificate. This parameter is required.

Returns:

this

build

public CfnCertificate build()