Expand description
Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, a managed database, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).
For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.
To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.
If you’re using the service, you’re probably looking for LightsailClient and Lightsail.
Structs§
- AddOn
Describes an add-on that is enabled for an Amazon Lightsail resource.
- AddOn
Request Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.
An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page.
- Alarm
Describes an alarm.
An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.
- Allocate
Static IpRequest - Allocate
Static IpResult - Attach
Disk Request - Attach
Disk Result - Attach
Instances ToLoad Balancer Request - Attach
Instances ToLoad Balancer Result - Attach
Load Balancer TlsCertificate Request - Attach
Load Balancer TlsCertificate Result - Attach
Static IpRequest - Attach
Static IpResult - Attached
Disk Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot.
- Auto
Snapshot AddOn Request Describes a request to enable or modify the automatic snapshot add-on for an Amazon Lightsail instance or disk.
When you modify the automatic snapshot time for a resource, it is typically effective immediately except under the following conditions:
-
If an automatic snapshot has been created for the current day, and you change the snapshot time to a later time of day, then the new snapshot time will be effective the following day. This ensures that two snapshots are not created for the current day.
-
If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to an earlier time of day, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day.
-
If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to a time that is within 30 minutes from your current time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.
-
If an automatic snapshot is scheduled to be created within 30 minutes from your current time and you change the snapshot time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.
-
- Auto
Snapshot Details Describes an automatic snapshot.
- Availability
Zone Describes an Availability Zone.
- Blueprint
Describes a blueprint (a virtual private server image).
- Bundle
Describes a bundle, which is a set of specs describing your virtual private server (or instance).
- Close
Instance Public Ports Request - Close
Instance Public Ports Result - Cloud
Formation Stack Record Describes a CloudFormation stack record created as a result of the
create cloud formation stack
operation.A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.
- Cloud
Formation Stack Record Source Info Describes the source of a CloudFormation stack record (i.e., the export snapshot record).
- Contact
Method Describes a contact method.
A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.
- Copy
Snapshot Request - Copy
Snapshot Result - Create
Cloud Formation Stack Request - Create
Cloud Formation Stack Result - Create
Contact Method Request - Create
Contact Method Result - Create
Disk From Snapshot Request - Create
Disk From Snapshot Result - Create
Disk Request - Create
Disk Result - Create
Disk Snapshot Request - Create
Disk Snapshot Result - Create
Domain Entry Request - Create
Domain Entry Result - Create
Domain Request - Create
Domain Result - Create
Instance Snapshot Request - Create
Instance Snapshot Result - Create
Instances From Snapshot Request - Create
Instances From Snapshot Result - Create
Instances Request - Create
Instances Result - Create
KeyPair Request - Create
KeyPair Result - Create
Load Balancer Request - Create
Load Balancer Result - Create
Load Balancer TlsCertificate Request - Create
Load Balancer TlsCertificate Result - Create
Relational Database From Snapshot Request - Create
Relational Database From Snapshot Result - Create
Relational Database Request - Create
Relational Database Result - Create
Relational Database Snapshot Request - Create
Relational Database Snapshot Result - Delete
Alarm Request - Delete
Alarm Result - Delete
Auto Snapshot Request - Delete
Auto Snapshot Result - Delete
Contact Method Request - Delete
Contact Method Result - Delete
Disk Request - Delete
Disk Result - Delete
Disk Snapshot Request - Delete
Disk Snapshot Result - Delete
Domain Entry Request - Delete
Domain Entry Result - Delete
Domain Request - Delete
Domain Result - Delete
Instance Request - Delete
Instance Result - Delete
Instance Snapshot Request - Delete
Instance Snapshot Result - Delete
KeyPair Request - Delete
KeyPair Result - Delete
Known Host Keys Request - Delete
Known Host Keys Result - Delete
Load Balancer Request - Delete
Load Balancer Result - Delete
Load Balancer TlsCertificate Request - Delete
Load Balancer TlsCertificate Result - Delete
Relational Database Request - Delete
Relational Database Result - Delete
Relational Database Snapshot Request - Delete
Relational Database Snapshot Result - Destination
Info Describes the destination of a record.
- Detach
Disk Request - Detach
Disk Result - Detach
Instances From Load Balancer Request - Detach
Instances From Load Balancer Result - Detach
Static IpRequest - Detach
Static IpResult - Disable
AddOn Request - Disable
AddOn Result - Disk
Describes a system disk or a block storage disk.
- Disk
Info Describes a disk.
- DiskMap
Describes a block storage disk mapping.
- Disk
Snapshot Describes a block storage disk snapshot.
- Disk
Snapshot Info Describes a disk snapshot.
- Domain
Describes a domain where you are storing recordsets in Lightsail.
- Domain
Entry Describes a domain recordset entry.
- Download
Default KeyPair Request - Download
Default KeyPair Result - Enable
AddOn Request - Enable
AddOn Result - Export
Snapshot Record Describes an export snapshot record.
- Export
Snapshot Record Source Info Describes the source of an export snapshot record.
- Export
Snapshot Request - Export
Snapshot Result - GetActive
Names Request - GetActive
Names Result - GetAlarms
Request - GetAlarms
Result - GetAuto
Snapshots Request - GetAuto
Snapshots Result - GetBlueprints
Request - GetBlueprints
Result - GetBundles
Request - GetBundles
Result - GetCloud
Formation Stack Records Request - GetCloud
Formation Stack Records Result - GetContact
Methods Request - GetContact
Methods Result - GetDisk
Request - GetDisk
Result - GetDisk
Snapshot Request - GetDisk
Snapshot Result - GetDisk
Snapshots Request - GetDisk
Snapshots Result - GetDisks
Request - GetDisks
Result - GetDomain
Request - GetDomain
Result - GetDomains
Request - GetDomains
Result - GetExport
Snapshot Records Request - GetExport
Snapshot Records Result - GetInstance
Access Details Request - GetInstance
Access Details Result - GetInstance
Metric Data Request - GetInstance
Metric Data Result - GetInstance
Port States Request - GetInstance
Port States Result - GetInstance
Request - GetInstance
Result - GetInstance
Snapshot Request - GetInstance
Snapshot Result - GetInstance
Snapshots Request - GetInstance
Snapshots Result - GetInstance
State Request - GetInstance
State Result - GetInstances
Request - GetInstances
Result - GetKey
Pair Request - GetKey
Pair Result - GetKey
Pairs Request - GetKey
Pairs Result - GetLoad
Balancer Metric Data Request - GetLoad
Balancer Metric Data Result - GetLoad
Balancer Request - GetLoad
Balancer Result - GetLoad
Balancer TlsCertificates Request - GetLoad
Balancer TlsCertificates Result - GetLoad
Balancers Request - GetLoad
Balancers Result - GetOperation
Request - GetOperation
Result - GetOperations
ForResource Request - GetOperations
ForResource Result - GetOperations
Request - GetOperations
Result - GetRegions
Request - GetRegions
Result - GetRelational
Database Blueprints Request - GetRelational
Database Blueprints Result - GetRelational
Database Bundles Request - GetRelational
Database Bundles Result - GetRelational
Database Events Request - GetRelational
Database Events Result - GetRelational
Database LogEvents Request - GetRelational
Database LogEvents Result - GetRelational
Database LogStreams Request - GetRelational
Database LogStreams Result - GetRelational
Database Master User Password Request - GetRelational
Database Master User Password Result - GetRelational
Database Metric Data Request - GetRelational
Database Metric Data Result - GetRelational
Database Parameters Request - GetRelational
Database Parameters Result - GetRelational
Database Request - GetRelational
Database Result - GetRelational
Database Snapshot Request - GetRelational
Database Snapshot Result - GetRelational
Database Snapshots Request - GetRelational
Database Snapshots Result - GetRelational
Databases Request - GetRelational
Databases Result - GetStatic
IpRequest - GetStatic
IpResult - GetStatic
IpsRequest - GetStatic
IpsResult - Host
KeyAttributes Describes the public SSH host keys or the RDP certificate.
- Import
KeyPair Request - Import
KeyPair Result - Instance
Describes an instance (a virtual private server).
- Instance
Access Details The parameters for gaining temporary access to one of your Amazon Lightsail instances.
- Instance
Entry Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the
create cloud formation stack
operation.- Instance
Hardware Describes the hardware for the instance.
- Instance
Health Summary Describes information about the health of the instance.
- Instance
Networking Describes monthly data transfer rates and port information for an instance.
- Instance
Port Info Describes information about ports for an Amazon Lightsail instance.
- Instance
Port State Describes open ports on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
- Instance
Snapshot Describes an instance snapshot.
- Instance
Snapshot Info Describes an instance snapshot.
- Instance
State Describes the virtual private server (or instance) status.
- IsVpc
Peered Request - IsVpc
Peered Result - KeyPair
Describes the SSH key pair.
- Lightsail
Client - A client for the Amazon Lightsail API.
- Load
Balancer Describes the Lightsail load balancer.
- Load
Balancer TlsCertificate Describes a load balancer SSL/TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
- Load
Balancer TlsCertificate Domain Validation Option Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.
- Load
Balancer TlsCertificate Domain Validation Record Describes the validation record of each domain name in the SSL/TLS certificate.
- Load
Balancer TlsCertificate Renewal Summary Contains information about the status of Lightsail's managed renewal for the certificate.
- Load
Balancer TlsCertificate Summary Provides a summary of SSL/TLS certificate metadata.
- LogEvent
Describes a database log event.
- Metric
Datapoint Describes the metric data point.
- Monitored
Resource Info Describes resource being monitored by an alarm.
An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.
- Monthly
Transfer Describes the monthly data transfer in and out of your virtual private server (or instance).
- Open
Instance Public Ports Request - Open
Instance Public Ports Result - Operation
Describes the API operation.
- Password
Data The password data for the Windows Server-based instance, including the ciphertext and the key pair name.
- Peer
VpcRequest - Peer
VpcResult - Pending
Maintenance Action Describes a pending database maintenance action.
- Pending
Modified Relational Database Values Describes a pending database value modification.
- Port
Info Describes ports to open on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
- PutAlarm
Request - PutAlarm
Result - PutInstance
Public Ports Request - PutInstance
Public Ports Result - Reboot
Instance Request - Reboot
Instance Result - Reboot
Relational Database Request - Reboot
Relational Database Result - Region
Describes the AWS Region.
- Relational
Database Describes a database.
- Relational
Database Blueprint Describes a database image, or blueprint. A blueprint describes the major engine version of a database.
- Relational
Database Bundle Describes a database bundle. A bundle describes the performance specifications of the database.
- Relational
Database Endpoint Describes an endpoint for a database.
- Relational
Database Event Describes an event for a database.
- Relational
Database Hardware Describes the hardware of a database.
- Relational
Database Parameter Describes the parameters of a database.
- Relational
Database Snapshot Describes a database snapshot.
- Release
Static IpRequest - Release
Static IpResult - Resource
Location Describes the resource location.
- Send
Contact Method Verification Request - Send
Contact Method Verification Result - Start
Instance Request - Start
Instance Result - Start
Relational Database Request - Start
Relational Database Result - Static
Ip Describes the static IP.
- Stop
Instance Request - Stop
Instance Result - Stop
Relational Database Request - Stop
Relational Database Result - Tag
Describes a tag key and optional value assigned to an Amazon Lightsail resource.
For more information about tags in Lightsail, see the Lightsail Dev Guide.
- TagResource
Request - TagResource
Result - Test
Alarm Request - Test
Alarm Result - Unpeer
VpcRequest - Unpeer
VpcResult - Untag
Resource Request - Untag
Resource Result - Update
Domain Entry Request - Update
Domain Entry Result - Update
Load Balancer Attribute Request - Update
Load Balancer Attribute Result - Update
Relational Database Parameters Request - Update
Relational Database Parameters Result - Update
Relational Database Request - Update
Relational Database Result
Enums§
- Allocate
Static IpError - Errors returned by AllocateStaticIp
- Attach
Disk Error - Errors returned by AttachDisk
- Attach
Instances ToLoad Balancer Error - Errors returned by AttachInstancesToLoadBalancer
- Attach
Load Balancer TlsCertificate Error - Errors returned by AttachLoadBalancerTlsCertificate
- Attach
Static IpError - Errors returned by AttachStaticIp
- Close
Instance Public Ports Error - Errors returned by CloseInstancePublicPorts
- Copy
Snapshot Error - Errors returned by CopySnapshot
- Create
Cloud Formation Stack Error - Errors returned by CreateCloudFormationStack
- Create
Contact Method Error - Errors returned by CreateContactMethod
- Create
Disk Error - Errors returned by CreateDisk
- Create
Disk From Snapshot Error - Errors returned by CreateDiskFromSnapshot
- Create
Disk Snapshot Error - Errors returned by CreateDiskSnapshot
- Create
Domain Entry Error - Errors returned by CreateDomainEntry
- Create
Domain Error - Errors returned by CreateDomain
- Create
Instance Snapshot Error - Errors returned by CreateInstanceSnapshot
- Create
Instances Error - Errors returned by CreateInstances
- Create
Instances From Snapshot Error - Errors returned by CreateInstancesFromSnapshot
- Create
KeyPair Error - Errors returned by CreateKeyPair
- Create
Load Balancer Error - Errors returned by CreateLoadBalancer
- Create
Load Balancer TlsCertificate Error - Errors returned by CreateLoadBalancerTlsCertificate
- Create
Relational Database Error - Errors returned by CreateRelationalDatabase
- Create
Relational Database From Snapshot Error - Errors returned by CreateRelationalDatabaseFromSnapshot
- Create
Relational Database Snapshot Error - Errors returned by CreateRelationalDatabaseSnapshot
- Delete
Alarm Error - Errors returned by DeleteAlarm
- Delete
Auto Snapshot Error - Errors returned by DeleteAutoSnapshot
- Delete
Contact Method Error - Errors returned by DeleteContactMethod
- Delete
Disk Error - Errors returned by DeleteDisk
- Delete
Disk Snapshot Error - Errors returned by DeleteDiskSnapshot
- Delete
Domain Entry Error - Errors returned by DeleteDomainEntry
- Delete
Domain Error - Errors returned by DeleteDomain
- Delete
Instance Error - Errors returned by DeleteInstance
- Delete
Instance Snapshot Error - Errors returned by DeleteInstanceSnapshot
- Delete
KeyPair Error - Errors returned by DeleteKeyPair
- Delete
Known Host Keys Error - Errors returned by DeleteKnownHostKeys
- Delete
Load Balancer Error - Errors returned by DeleteLoadBalancer
- Delete
Load Balancer TlsCertificate Error - Errors returned by DeleteLoadBalancerTlsCertificate
- Delete
Relational Database Error - Errors returned by DeleteRelationalDatabase
- Delete
Relational Database Snapshot Error - Errors returned by DeleteRelationalDatabaseSnapshot
- Detach
Disk Error - Errors returned by DetachDisk
- Detach
Instances From Load Balancer Error - Errors returned by DetachInstancesFromLoadBalancer
- Detach
Static IpError - Errors returned by DetachStaticIp
- Disable
AddOn Error - Errors returned by DisableAddOn
- Download
Default KeyPair Error - Errors returned by DownloadDefaultKeyPair
- Enable
AddOn Error - Errors returned by EnableAddOn
- Export
Snapshot Error - Errors returned by ExportSnapshot
- GetActive
Names Error - Errors returned by GetActiveNames
- GetAlarms
Error - Errors returned by GetAlarms
- GetAuto
Snapshots Error - Errors returned by GetAutoSnapshots
- GetBlueprints
Error - Errors returned by GetBlueprints
- GetBundles
Error - Errors returned by GetBundles
- GetCloud
Formation Stack Records Error - Errors returned by GetCloudFormationStackRecords
- GetContact
Methods Error - Errors returned by GetContactMethods
- GetDisk
Error - Errors returned by GetDisk
- GetDisk
Snapshot Error - Errors returned by GetDiskSnapshot
- GetDisk
Snapshots Error - Errors returned by GetDiskSnapshots
- GetDisks
Error - Errors returned by GetDisks
- GetDomain
Error - Errors returned by GetDomain
- GetDomains
Error - Errors returned by GetDomains
- GetExport
Snapshot Records Error - Errors returned by GetExportSnapshotRecords
- GetInstance
Access Details Error - Errors returned by GetInstanceAccessDetails
- GetInstance
Error - Errors returned by GetInstance
- GetInstance
Metric Data Error - Errors returned by GetInstanceMetricData
- GetInstance
Port States Error - Errors returned by GetInstancePortStates
- GetInstance
Snapshot Error - Errors returned by GetInstanceSnapshot
- GetInstance
Snapshots Error - Errors returned by GetInstanceSnapshots
- GetInstance
State Error - Errors returned by GetInstanceState
- GetInstances
Error - Errors returned by GetInstances
- GetKey
Pair Error - Errors returned by GetKeyPair
- GetKey
Pairs Error - Errors returned by GetKeyPairs
- GetLoad
Balancer Error - Errors returned by GetLoadBalancer
- GetLoad
Balancer Metric Data Error - Errors returned by GetLoadBalancerMetricData
- GetLoad
Balancer TlsCertificates Error - Errors returned by GetLoadBalancerTlsCertificates
- GetLoad
Balancers Error - Errors returned by GetLoadBalancers
- GetOperation
Error - Errors returned by GetOperation
- GetOperations
Error - Errors returned by GetOperations
- GetOperations
ForResource Error - Errors returned by GetOperationsForResource
- GetRegions
Error - Errors returned by GetRegions
- GetRelational
Database Blueprints Error - Errors returned by GetRelationalDatabaseBlueprints
- GetRelational
Database Bundles Error - Errors returned by GetRelationalDatabaseBundles
- GetRelational
Database Error - Errors returned by GetRelationalDatabase
- GetRelational
Database Events Error - Errors returned by GetRelationalDatabaseEvents
- GetRelational
Database LogEvents Error - Errors returned by GetRelationalDatabaseLogEvents
- GetRelational
Database LogStreams Error - Errors returned by GetRelationalDatabaseLogStreams
- GetRelational
Database Master User Password Error - Errors returned by GetRelationalDatabaseMasterUserPassword
- GetRelational
Database Metric Data Error - Errors returned by GetRelationalDatabaseMetricData
- GetRelational
Database Parameters Error - Errors returned by GetRelationalDatabaseParameters
- GetRelational
Database Snapshot Error - Errors returned by GetRelationalDatabaseSnapshot
- GetRelational
Database Snapshots Error - Errors returned by GetRelationalDatabaseSnapshots
- GetRelational
Databases Error - Errors returned by GetRelationalDatabases
- GetStatic
IpError - Errors returned by GetStaticIp
- GetStatic
IpsError - Errors returned by GetStaticIps
- Import
KeyPair Error - Errors returned by ImportKeyPair
- IsVpc
Peered Error - Errors returned by IsVpcPeered
- Open
Instance Public Ports Error - Errors returned by OpenInstancePublicPorts
- Peer
VpcError - Errors returned by PeerVpc
- PutAlarm
Error - Errors returned by PutAlarm
- PutInstance
Public Ports Error - Errors returned by PutInstancePublicPorts
- Reboot
Instance Error - Errors returned by RebootInstance
- Reboot
Relational Database Error - Errors returned by RebootRelationalDatabase
- Release
Static IpError - Errors returned by ReleaseStaticIp
- Send
Contact Method Verification Error - Errors returned by SendContactMethodVerification
- Start
Instance Error - Errors returned by StartInstance
- Start
Relational Database Error - Errors returned by StartRelationalDatabase
- Stop
Instance Error - Errors returned by StopInstance
- Stop
Relational Database Error - Errors returned by StopRelationalDatabase
- TagResource
Error - Errors returned by TagResource
- Test
Alarm Error - Errors returned by TestAlarm
- Unpeer
VpcError - Errors returned by UnpeerVpc
- Untag
Resource Error - Errors returned by UntagResource
- Update
Domain Entry Error - Errors returned by UpdateDomainEntry
- Update
Load Balancer Attribute Error - Errors returned by UpdateLoadBalancerAttribute
- Update
Relational Database Error - Errors returned by UpdateRelationalDatabase
- Update
Relational Database Parameters Error - Errors returned by UpdateRelationalDatabaseParameters
Traits§
- Lightsail
- Trait representing the capabilities of the Amazon Lightsail API. Amazon Lightsail clients implement this trait.