software.amazon.awscdk.services.lightsail

Class CfnCertificate

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.CfnCertificate

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.633Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCertificate.Builder A fluent builder for CfnCertificate.

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
	CfnCertificate(software.constructs.Construct scope, String id, CfnCertificateProps props) Create a new `AWS::Lightsail::Certificate`.
protected	CfnCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCertificate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCertificateArn() The Amazon Resource Name (ARN) of the certificate.
String	getAttrStatus() The validation status of the certificate.
String	getCertificateName() The name of the certificate.
protected Map<String,Object>	getCfnProperties()
String	getDomainName() The domain name of the certificate.
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.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCertificateName(String value) The name of the certificate.
void	setDomainName(String value) The domain name of the certificate.
void	setSubjectAlternativeNames(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.

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

CfnCertificate

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

CfnCertificate

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

CfnCertificate

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

getAttrCertificateArn

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

The Amazon Resource Name (ARN) of the certificate.

getAttrStatus

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

The validation status of the certificate.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

The name of the certificate.

setCertificateName

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

The name of the certificate.

getDomainName

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

The domain name of the certificate.

setDomainName

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

The domain name of the certificate.

getSubjectAlternativeNames

@Stability(value=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(value=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.