Class CfnCertificateProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCertificateProps>
- Enclosing interface:
CfnCertificateProps
CfnCertificateProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.certificateAuthorityArn
(String certificateAuthorityArn) Sets the value ofCfnCertificateProps.getCertificateAuthorityArn()
certificateTransparencyLoggingPreference
(String certificateTransparencyLoggingPreference) Sets the value ofCfnCertificateProps.getCertificateTransparencyLoggingPreference()
domainName
(String domainName) Sets the value ofCfnCertificateProps.getDomainName()
domainValidationOptions
(List<? extends Object> domainValidationOptions) Sets the value ofCfnCertificateProps.getDomainValidationOptions()
domainValidationOptions
(IResolvable domainValidationOptions) Sets the value ofCfnCertificateProps.getDomainValidationOptions()
subjectAlternativeNames
(List<String> subjectAlternativeNames) Sets the value ofCfnCertificateProps.getSubjectAlternativeNames()
Sets the value ofCfnCertificateProps.getTags()
validationMethod
(String validationMethod) Sets the value ofCfnCertificateProps.getValidationMethod()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
domainName
Sets the value ofCfnCertificateProps.getDomainName()
- 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
protectswww.example.com
,site.example.com
, andimages.example.com.
. This parameter is required.- Returns:
this
-
certificateAuthorityArn
@Stability(Stable) public CfnCertificateProps.Builder certificateAuthorityArn(String certificateAuthorityArn) Sets the value ofCfnCertificateProps.getCertificateAuthorityArn()
- Parameters:
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 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
- Returns:
this
-
certificateTransparencyLoggingPreference
@Stability(Stable) public CfnCertificateProps.Builder certificateTransparencyLoggingPreference(String certificateTransparencyLoggingPreference) Sets the value ofCfnCertificateProps.getCertificateTransparencyLoggingPreference()
- Parameters:
certificateTransparencyLoggingPreference
- You can opt out of certificate transparency logging by specifying theDISABLED
option. Opt in by specifyingENABLED
. 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.- Returns:
this
-
domainValidationOptions
@Stability(Stable) public CfnCertificateProps.Builder domainValidationOptions(IResolvable domainValidationOptions) Sets the value ofCfnCertificateProps.getDomainValidationOptions()
- Parameters:
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 theDomainName
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.- Returns:
this
-
domainValidationOptions
@Stability(Stable) public CfnCertificateProps.Builder domainValidationOptions(List<? extends Object> domainValidationOptions) Sets the value ofCfnCertificateProps.getDomainValidationOptions()
- Parameters:
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 theDomainName
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.- Returns:
this
-
subjectAlternativeNames
@Stability(Stable) public CfnCertificateProps.Builder subjectAlternativeNames(List<String> subjectAlternativeNames) Sets the value ofCfnCertificateProps.getSubjectAlternativeNames()
- Parameters:
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 theDomainName
field is www.example.com if users can reach your site by using either name.- Returns:
this
-
tags
Sets the value ofCfnCertificateProps.getTags()
- Parameters:
tags
- Key-value pairs that can identify the certificate.- Returns:
this
-
validationMethod
Sets the value ofCfnCertificateProps.getValidationMethod()
- Parameters:
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.
- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnCertificateProps>
- Returns:
- a new instance of
CfnCertificateProps
- Throws:
NullPointerException
- if any required attribute was not provided
-