CfnLoadBalancerTlsCertificate

java.lang.Object
- 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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.420Z")
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();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnLoadBalancerTlsCertificate.Builder
A fluent builder for CfnLoadBalancerTlsCertificate.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnLoadBalancerTlsCertificate.Builder` A fluent builder for `CfnLoadBalancerTlsCertificate`.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnLoadBalancerTlsCertificate(Construct scope, java.lang.String id, CfnLoadBalancerTlsCertificateProps props)` Create a new `AWS::Lightsail::LoadBalancerTlsCertificate`.
`protected`	`CfnLoadBalancerTlsCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnLoadBalancerTlsCertificate(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrLoadBalancerTlsCertificateArn()` The Amazon Resource Name (ARN) of the SSL/TLS certificate.
`java.lang.String`	`getAttrStatus()` The validation status of the SSL/TLS certificate.
`java.util.List<java.lang.String>`	`getCertificateAlternativeNames()` An array of alternative domain names and subdomain names for your SSL/TLS certificate.
`java.lang.String`	`getCertificateDomainName()` The domain name for the SSL/TLS certificate.
`java.lang.String`	`getCertificateName()` The name of the SSL/TLS certificate.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getHttpsRedirectionEnabled()` A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.
`java.lang.Object`	`getIsAttached()` A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.
`java.lang.String`	`getLoadBalancerName()` The name of the load balancer that the SSL/TLS certificate is attached to.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setCertificateAlternativeNames(java.util.List<java.lang.String> value)` An array of alternative domain names and subdomain names for your SSL/TLS certificate.
`void`	`setCertificateDomainName(java.lang.String value)` The domain name for the SSL/TLS certificate.
`void`	`setCertificateName(java.lang.String value)` The name of the SSL/TLS certificate.
`void`	`setHttpsRedirectionEnabled(java.lang.Boolean value)` A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.
`void`	`setHttpsRedirectionEnabled(IResolvable value)` A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.
`void`	`setIsAttached(java.lang.Boolean value)` A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.
`void`	`setIsAttached(IResolvable value)` A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.
`void`	`setLoadBalancerName(java.lang.String value)` The name of the load balancer that the SSL/TLS certificate is attached to.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnLoadBalancerTlsCertificate
```
protected CfnLoadBalancerTlsCertificate(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnLoadBalancerTlsCertificate
```
protected CfnLoadBalancerTlsCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnLoadBalancerTlsCertificate
```
public CfnLoadBalancerTlsCertificate(Construct scope,
                                     java.lang.String id,
                                     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 Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrLoadBalancerTlsCertificateArn
```
public java.lang.String getAttrLoadBalancerTlsCertificateArn()
```
    The Amazon Resource Name (ARN) of the SSL/TLS certificate.
  - getAttrStatus
```
public java.lang.String getAttrStatus()
```
    The validation status of the SSL/TLS certificate.
    Valid Values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED | UNKNOWN
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getCertificateDomainName
```
public java.lang.String getCertificateDomainName()
```
    The domain name for the SSL/TLS certificate.
    For example, example.com or www.example.com .
  - setCertificateDomainName
```
public void setCertificateDomainName(java.lang.String value)
```
    The domain name for the SSL/TLS certificate.
    For example, example.com or www.example.com .
  - getCertificateName
```
public java.lang.String getCertificateName()
```
    The name of the SSL/TLS certificate.
  - setCertificateName
```
public void setCertificateName(java.lang.String value)
```
    The name of the SSL/TLS certificate.
  - getLoadBalancerName
```
public java.lang.String getLoadBalancerName()
```
    The name of the load balancer that the SSL/TLS certificate is attached to.
  - setLoadBalancerName
```
public void setLoadBalancerName(java.lang.String value)
```
    The name of the load balancer that the SSL/TLS certificate is attached to.
  - getCertificateAlternativeNames
```
public java.util.List<java.lang.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
```
public void setCertificateAlternativeNames(java.util.List<java.lang.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
```
public java.lang.Object getHttpsRedirectionEnabled()
```
    A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.
  - setHttpsRedirectionEnabled
```
public void setHttpsRedirectionEnabled(java.lang.Boolean value)
```
    A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.
  - setHttpsRedirectionEnabled
```
public void setHttpsRedirectionEnabled(IResolvable value)
```
    A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.
  - getIsAttached
```
public java.lang.Object getIsAttached()
```
    A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.
  - setIsAttached
```
public void setIsAttached(java.lang.Boolean value)
```
    A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.
  - setIsAttached
```
public void setIsAttached(IResolvable value)
```
    A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.

Class CfnLoadBalancerTlsCertificate

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnLoadBalancerTlsCertificate

CfnLoadBalancerTlsCertificate

CfnLoadBalancerTlsCertificate

Method Detail

inspect

renderProperties

getAttrLoadBalancerTlsCertificateArn

getAttrStatus

getCfnProperties

getCertificateDomainName

setCertificateDomainName

getCertificateName

setCertificateName

getLoadBalancerName

setLoadBalancerName

getCertificateAlternativeNames

setCertificateAlternativeNames

getHttpsRedirectionEnabled

setHttpsRedirectionEnabled

setHttpsRedirectionEnabled

getIsAttached

setIsAttached

setIsAttached