Package software.amazon.awscdk.services.certificatemanager

Class CfnCertificate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.certificatemanager.CfnCertificate
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.074Z") @Stability(Stable) public class CfnCertificate extends CfnResource implements IInspectable
A CloudFormation AWS::CertificateManager::Certificate.

The AWS::CertificateManager::Certificate resource requests an AWS Certificate Manager ( ACM ) certificate that you can use to enable secure connections. For example, you can deploy an ACM certificate to an Elastic Load Balancer to enable HTTPS support. For more information, see RequestCertificate in the AWS Certificate Manager API Reference.

When you use the AWS::CertificateManager::Certificate resource in a CloudFormation stack, domain validation is handled automatically if all three of the following are true: The certificate domain is hosted in Amazon Route 53, the domain resides in your AWS account , and you are using DNS validation.

However, if the certificate uses email validation, or if the domain is not hosted in Route 53, then the stack will remain in the CREATE_IN_PROGRESS state. Further stack operations are delayed until you validate the certificate request, either by acting upon the instructions in the validation email, or by adding a CNAME record to your DNS configuration. For more information, see Option 1: DNS Validation and Option 2: Email Validation .

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.*;
 CfnCertificate cfnCertificate = CfnCertificate.Builder.create(this, "MyCfnCertificate")
         .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()))
         .subjectAlternativeNames(List.of("subjectAlternativeNames"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .validationMethod("validationMethod")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCertificate

      protected CfnCertificate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCertificate

      protected CfnCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCertificate

      @Stability(Stable) public CfnCertificate(@NotNull Construct scope, @NotNull String id, @NotNull CfnCertificateProps props)
      Create a new AWS::CertificateManager::Certificate.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Key-value pairs that can identify the certificate.

    • getDomainName

      @Stability(Stable) @NotNull public String 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.com protects www.example.com , site.example.com , and images.example.com..

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      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..

    • getCertificateAuthorityArn

      @Stability(Stable) @Nullable public String 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

    • setCertificateAuthorityArn

      @Stability(Stable) public void setCertificateAuthorityArn(@Nullable String value)
      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

    • getCertificateTransparencyLoggingPreference

      @Stability(Stable) @Nullable public String getCertificateTransparencyLoggingPreference()
      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.

    • setCertificateTransparencyLoggingPreference

      @Stability(Stable) public void setCertificateTransparencyLoggingPreference(@Nullable String value)
      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.

    • getDomainValidationOptions

      @Stability(Stable) @Nullable public Object 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 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.

    • setDomainValidationOptions

      @Stability(Stable) public void setDomainValidationOptions(@Nullable IResolvable value)
      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.

    • setDomainValidationOptions

      @Stability(Stable) public void setDomainValidationOptions(@Nullable List<Object> value)
      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.

    • getSubjectAlternativeNames

      @Stability(Stable) @Nullable public List<String> 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 DomainName field is www.example.com if users can reach your site by using either name.

    • setSubjectAlternativeNames

      @Stability(Stable) public void setSubjectAlternativeNames(@Nullable List<String> value)
      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.

    • getValidationMethod

      @Stability(Stable) @Nullable public String 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.

    • setValidationMethod

      @Stability(Stable) public void setValidationMethod(@Nullable String value)
      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.