The `AWS::Lightsail::Alarm` resource specifies an alarm that can be used to monitor a single metric for one of your Lightsail resources.

CfnAlarm

alarmName

The arithmetic operation to use when comparing the specified statistic and threshold.

comparisonOperator

The number of periods over which data is compared to the specified threshold.

evaluationPeriods

The name of the metric associated with the alarm.

metricName

The name of the Lightsail resource that the alarm monitors.

monitoredResourceName

The value against which the specified statistic is compared.

threshold

The contact protocols for the alarm, such as `Email` , `SMS` (text messaging), or both.

*Allowed Values* : `Email` | `SMS`

contactProtocols

The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the `ALARM` state.

datapointsToAlarm

A Boolean value indicating whether the alarm is enabled.

notificationEnabled

The alarm states that trigger a notification.

> To specify the `OK` and `INSUFFICIENT_DATA` values, you must also specify `ContactProtocols` values. Otherwise, the `OK` and `INSUFFICIENT_DATA` values will not take effect and the stack will drift.

*Allowed Values* : `OK` | `ALARM` | `INSUFFICIENT_DATA`

notificationTriggers

Specifies how the alarm handles missing data points.

An alarm can treat missing data in the following ways:

- `breaching` - Assumes the missing data is not within the threshold. Missing data counts towards the number of times that the metric is not within the threshold.
- `notBreaching` - Assumes the missing data is within the threshold. Missing data does not count towards the number of times that the metric is not within the threshold.
- `ignore` - Ignores the missing data. Maintains the current alarm state.
- `missing` - Missing data is treated as missing.

treatMissingData

The `AWS::Lightsail::Bucket` resource specifies a bucket.

CfnBucket

bucketName

The bundle ID for the bucket (for example, `small_1_0` ).

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

bundleId

An object that describes the access rules for the bucket.

accessRules

Indicates whether object versioning is enabled for the bucket.

The following options can be configured:

- `Enabled` - Object versioning is enabled.
- `Suspended` - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.
- `NeverEnabled` - Object versioning has never been enabled.

objectVersioning

An array of AWS account IDs that have read-only access to the bucket.

readOnlyAccessAccounts

An array of Lightsail instances that have access to the bucket.

resourcesReceivingAccess

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

For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .

> The `Value` of `Tags` is optional for Lightsail resources.

CfnCertificate

certificateName

domainName

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

subjectAlternativeNames

The `AWS::Lightsail::Container` resource specifies a container service.

A Lightsail container service is a compute resource to which you can deploy containers.

CfnContainer

The power specification of the container service.

The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

power

The scale specification of the container service.

The scale specifies the allocated compute nodes of the container service.

scale

serviceName

An object that describes the current container deployment of the container service.

containerServiceDeployment

A Boolean value indicating whether the container service is disabled.

isDisabled

An object that describes the configuration for the container service to access private container image repositories, such as  ( Amazon ECR ) private repositories.

For more information, see [Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access) in the *Amazon Lightsail Developer Guide* .

privateRegistryAccess

The public domain name of the container service, such as `example.com` and `www.example.com` .

You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container that is configured as the public endpoint of your container service.

If you don't specify public domain names, then you can use the default domain of the container service.

> You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the [AWS::Lightsail::Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html) resource to create a certificate for the public domain names that you want to use with your container service.

publicDomainNames

The `AWS::Lightsail::Database` resource specifies an Amazon Lightsail database.

CfnDatabase

The meaning of this parameter differs according to the database engine you use.

*MySQL*

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.

Constraints:

- Must contain 1-64 letters or numbers.
- Must begin with a letter. Subsequent characters can be letters, underscores, or numbers (0-9).
- Can't be a word reserved by the specified database engine.

For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for [MySQL 5.6](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/5.6/en/keywords.html) , [MySQL 5.7](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/5.7/en/keywords.html) , and [MySQL 8.0](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/8.0/en/keywords.html) .

*PostgreSQL*

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named `postgres` is created in the database resource.

Constraints:

- Must contain 1-63 letters or numbers.
- Must begin with a letter. Subsequent characters can be letters, underscores, or numbers (0-9).
- Can't be a word reserved by the specified database engine.

For more information about reserved words in PostgreSQL, see the SQL Key Words articles for [PostgreSQL 9.6](https://docs.aws.amazon.com/https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html) , [PostgreSQL 10](https://docs.aws.amazon.com/https://www.postgresql.org/docs/10/sql-keywords-appendix.html) , [PostgreSQL 11](https://docs.aws.amazon.com/https://www.postgresql.org/docs/11/sql-keywords-appendix.html) , and [PostgreSQL 12](https://docs.aws.amazon.com/https://www.postgresql.org/docs/12/sql-keywords-appendix.html) .

masterDatabaseName

The name for the primary user.

*MySQL*

Constraints:

- Required for MySQL.
- Must be 1-16 letters or numbers. Can contain underscores.
- First character must be a letter.
- Can't be a reserved word for the chosen database engine.

For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for [MySQL 5.6](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/5.6/en/keywords.html) , [MySQL 5.7](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/5.7/en/keywords.html) , or [MySQL 8.0](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/8.0/en/keywords.html) .

*PostgreSQL*

Constraints:

- Required for PostgreSQL.
- Must be 1-63 letters or numbers. Can contain underscores.
- First character must be a letter.
- Can't be a reserved word for the chosen database engine.

For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for [PostgreSQL 9.6](https://docs.aws.amazon.com/https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html) , [PostgreSQL 10](https://docs.aws.amazon.com/https://www.postgresql.org/docs/10/sql-keywords-appendix.html) , [PostgreSQL 11](https://docs.aws.amazon.com/https://www.postgresql.org/docs/11/sql-keywords-appendix.html) , and [PostgreSQL 12](https://docs.aws.amazon.com/https://www.postgresql.org/docs/12/sql-keywords-appendix.html) .

masterUsername

The blueprint ID for the database (for example, `mysql_8_0` ).

relationalDatabaseBlueprintId

The bundle ID for the database (for example, `medium_1_0` ).

relationalDatabaseBundleId

relationalDatabaseName

availabilityZone

A Boolean value indicating whether automated backup retention is enabled for the database.

Data Import Mode is enabled when `BackupRetention` is set to `false` , and is disabled when `BackupRetention` is set to `true` .

backupRetention

The certificate associated with the database.

caCertificateIdentifier

The password for the primary user of the database.

The password can include any printable ASCII character except the following: /, ", or

masterUserPassword

The daily time range during which automated backups are created for the database (for example, `16:00-16:30` ).

preferredBackupWindow

The weekly time range during which system maintenance can occur for the database, formatted as follows: `ddd:hh24:mi-ddd:hh24:mi` .

For example, `Tue:17:00-Tue:17:30` .

preferredMaintenanceWindow

A Boolean value indicating whether the database is accessible to anyone on the internet.

publiclyAccessible

relationalDatabaseParameters

A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .

> The `RotateMasterUserPassword` and `MasterUserPassword` parameters cannot be used together in the same template.

rotateMasterUserPassword

Resource Type definition for AWS::Lightsail::DatabaseSnapshot.

CfnDatabaseSnapshot

The name of the database on which to base your new snapshot.

relationalDatabaseSnapshotName

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

The `AWS::Lightsail::Disk` resource specifies a disk that can be attached to an Amazon Lightsail instance that is in the same AWS Region and Availability Zone.

CfnDisk

diskName

sizeInGb

An array of add-ons for the disk.

> If the disk has an add-on enabled when performing a delete disk request, the add-on is automatically disabled before the disk is deleted.

addOns

The AWS Region and Availability Zone location for the disk (for example, `us-east-1a` ).

The AWS Region and Availability Zone where the disk is located.

location

CfnDiskSnapshot

The name of the disk snapshot ( `my-disk-snapshot` ).

diskSnapshotName

The tag keys and optional values for the resource.

For more information about tags in Lightsail, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags) .

The `AWS::Lightsail::Distribution` resource specifies a content delivery network (CDN) distribution.

You can create distributions only in the `us-east-1` AWS Region.

A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance, static content hosted on a Lightsail bucket, or through a Lightsail load balancer.

CfnDistribution

The ID of the bundle applied to the distribution.

An object that describes the default cache behavior of the distribution.

defaultCacheBehavior

distributionName

An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

origin

An array of objects that describe the per-path cache behavior of the distribution.

cacheBehaviors

An object that describes the cache behavior settings of the distribution.

cacheBehaviorSettings

The name of the SSL/TLS certificate attached to the distribution.

The IP address type of the distribution.

The possible values are `ipv4` for IPv4 only, and `dualstack` for IPv4 and IPv6.

ipAddressType

A Boolean value indicating whether the distribution is enabled.

isEnabled

Describes a domain where you are storing recordsets.

CfnDomain

The fully qualified domain name in the certificate request.

An array of key-value pairs containing information about the domain entries.

domainEntries

The `AWS::Lightsail::Instance` resource specifies an Amazon Lightsail instance.

CfnInstance

The blueprint ID for the instance (for example, `os_amlinux_2016_03` ).

blueprintId

The bundle ID for the instance (for example, `micro_1_0` ).

instanceName

An array of add-ons for the instance.

> If the instance has an add-on enabled when performing a delete instance request, the add-on is automatically disabled before the instance is deleted.

The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.

> The instance restarts when performing an attach disk or detach disk request. This resets the public IP address of your instance if a static IP isn't attached to it.

hardware

The name of the key pair to use for the instance.

If no key pair name is specified, the Regional Lightsail default key pair is used.

keyPairName

The location for the instance, such as the AWS Region and Availability Zone.

> The `Location` property is read-only and should not be specified in a create instance or update instance request.

The public ports and the monthly amount of data transfer allocated for the instance.

networking

The status code and the state (for example, `running` ) of the instance.

> The `State` property is read-only and should not be specified in a create instance or update instance request.

state

The optional launch script for the instance.

Specify a launch script to configure an instance with additional user data. For example, you might want to specify `apt-get -y update` as a launch script.

> Depending on the blueprint of your instance, the command to get software on your instance varies. Amazon Linux and CentOS use `yum` , Debian and Ubuntu use `apt-get` , and FreeBSD uses `pkg` .

userData

CfnInstanceSnapshot

The name the user gave the instance ( `Amazon_Linux_2023-1` ).

instanceSnapshotName

The `AWS::Lightsail::LoadBalancer` resource specifies a load balancer that can be used with Lightsail instances.

> You cannot attach a TLS certificate to a load balancer using the `AWS::Lightsail::LoadBalancer` resource type. Instead, use the `AWS::Lightsail::LoadBalancerTlsCertificate` resource type to create a certificate and attach it to a load balancer.

CfnLoadBalancer

The port that the load balancer uses to direct traffic to your Lightsail instances.

For HTTP traffic, specify port `80` . For HTTPS traffic, specify port `443` .

instancePort

loadBalancerName

The Lightsail instances to attach to the load balancer.

attachedInstances

The path on the attached instance where the health check will be performed.

If no path is specified, the load balancer tries to make a request to the default (root) page ( `/index.html` ).

healthCheckPath

The IP address type of the load balancer.

The possible values are `ipv4` for IPv4 only, and `dualstack` for both IPv4 and IPv6.

A Boolean value indicating whether session stickiness is enabled.

Enable session stickiness (also known as *session affinity* ) to bind a user's session to a specific instance. This ensures that all requests from the user during the session are sent to the same instance.

sessionStickinessEnabled

The time period, in seconds, after which the load balancer session stickiness cookie should be considered stale.

If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.

sessionStickinessLbCookieDurationSeconds

The name of the TLS security policy for the load balancer.

tlsPolicyName

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

CfnLoadBalancerTlsCertificate

The domain name for the SSL/TLS certificate.

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

certificateDomainName

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

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.

certificateAlternativeNames

A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.

httpsRedirectionEnabled

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

isAttached

The `AWS::Lightsail::StaticIp` resource specifies a static IP that can be attached to an Amazon Lightsail instance that is in the same AWS Region and Availability Zone.

CfnStaticIp

staticIpName

The instance that the static IP is attached to.

AWS lightsail

L1 Constructs15