Skip to main content

@swamp/aws/lightsail

v2026.04.23.3

AWS LIGHTSAIL infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awslightsailcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/lightsail

@swamp/aws/lightsail/alarmv2026.04.23.2alarm.ts

Global Arguments

ArgumentTypeDescription
AlarmNamestringThe name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
MonitoredResourceNamestringThe name of the Lightsail resource that the alarm monitors.
MetricNamestringThe name of the metric to associate with the alarm.
ComparisonOperatorstringThe arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
ContactProtocols?arrayThe contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
DatapointsToAlarm?numberThe number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
EvaluationPeriodsnumberThe number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
NotificationEnabled?booleanIndicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
NotificationTriggers?arrayThe alarm states that trigger a notification.
ThresholdnumberThe value against which the specified statistic is compared.
TreatMissingData?stringSets how this alarm will handle missing data points.
createCreate a Lightsail Alarm
getGet a Lightsail Alarm
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Alarm
updateUpdate a Lightsail Alarm
deleteDelete a Lightsail Alarm
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Alarm
syncSync Lightsail Alarm state from AWS

Resources

state(infinite)— Lightsail Alarm resource state
@swamp/aws/lightsail/bucketv2026.04.23.2bucket.ts

Global Arguments

ArgumentTypeDescription
BucketNamestringThe name for the bucket.
BundleIdstringThe ID of the bundle to use for the bucket.
ObjectVersioning?booleanSpecifies whether to enable or disable versioning of objects in the bucket.
AccessRules?objectAn object that sets the public accessibility of objects in the specified bucket.
ResourcesReceivingAccess?arrayThe names of the Lightsail resources for which to set bucket access.
ReadOnlyAccessAccounts?arrayAn array of strings to specify the AWS account IDs that can access the bucket.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Lightsail Bucket
getGet a Lightsail Bucket
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Bucket
updateUpdate a Lightsail Bucket
deleteDelete a Lightsail Bucket
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Bucket
syncSync Lightsail Bucket state from AWS

Resources

state(infinite)— Lightsail Bucket resource state
@swamp/aws/lightsail/certificatev2026.04.23.2certificate.ts

Global Arguments

ArgumentTypeDescription
CertificateNamestringThe name for the certificate.
DomainNamestringThe domain name (e.g., example.com) for the certificate.
SubjectAlternativeNames?arrayAn array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Lightsail Certificate
getGet a Lightsail Certificate
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Certificate
updateUpdate a Lightsail Certificate
deleteDelete a Lightsail Certificate
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Certificate
syncSync Lightsail Certificate state from AWS

Resources

state(infinite)— Lightsail Certificate resource state
@swamp/aws/lightsail/containerv2026.04.23.2container.ts

Global Arguments

ArgumentTypeDescription
ServiceNamestringThe name for the container service.
PowerstringThe power specification for the container service.
ScalenumberThe scale specification for the container service.
PublicDomainNames?arrayThe public domain names to use with the container service, such as example.com and www.example.com.
ContainerServiceDeployment?objectDescribes a container deployment configuration of an Amazon Lightsail container service.
IsDisabled?booleanA Boolean value to indicate whether the container service is disabled.
PrivateRegistryAccess?objectA Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Lightsail Container
getGet a Lightsail Container
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Container
updateUpdate a Lightsail Container
deleteDelete a Lightsail Container
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Container
syncSync Lightsail Container state from AWS

Resources

state(infinite)— Lightsail Container resource state
@swamp/aws/lightsail/databasev2026.04.23.2database.ts

Global Arguments

ArgumentTypeDescription
RelationalDatabaseNamestringThe name to use for your new Lightsail database resource.
AvailabilityZone?stringThe Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
RelationalDatabaseBlueprintIdstringThe blueprint ID for your new database. A blueprint describes the major engine version of a database.
RelationalDatabaseBundleIdstringThe bundle ID for your new database. A bundle describes the performance specifications for your database.
MasterDatabaseNamestringThe name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource.
MasterUsernamestringThe name for the master user.
MasterUserPassword?stringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
PreferredBackupWindow?stringThe daily time range during which automated backups are created for your new database if automated backups are enabled.
PreferredMaintenanceWindow?stringThe weekly time range during which system maintenance can occur on your new database.
PubliclyAccessible?booleanSpecifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
CaCertificateIdentifier?stringIndicates the certificate that needs to be associated with the database.
BackupRetention?booleanWhen true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
RotateMasterUserPassword?booleanWhen true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password.
RelationalDatabaseParameters?arrayUpdate one or more parameters of the relational database.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Lightsail Database
getGet a Lightsail Database
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Database
updateUpdate a Lightsail Database
deleteDelete a Lightsail Database
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Database
syncSync Lightsail Database state from AWS

Resources

state(infinite)— Lightsail Database resource state
@swamp/aws/lightsail/database-snapshotv2026.04.23.2database_snapshot.ts

Global Arguments

ArgumentTypeDescription
RelationalDatabaseNamestringThe name of the database on which to base your new snapshot.
RelationalDatabaseSnapshotNamestringThe name for your new database snapshot.
Tags?arrayAn array of key-value pairs to apply to this resource.
Location?objectThe Region name and Availability Zone where the database snapshot is located.
createCreate a Lightsail DatabaseSnapshot
getGet a Lightsail DatabaseSnapshot
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail DatabaseSnapshot
updateUpdate a Lightsail DatabaseSnapshot
deleteDelete a Lightsail DatabaseSnapshot
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail DatabaseSnapshot
syncSync Lightsail DatabaseSnapshot state from AWS

Resources

state(infinite)— Lightsail DatabaseSnapshot resource state
@swamp/aws/lightsail/diskv2026.04.23.2disk.ts

Global Arguments

ArgumentTypeDescription
DiskNamestringThe names to use for your new Lightsail disk.
Tags?arrayAn array of key-value pairs to apply to this resource.
AddOns?arrayAn array of objects representing the add-ons to enable for the new instance.
SizeInGbnumberSize of the Lightsail disk
createCreate a Lightsail Disk
getGet a Lightsail Disk
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Disk
updateUpdate a Lightsail Disk
deleteDelete a Lightsail Disk
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Disk
syncSync Lightsail Disk state from AWS

Resources

state(infinite)— Lightsail Disk resource state
@swamp/aws/lightsail/disk-snapshotv2026.04.23.2disk_snapshot.ts

Global Arguments

ArgumentTypeDescription
DiskSnapshotNamestringThe name of the disk snapshot (e.g., my-disk-snapshot).
DiskNamestringThe name of the source disk from which the snapshot was created.
Tags?arrayAn array of key-value pairs to apply to this resource.
Location?objectThe AWS Region and Availability Zone where the disk snapshot was created.
createCreate a Lightsail DiskSnapshot
getGet a Lightsail DiskSnapshot
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail DiskSnapshot
updateUpdate a Lightsail DiskSnapshot
deleteDelete a Lightsail DiskSnapshot
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail DiskSnapshot
syncSync Lightsail DiskSnapshot state from AWS

Resources

state(infinite)— Lightsail DiskSnapshot resource state
@swamp/aws/lightsail/distributionv2026.04.23.2distribution.ts

Global Arguments

ArgumentTypeDescription
DistributionNamestringThe name for the distribution.
BundleIdstringThe bundle ID to use for the distribution.
IpAddressType?stringThe IP address type for the distribution.
CacheBehaviors?arrayAn array of objects that describe the per-path cache behavior for the distribution.
CacheBehaviorSettings?objectAn object that describes the cache behavior settings for the distribution.
DefaultCacheBehaviorobjectAn object that describes the default cache behavior for the distribution.
OriginobjectAn object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.
IsEnabled?booleanIndicates whether the distribution is enabled.
CertificateName?stringThe certificate attached to the Distribution.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Lightsail Distribution
getGet a Lightsail Distribution
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Distribution
updateUpdate a Lightsail Distribution
deleteDelete a Lightsail Distribution
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Distribution
syncSync Lightsail Distribution state from AWS

Resources

state(infinite)— Lightsail Distribution resource state
@swamp/aws/lightsail/domainv2026.04.23.2domain.ts

Global Arguments

ArgumentTypeDescription
DomainNamestringThe name of the domain to manage in Lightsail.
DomainEntries?arrayAn array of key-value pairs containing information about the domain entries.
Location?objectThe AWS Region and Availability Zone where the domain was created (read-only).
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Lightsail Domain
getGet a Lightsail Domain
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Domain
updateUpdate a Lightsail Domain
deleteDelete a Lightsail Domain
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Domain
syncSync Lightsail Domain state from AWS

Resources

state(infinite)— Lightsail Domain resource state
@swamp/aws/lightsail/instancev2026.04.23.2instance.ts

Global Arguments

ArgumentTypeDescription
Hardware?objectHardware of the Instance.
Networking?objectNetworking of the Instance.
InstanceNamestringThe names to use for your new Lightsail instance.
BundleIdstringThe bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).
BlueprintIdstringThe ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints).
AddOns?arrayAn array of objects representing the add-ons to enable for the new instance.
UserData?stringA launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
KeyPairName?stringThe name of your key pair.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Lightsail Instance
getGet a Lightsail Instance
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Instance
updateUpdate a Lightsail Instance
deleteDelete a Lightsail Instance
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail Instance
syncSync Lightsail Instance state from AWS

Resources

state(infinite)— Lightsail Instance resource state
@swamp/aws/lightsail/instance-snapshotv2026.04.23.2instance_snapshot.ts

Global Arguments

ArgumentTypeDescription
InstanceSnapshotNamestringThe name of the snapshot.
InstanceNamestringThe instance from which the snapshot was created.
Location?objectThe region name and Availability Zone where you created the snapshot.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Lightsail InstanceSnapshot
getGet a Lightsail InstanceSnapshot
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail InstanceSnapshot
updateUpdate a Lightsail InstanceSnapshot
deleteDelete a Lightsail InstanceSnapshot
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail InstanceSnapshot
syncSync Lightsail InstanceSnapshot state from AWS

Resources

state(infinite)— Lightsail InstanceSnapshot resource state
@swamp/aws/lightsail/load-balancerv2026.04.23.2load_balancer.ts

Global Arguments

ArgumentTypeDescription
LoadBalancerNamestringThe name of your load balancer.
InstancePortnumberThe instance port where you're creating your load balancer.
IpAddressType?stringThe IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
AttachedInstances?arrayThe names of the instances attached to the load balancer.
HealthCheckPath?stringThe path you provided to perform the load balancer health check. If you didn\
SessionStickinessEnabled?booleanConfiguration option to enable session stickiness.
SessionStickinessLBCookieDurationSeconds?stringConfiguration option to adjust session stickiness cookie duration parameter.
TlsPolicyName?stringThe name of the TLS policy to apply to the load balancer.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Lightsail LoadBalancer
getGet a Lightsail LoadBalancer
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail LoadBalancer
updateUpdate a Lightsail LoadBalancer
deleteDelete a Lightsail LoadBalancer
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail LoadBalancer
syncSync Lightsail LoadBalancer state from AWS

Resources

state(infinite)— Lightsail LoadBalancer resource state
@swamp/aws/lightsail/load-balancer-tls-certificatev2026.04.23.2load_balancer_tls_certificate.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
LoadBalancerNamestringThe name of your load balancer.
CertificateNamestringThe SSL/TLS certificate name.
CertificateDomainNamestringThe domain name (e.g., example.com) for your SSL/TLS certificate.
CertificateAlternativeNames?arrayAn array of strings listing alternative domains and subdomains for your SSL/TLS certificate.
IsAttached?booleanWhen true, the SSL/TLS certificate is attached to the Lightsail load balancer.
HttpsRedirectionEnabled?booleanA Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
createCreate a Lightsail LoadBalancerTlsCertificate
getGet a Lightsail LoadBalancerTlsCertificate
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail LoadBalancerTlsCertificate
updateUpdate a Lightsail LoadBalancerTlsCertificate
deleteDelete a Lightsail LoadBalancerTlsCertificate
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail LoadBalancerTlsCertificate
syncSync Lightsail LoadBalancerTlsCertificate state from AWS

Resources

state(infinite)— Lightsail LoadBalancerTlsCertificate resource state
@swamp/aws/lightsail/static-ipv2026.04.23.2static_ip.ts

Global Arguments

ArgumentTypeDescription
StaticIpNamestringThe name of the static IP address.
AttachedTo?stringThe instance where the static IP is attached.
createCreate a Lightsail StaticIp
getGet a Lightsail StaticIp
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail StaticIp
updateUpdate a Lightsail StaticIp
deleteDelete a Lightsail StaticIp
ArgumentTypeDescription
identifierstringThe primary identifier of the Lightsail StaticIp
syncSync Lightsail StaticIp state from AWS

Resources

state(infinite)— Lightsail StaticIp resource state