Package software.amazon.awscdk.services.lightsail

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.lightsail.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:29:59.712Z") @Stability(Stable) public class CfnCertificate extends CfnResource implements IInspectable
A CloudFormation AWS::Lightsail::Certificate.

The AWS::Lightsail::Certificate resource specifies an SSL/TLS certificate that you can use with a content delivery network (CDN) distribution and a container service.

For information about certificates that you can use with a load balancer, see AWS::Lightsail::LoadBalancerTlsCertificate .

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.lightsail.*;
 CfnCertificate cfnCertificate = CfnCertificate.Builder.create(this, "MyCfnCertificate")
         .certificateName("certificateName")
         .domainName("domainName")
         // the properties below are optional
         .subjectAlternativeNames(List.of("subjectAlternativeNames"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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::Lightsail::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.

    • getAttrCertificateArn

      @Stability(Stable) @NotNull public String getAttrCertificateArn()
      The Amazon Resource Name (ARN) of the certificate.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The validation status of the certificate.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag in the AWS CloudFormation User Guide .

      The Value of Tags is optional for Lightsail resources.

    • getCertificateName

      @Stability(Stable) @NotNull public String getCertificateName()
      The name of the certificate.

    • setCertificateName

      @Stability(Stable) public void setCertificateName(@NotNull String value)
      The name of the certificate.

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The domain name of the certificate.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The domain name of the certificate.

    • getSubjectAlternativeNames

      @Stability(Stable) @Nullable public List<String> getSubjectAlternativeNames()
      An array of strings that specify the alternate domains (such as example.org ) and subdomains (such as blog.example.com ) of the certificate.

    • setSubjectAlternativeNames

      @Stability(Stable) public void setSubjectAlternativeNames(@Nullable List<String> value)
      An array of strings that specify the alternate domains (such as example.org ) and subdomains (such as blog.example.com ) of the certificate.