Package software.amazon.awscdk.services.lightsail

Class CfnLoadBalancerTlsCertificate

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.CfnLoadBalancerTlsCertificate
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.769Z") @Stability(Stable) public class CfnLoadBalancerTlsCertificate extends CfnResource implements IInspectable
A CloudFormation AWS::Lightsail::LoadBalancerTlsCertificate.

The AWS::Lightsail::LoadBalancerTlsCertificate resource specifies a TLS certificate that can be used with a Lightsail load balancer.

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.*;
 CfnLoadBalancerTlsCertificate cfnLoadBalancerTlsCertificate = CfnLoadBalancerTlsCertificate.Builder.create(this, "MyCfnLoadBalancerTlsCertificate")
         .certificateDomainName("certificateDomainName")
         .certificateName("certificateName")
         .loadBalancerName("loadBalancerName")
         // the properties below are optional
         .certificateAlternativeNames(List.of("certificateAlternativeNames"))
         .httpsRedirectionEnabled(false)
         .isAttached(false)
         .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

    • CfnLoadBalancerTlsCertificate

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

    • CfnLoadBalancerTlsCertificate

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

    • CfnLoadBalancerTlsCertificate

      @Stability(Stable) public CfnLoadBalancerTlsCertificate(@NotNull Construct scope, @NotNull String id, @NotNull CfnLoadBalancerTlsCertificateProps props)
      Create a new AWS::Lightsail::LoadBalancerTlsCertificate.

      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.

    • getAttrLoadBalancerTlsCertificateArn

      @Stability(Stable) @NotNull public String getAttrLoadBalancerTlsCertificateArn()
      The Amazon Resource Name (ARN) of the SSL/TLS certificate.

    • getAttrStatus

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

      Valid Values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED | UNKNOWN

    • getCfnProperties

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

    • getCertificateDomainName

      @Stability(Stable) @NotNull public String getCertificateDomainName()
      The domain name for the SSL/TLS certificate.

      For example, example.com or www.example.com .

    • setCertificateDomainName

      @Stability(Stable) public void setCertificateDomainName(@NotNull String value)
      The domain name for the SSL/TLS certificate.

      For example, example.com or www.example.com .

    • getCertificateName

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

    • setCertificateName

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

    • getLoadBalancerName

      @Stability(Stable) @NotNull public String getLoadBalancerName()
      The name of the load balancer that the SSL/TLS certificate is attached to.

    • setLoadBalancerName

      @Stability(Stable) public void setLoadBalancerName(@NotNull String value)
      The name of the load balancer that the SSL/TLS certificate is attached to.

    • getCertificateAlternativeNames

      @Stability(Stable) @Nullable public List<String> getCertificateAlternativeNames()
      An array of alternative domain names and subdomain names for your SSL/TLS certificate.

      In addition to the primary domain name, you can have up to nine alternative domain names. Wildcards (such as *.example.com ) are not supported.

    • setCertificateAlternativeNames

      @Stability(Stable) public void setCertificateAlternativeNames(@Nullable List<String> value)
      An array of alternative domain names and subdomain names for your SSL/TLS certificate.

      In addition to the primary domain name, you can have up to nine alternative domain names. Wildcards (such as *.example.com ) are not supported.

    • getHttpsRedirectionEnabled

      @Stability(Stable) @Nullable public Object getHttpsRedirectionEnabled()
      A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.

    • setHttpsRedirectionEnabled

      @Stability(Stable) public void setHttpsRedirectionEnabled(@Nullable Boolean value)
      A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.

    • setHttpsRedirectionEnabled

      @Stability(Stable) public void setHttpsRedirectionEnabled(@Nullable IResolvable value)
      A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.

    • getIsAttached

      @Stability(Stable) @Nullable public Object getIsAttached()
      A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.

    • setIsAttached

      @Stability(Stable) public void setIsAttached(@Nullable Boolean value)
      A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.

    • setIsAttached

      @Stability(Stable) public void setIsAttached(@Nullable IResolvable value)
      A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.