Interface CfnCertificateProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCertificateProps.Jsii$Proxy
CfnCertificate.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.certificatemanager.*;
CfnCertificateProps cfnCertificateProps = CfnCertificateProps.builder()
.domainName("domainName")
// the properties below are optional
.certificateAuthorityArn("certificateAuthorityArn")
.certificateTransparencyLoggingPreference("certificateTransparencyLoggingPreference")
.domainValidationOptions(List.of(DomainValidationOptionProperty.builder()
.domainName("domainName")
// the properties below are optional
.hostedZoneId("hostedZoneId")
.validationDomain("validationDomain")
.build()))
.keyAlgorithm("keyAlgorithm")
.subjectAlternativeNames(List.of("subjectAlternativeNames"))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.validationMethod("validationMethod")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnCertificatePropsstatic final classAn implementation forCfnCertificateProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnCertificateProps.Builderbuilder()default StringThe Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate.default StringYou can opt out of certificate transparency logging by specifying theDISABLEDoption.The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate.default ObjectDomain information that domain name registrars use to verify your identity.default StringSpecifies the algorithm of the public and private key pair that your certificate uses to encrypt data.Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate.getTags()Key-value pairs that can identify the certificate.default StringThe method you want to use to validate that you own or control the domain associated with a public certificate.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDomainName
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.comprotectswww.example.com,site.example.com, andimages.example.com..- See Also:
-
getCertificateAuthorityArn
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- See Also:
-
getCertificateTransparencyLoggingPreference
You can opt out of certificate transparency logging by specifying theDISABLEDoption. 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
UpdateCertificateOptionson the certificate. This action will not create a new resource.- See Also:
-
getDomainValidationOptions
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
DomainNameproperty needs to be identical to one of theDomainNameproperty 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.- See Also:
-
getKeyAlgorithm
Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some AWS services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the AWS service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms .
Algorithms supported for an ACM certificate request include:
RSA_2048EC_prime256v1EC_secp384r1
Other listed algorithms are for imported certificates only. > When you request a private PKI certificate signed by a CA from AWS Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
Default: RSA_2048
- See Also:
-
getSubjectAlternativeNames
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
DomainNamefield is www.example.com if users can reach your site by using either name.- See Also:
-
getTags
Key-value pairs that can identify the certificate.- See Also:
-
getValidationMethod
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.
- See Also:
-
builder
- Returns:
- a
CfnCertificateProps.BuilderofCfnCertificateProps
-