Crate rusoto_lightsail
source · [−]Expand description
Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported AWS Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the AWS General Reference.
If you’re using the service, you’re probably looking for LightsailClient and Lightsail.
Structs
Describes an add-on that is enabled for an Amazon Lightsail resource.
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.
Describes an alarm.
An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.
Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot.
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.
Describes an automatic snapshot.
Describes an Availability Zone.
Describes a blueprint (a virtual private server image).
Describes a bundle, which is a set of specs describing your virtual private server (or instance).
Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior
is set to cache
, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior
is dont-cache
, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.
if the cacheBehavior's behavior is set to 'cache', then
Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.
These settings apply only to your distribution's cacheBehaviors
(including the defaultCacheBehavior
) that have a behavior
of cache
.
Describes the full details of an Amazon Lightsail SSL/TLS certificate.
To get a summary of a certificate, use the GetCertificates
action and ommit includeCertificateDetails
from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
Describes an Amazon Lightsail SSL/TLS certificate.
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.
Describes the source of a CloudFormation stack record (i.e., the export snapshot record).
Describes a contact method.
A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.
Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
Describes a container image that is registered to an Amazon Lightsail container service.
Describes an Amazon Lightsail container service.
Describes a container deployment configuration of an Amazon Lightsail container service.
A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
Describes a container deployment configuration of an Amazon Lightsail container service.
A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
Describes the public endpoint configuration of a deployment of an Amazon Lightsail container service.
Describes the health check configuration of an Amazon Lightsail container service.
Describes the log events of a container of an Amazon Lightsail container service.
Describes the powers that can be specified for an Amazon Lightsail container service.
The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.
Describes the login information for the container image registry of an Amazon Lightsail account.
Describes the current state of a container service.
Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.
For the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests.
Describes the destination of a record.
Describes a system disk or a block storage disk.
Describes a disk.
Describes a block storage disk mapping.
Describes a block storage disk snapshot.
Describes a disk snapshot.
Describes the specifications of a distribution bundle.
Describes a domain where you are storing recordsets in Lightsail.
Describes a domain recordset entry.
Describes the domain validation records of an Amazon Lightsail SSL/TLS certificate.
Describes the settings of a public endpoint for an Amazon Lightsail container service.
Describes an export snapshot record.
Describes the source of an export snapshot record.
Describes the request headers that a Lightsail distribution bases caching on.
For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg
contain a custom product
header that has a value of either acme
or apex
, and you configure your distribution to cache your content based on values in the product
header. Your distribution forwards the product
header to the origin and caches the response from the origin once for each header value.
Describes the public SSH host keys or the RDP certificate.
Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.
An origin can be a Lightsail instance or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.
Describes an instance (a virtual private server).
The parameters for gaining temporary access to one of your Amazon Lightsail instances.
Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the create cloud formation stack
operation.
Describes the hardware for the instance.
Describes information about the health of the instance.
Describes monthly data transfer rates and port information for an instance.
Describes information about ports for an Amazon Lightsail instance.
Describes open ports on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
Describes an instance snapshot.
Describes an instance snapshot.
Describes the virtual private server (or instance) status.
Describes the SSH key pair.
A client for the Amazon Lightsail API.
Describes an Amazon Lightsail content delivery network (CDN) distribution.
Describes the Lightsail load balancer.
Describes a load balancer SSL/TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.
Describes the validation record of each domain name in the SSL/TLS certificate.
Contains information about the status of Lightsail's managed renewal for the certificate.
The renewal status of the certificate.
The following renewal status are possible:
-
PendingAutoRenewal
- Lightsail is attempting to automatically validate the domain names in the certificate. No further action is required. -
PendingValidation
- Lightsail couldn't automatically validate one or more domain names in the certificate. You must take action to validate these domain names or the certificate won't be renewed. If you used DNS validation, check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use. -
Success
- All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required. -
Failed
- One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using theCreateCertificate
action.
Provides a summary of SSL/TLS certificate metadata.
Describes a database log event.
Describes the metric data point.
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.
Describes the monthly data transfer in and out of your virtual private server (or instance).
Describes the API operation.
Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.
An origin can be a Lightsail instance or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.
The password data for the Windows Server-based instance, including the ciphertext and the key pair name.
Describes a pending database maintenance action.
Describes a pending database value modification.
Describes ports to open on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.
For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.
Describes the AWS Region.
Describes a database.
Describes a database image, or blueprint. A blueprint describes the major engine version of a database.
Describes a database bundle. A bundle describes the performance specifications of the database.
Describes an endpoint for a database.
Describes an event for a database.
Describes the hardware of a database.
Describes the parameters of a database.
Describes a database snapshot.
Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.
Describes the resource location.
Describes the domain name system (DNS) records to add to your domain's DNS to validate it for an Amazon Lightsail certificate.
Describes the static IP.
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.
Enums
Errors returned by AllocateStaticIp
Errors returned by AttachCertificateToDistribution
Errors returned by AttachDisk
Errors returned by AttachInstancesToLoadBalancer
Errors returned by AttachLoadBalancerTlsCertificate
Errors returned by AttachStaticIp
Errors returned by CloseInstancePublicPorts
Errors returned by CopySnapshot
Errors returned by CreateCertificate
Errors returned by CreateCloudFormationStack
Errors returned by CreateContactMethod
Errors returned by CreateContainerServiceDeployment
Errors returned by CreateContainerService
Errors returned by CreateContainerServiceRegistryLogin
Errors returned by CreateDisk
Errors returned by CreateDiskFromSnapshot
Errors returned by CreateDiskSnapshot
Errors returned by CreateDistribution
Errors returned by CreateDomainEntry
Errors returned by CreateDomain
Errors returned by CreateInstanceSnapshot
Errors returned by CreateInstances
Errors returned by CreateInstancesFromSnapshot
Errors returned by CreateKeyPair
Errors returned by CreateLoadBalancer
Errors returned by CreateLoadBalancerTlsCertificate
Errors returned by CreateRelationalDatabase
Errors returned by CreateRelationalDatabaseFromSnapshot
Errors returned by CreateRelationalDatabaseSnapshot
Errors returned by DeleteAlarm
Errors returned by DeleteAutoSnapshot
Errors returned by DeleteCertificate
Errors returned by DeleteContactMethod
Errors returned by DeleteContainerImage
Errors returned by DeleteContainerService
Errors returned by DeleteDisk
Errors returned by DeleteDiskSnapshot
Errors returned by DeleteDistribution
Errors returned by DeleteDomainEntry
Errors returned by DeleteDomain
Errors returned by DeleteInstance
Errors returned by DeleteInstanceSnapshot
Errors returned by DeleteKeyPair
Errors returned by DeleteKnownHostKeys
Errors returned by DeleteLoadBalancer
Errors returned by DeleteLoadBalancerTlsCertificate
Errors returned by DeleteRelationalDatabase
Errors returned by DeleteRelationalDatabaseSnapshot
Errors returned by DetachCertificateFromDistribution
Errors returned by DetachDisk
Errors returned by DetachInstancesFromLoadBalancer
Errors returned by DetachStaticIp
Errors returned by DisableAddOn
Errors returned by DownloadDefaultKeyPair
Errors returned by EnableAddOn
Errors returned by ExportSnapshot
Errors returned by GetActiveNames
Errors returned by GetAlarms
Errors returned by GetAutoSnapshots
Errors returned by GetBlueprints
Errors returned by GetBundles
Errors returned by GetCertificates
Errors returned by GetCloudFormationStackRecords
Errors returned by GetContactMethods
Errors returned by GetContainerAPIMetadata
Errors returned by GetContainerImages
Errors returned by GetContainerLog
Errors returned by GetContainerServiceDeployments
Errors returned by GetContainerServiceMetricData
Errors returned by GetContainerServicePowers
Errors returned by GetContainerServices
Errors returned by GetDisk
Errors returned by GetDiskSnapshot
Errors returned by GetDiskSnapshots
Errors returned by GetDisks
Errors returned by GetDistributionBundles
Errors returned by GetDistributionLatestCacheReset
Errors returned by GetDistributionMetricData
Errors returned by GetDistributions
Errors returned by GetDomain
Errors returned by GetDomains
Errors returned by GetExportSnapshotRecords
Errors returned by GetInstanceAccessDetails
Errors returned by GetInstance
Errors returned by GetInstanceMetricData
Errors returned by GetInstancePortStates
Errors returned by GetInstanceSnapshot
Errors returned by GetInstanceSnapshots
Errors returned by GetInstanceState
Errors returned by GetInstances
Errors returned by GetKeyPair
Errors returned by GetKeyPairs
Errors returned by GetLoadBalancer
Errors returned by GetLoadBalancerMetricData
Errors returned by GetLoadBalancerTlsCertificates
Errors returned by GetLoadBalancers
Errors returned by GetOperation
Errors returned by GetOperations
Errors returned by GetOperationsForResource
Errors returned by GetRegions
Errors returned by GetRelationalDatabaseBlueprints
Errors returned by GetRelationalDatabaseBundles
Errors returned by GetRelationalDatabase
Errors returned by GetRelationalDatabaseEvents
Errors returned by GetRelationalDatabaseLogEvents
Errors returned by GetRelationalDatabaseLogStreams
Errors returned by GetRelationalDatabaseMasterUserPassword
Errors returned by GetRelationalDatabaseMetricData
Errors returned by GetRelationalDatabaseParameters
Errors returned by GetRelationalDatabaseSnapshot
Errors returned by GetRelationalDatabaseSnapshots
Errors returned by GetRelationalDatabases
Errors returned by GetStaticIp
Errors returned by GetStaticIps
Errors returned by ImportKeyPair
Errors returned by IsVpcPeered
Errors returned by OpenInstancePublicPorts
Errors returned by PeerVpc
Errors returned by PutAlarm
Errors returned by PutInstancePublicPorts
Errors returned by RebootInstance
Errors returned by RebootRelationalDatabase
Errors returned by RegisterContainerImage
Errors returned by ReleaseStaticIp
Errors returned by ResetDistributionCache
Errors returned by SendContactMethodVerification
Errors returned by SetIpAddressType
Errors returned by StartInstance
Errors returned by StartRelationalDatabase
Errors returned by StopInstance
Errors returned by StopRelationalDatabase
Errors returned by TagResource
Errors returned by TestAlarm
Errors returned by UnpeerVpc
Errors returned by UntagResource
Errors returned by UpdateContainerService
Errors returned by UpdateDistributionBundle
Errors returned by UpdateDistribution
Errors returned by UpdateDomainEntry
Errors returned by UpdateLoadBalancerAttribute
Errors returned by UpdateRelationalDatabase
Errors returned by UpdateRelationalDatabaseParameters
Traits
Trait representing the capabilities of the Amazon Lightsail API. Amazon Lightsail clients implement this trait.