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.

Note

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Lightsail::Certificate",
  "Properties" : {
      "CertificateName" : String,
      "DomainName" : String,
      "SubjectAlternativeNames" : [ String, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Lightsail::Certificate
Properties:
  CertificateName: String
  DomainName: String
  SubjectAlternativeNames: 
    - String
  Tags: 
    - Tag

Properties

CertificateName

The name of the certificate.

Required: Yes

Type: String

Update requires: Replacement

DomainName

The domain name of the certificate.

Required: Yes

Type: String

Update requires: Updates are not supported.

SubjectAlternativeNames

An array of strings that specify the alternate domains (such as example.org) and subdomains (such as blog.example.com) of the certificate.

Required: No

Type: Array of String

Update requires: Updates are not supported.

Tags

An array of key-value pairs to apply to this resource.

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

Note

The Value of Tags is optional for Lightsail resources.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a unique identifier for this resource.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CertificateArn

The Amazon Resource Name (ARN) of the certificate.

Status

The validation status of the certificate.