software.amazon.awscdk.services.lightsail

Class CfnLoadBalancerTlsCertificate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lightsail.CfnLoadBalancerTlsCertificate

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.669Z")
 @Stability(value=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();
 

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLoadBalancerTlsCertificate(software.constructs.Construct scope, 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

Modifier and Type	Method and Description
String	getAttrLoadBalancerTlsCertificateArn() The Amazon Resource Name (ARN) of the SSL/TLS certificate.
String	getAttrStatus() The validation status of the SSL/TLS certificate.
List<String>	getCertificateAlternativeNames() An array of alternative domain names and subdomain names for your SSL/TLS certificate.
String	getCertificateDomainName() The domain name for the SSL/TLS certificate.
String	getCertificateName() The name of the SSL/TLS certificate.
protected Map<String,Object>	getCfnProperties()
Object	getHttpsRedirectionEnabled() A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.
Object	getIsAttached() A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCertificateAlternativeNames(List<String> value) An array of alternative domain names and subdomain names for your SSL/TLS certificate.
void	setCertificateDomainName(String value) The domain name for the SSL/TLS certificate.
void	setCertificateName(String value) The name of the SSL/TLS certificate.
void	setHttpsRedirectionEnabled(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(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(String value) The name of the load balancer that the SSL/TLS certificate is attached to.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnLoadBalancerTlsCertificate(@NotNull
                                                              software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrLoadBalancerTlsCertificateArn()

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

getAttrStatus

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCertificateDomainName

@Stability(value=Stable)
 @NotNull
public String getCertificateDomainName()

The domain name for the SSL/TLS certificate.

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

setCertificateDomainName

@Stability(value=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(value=Stable)
 @NotNull
public String getCertificateName()

The name of the SSL/TLS certificate.

setCertificateName

@Stability(value=Stable)
public void setCertificateName(@NotNull
                                                        String value)

The name of the SSL/TLS certificate.

getLoadBalancerName

@Stability(value=Stable)
 @NotNull
public String getLoadBalancerName()

The name of the load balancer that the SSL/TLS certificate is attached to.

setLoadBalancerName

@Stability(value=Stable)
public void setLoadBalancerName(@NotNull
                                                         String value)

The name of the load balancer that the SSL/TLS certificate is attached to.

getCertificateAlternativeNames

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

A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.

setIsAttached

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

A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.