Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).
The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.
Class: AWS.Lightsail
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Lightsail
- Identifier:
- lightsail
- API Version:
- 2016-11-28
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service 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.
Sending a Request Using Lightsail
var lightsail = new AWS.Lightsail();
lightsail.allocateStaticIp(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Lightsail object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var lightsail = new AWS.Lightsail({apiVersion: '2016-11-28'});
You can also set the API version globally in AWS.config.apiVersions
using
the lightsail service identifier:
AWS.config.apiVersions = {
lightsail: '2016-11-28',
// other service API versions
};
var lightsail = new AWS.Lightsail();
Version:
-
2016-11-28
Constructor Summary collapse
-
new AWS.Lightsail(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
allocateStaticIp(params = {}, callback) ⇒ AWS.Request
Allocates a static IP address.
-
attachCertificateToDistribution(params = {}, callback) ⇒ AWS.Request
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
-
attachDisk(params = {}, callback) ⇒ AWS.Request
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
-
attachInstancesToLoadBalancer(params = {}, callback) ⇒ AWS.Request
Attaches one or more Lightsail instances to a load balancer.
-
attachLoadBalancerTlsCertificate(params = {}, callback) ⇒ AWS.Request
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
-
attachStaticIp(params = {}, callback) ⇒ AWS.Request
Attaches a static IP address to a specific Amazon Lightsail instance.
-
closeInstancePublicPorts(params = {}, callback) ⇒ AWS.Request
Closes ports for a specific Amazon Lightsail instance.
-
copySnapshot(params = {}, callback) ⇒ AWS.Request
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot.
-
createCertificate(params = {}, callback) ⇒ AWS.Request
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
-
createCloudFormationStack(params = {}, callback) ⇒ AWS.Request
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot.
-
createContactMethod(params = {}, callback) ⇒ AWS.Request
Creates an email or SMS text message contact method.
-
createContainerService(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Lightsail container service.
-
createContainerServiceDeployment(params = {}, callback) ⇒ AWS.Request
Creates a deployment for your Amazon Lightsail container service.
-
createContainerServiceRegistryLogin(params = {}, callback) ⇒ AWS.Request
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine.
-
createDisk(params = {}, callback) ⇒ AWS.Request
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).
-
createDiskFromSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a block storage disk from a manual or automatic snapshot of a disk.
-
createDiskSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a snapshot of a block storage disk.
-
createDistribution(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Lightsail content delivery network (CDN) distribution.
-
createDomain(params = {}, callback) ⇒ AWS.Request
Creates a domain resource for the specified domain (e.g., example.com).
-
createDomainEntry(params = {}, callback) ⇒ AWS.Request
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
-
createInstances(params = {}, callback) ⇒ AWS.Request
Creates one or more Amazon Lightsail instances.
-
createInstancesFromSnapshot(params = {}, callback) ⇒ AWS.Request
Creates one or more new instances from a manual or automatic snapshot of an instance.
-
createInstanceSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a snapshot of a specific virtual private server, or instance.
-
createKeyPair(params = {}, callback) ⇒ AWS.Request
Creates an SSH key pair.
-
createLoadBalancer(params = {}, callback) ⇒ AWS.Request
Creates a Lightsail load balancer.
-
createLoadBalancerTlsCertificate(params = {}, callback) ⇒ AWS.Request
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
-
createRelationalDatabase(params = {}, callback) ⇒ AWS.Request
Creates a new database in Amazon Lightsail.
-
createRelationalDatabaseFromSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a new database from an existing database snapshot in Amazon Lightsail.
-
createRelationalDatabaseSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a snapshot of your database in Amazon Lightsail.
-
deleteAlarm(params = {}, callback) ⇒ AWS.Request
Deletes an alarm.
-
deleteAutoSnapshot(params = {}, callback) ⇒ AWS.Request
Deletes an automatic snapshot of an instance or disk.
-
deleteCertificate(params = {}, callback) ⇒ AWS.Request
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
-
deleteContactMethod(params = {}, callback) ⇒ AWS.Request
Deletes a contact method.
-
deleteContainerImage(params = {}, callback) ⇒ AWS.Request
Deletes a container image that is registered to your Amazon Lightsail container service.
-
deleteContainerService(params = {}, callback) ⇒ AWS.Request
Deletes your Amazon Lightsail container service.
-
deleteDisk(params = {}, callback) ⇒ AWS.Request
Deletes the specified block storage disk.
-
deleteDiskSnapshot(params = {}, callback) ⇒ AWS.Request
Deletes the specified disk snapshot.
-
deleteDistribution(params = {}, callback) ⇒ AWS.Request
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
-
deleteDomain(params = {}, callback) ⇒ AWS.Request
Deletes the specified domain recordset and all of its domain records.
-
deleteDomainEntry(params = {}, callback) ⇒ AWS.Request
Deletes a specific domain entry.
-
deleteInstance(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Lightsail instance.
-
deleteInstanceSnapshot(params = {}, callback) ⇒ AWS.Request
Deletes a specific snapshot of a virtual private server (or instance).
-
deleteKeyPair(params = {}, callback) ⇒ AWS.Request
Deletes a specific SSH key pair.
-
deleteKnownHostKeys(params = {}, callback) ⇒ AWS.Request
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance.
-
deleteLoadBalancer(params = {}, callback) ⇒ AWS.Request
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.
-
deleteLoadBalancerTlsCertificate(params = {}, callback) ⇒ AWS.Request
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
-
deleteRelationalDatabase(params = {}, callback) ⇒ AWS.Request
Deletes a database in Amazon Lightsail.
-
deleteRelationalDatabaseSnapshot(params = {}, callback) ⇒ AWS.Request
Deletes a database snapshot in Amazon Lightsail.
-
detachCertificateFromDistribution(params = {}, callback) ⇒ AWS.Request
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
-
detachDisk(params = {}, callback) ⇒ AWS.Request
Detaches a stopped block storage disk from a Lightsail instance.
-
detachInstancesFromLoadBalancer(params = {}, callback) ⇒ AWS.Request
Detaches the specified instances from a Lightsail load balancer.
-
detachStaticIp(params = {}, callback) ⇒ AWS.Request
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
-
disableAddOn(params = {}, callback) ⇒ AWS.Request
Disables an add-on for an Amazon Lightsail resource.
-
downloadDefaultKeyPair(params = {}, callback) ⇒ AWS.Request
Downloads the default SSH key pair from the user's account.
-
enableAddOn(params = {}, callback) ⇒ AWS.Request
Enables or modifies an add-on for an Amazon Lightsail resource.
-
exportSnapshot(params = {}, callback) ⇒ AWS.Request
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
-
getActiveNames(params = {}, callback) ⇒ AWS.Request
Returns the names of all active (not deleted) resources.
-
getAlarms(params = {}, callback) ⇒ AWS.Request
Returns information about the configured alarms.
-
getAutoSnapshots(params = {}, callback) ⇒ AWS.Request
Returns the available automatic snapshots for an instance or disk.
-
getBlueprints(params = {}, callback) ⇒ AWS.Request
Returns the list of available instance images, or blueprints.
-
getBundles(params = {}, callback) ⇒ AWS.Request
Returns the list of bundles that are available for purchase.
-
getCertificates(params = {}, callback) ⇒ AWS.Request
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
-
getCloudFormationStackRecords(params = {}, callback) ⇒ AWS.Request
Returns the CloudFormation stack record created as a result of the create cloud formation stack operation.
-
getContactMethods(params = {}, callback) ⇒ AWS.Request
Returns information about the configured contact methods.
-
getContainerAPIMetadata(params = {}, callback) ⇒ AWS.Request
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
-
getContainerImages(params = {}, callback) ⇒ AWS.Request
Returns the container images that are registered to your Amazon Lightsail container service.
-
getContainerLog(params = {}, callback) ⇒ AWS.Request
Returns the log events of a container of your Amazon Lightsail container service.
-
getContainerServiceDeployments(params = {}, callback) ⇒ AWS.Request
Returns the deployments for your 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.
-
getContainerServiceMetricData(params = {}, callback) ⇒ AWS.Request
Returns the data points of a specific metric of your Amazon Lightsail container service.
-
getContainerServicePowers(params = {}, callback) ⇒ AWS.Request
Returns the list of powers that can be specified for your Amazon Lightsail container services.
-
getContainerServices(params = {}, callback) ⇒ AWS.Request
Returns information about one or more of your Amazon Lightsail container services.
-
getDisk(params = {}, callback) ⇒ AWS.Request
Returns information about a specific block storage disk.
-
getDisks(params = {}, callback) ⇒ AWS.Request
Returns information about all block storage disks in your AWS account and region.
-
getDiskSnapshot(params = {}, callback) ⇒ AWS.Request
Returns information about a specific block storage disk snapshot.
-
getDiskSnapshots(params = {}, callback) ⇒ AWS.Request
Returns information about all block storage disk snapshots in your AWS account and region.
-
getDistributionBundles(params = {}, callback) ⇒ AWS.Request
Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions.
-
getDistributionLatestCacheReset(params = {}, callback) ⇒ AWS.Request
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
-
getDistributionMetricData(params = {}, callback) ⇒ AWS.Request
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
-
getDistributions(params = {}, callback) ⇒ AWS.Request
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
-
getDomain(params = {}, callback) ⇒ AWS.Request
Returns information about a specific domain recordset.
-
getDomains(params = {}, callback) ⇒ AWS.Request
Returns a list of all domains in the user's account.
-
getExportSnapshotRecords(params = {}, callback) ⇒ AWS.Request
Returns the export snapshot record created as a result of the export snapshot operation.
-
getInstance(params = {}, callback) ⇒ AWS.Request
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
-
getInstanceAccessDetails(params = {}, callback) ⇒ AWS.Request
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
-
getInstanceMetricData(params = {}, callback) ⇒ AWS.Request
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
-
getInstancePortStates(params = {}, callback) ⇒ AWS.Request
Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
-
getInstances(params = {}, callback) ⇒ AWS.Request
Returns information about all Amazon Lightsail virtual private servers, or instances.
-
getInstanceSnapshot(params = {}, callback) ⇒ AWS.Request
Returns information about a specific instance snapshot.
-
getInstanceSnapshots(params = {}, callback) ⇒ AWS.Request
Returns all instance snapshots for the user's account.
-
getInstanceState(params = {}, callback) ⇒ AWS.Request
Returns the state of a specific instance.
-
getKeyPair(params = {}, callback) ⇒ AWS.Request
Returns information about a specific key pair.
-
getKeyPairs(params = {}, callback) ⇒ AWS.Request
Returns information about all key pairs in the user's account.
-
getLoadBalancer(params = {}, callback) ⇒ AWS.Request
Returns information about the specified Lightsail load balancer.
-
getLoadBalancerMetricData(params = {}, callback) ⇒ AWS.Request
Returns information about health metrics for your Lightsail load balancer.
-
getLoadBalancers(params = {}, callback) ⇒ AWS.Request
Returns information about all load balancers in an account.
-
getLoadBalancerTlsCertificates(params = {}, callback) ⇒ AWS.Request
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
-
getOperation(params = {}, callback) ⇒ AWS.Request
Returns information about a specific operation.
-
getOperations(params = {}, callback) ⇒ AWS.Request
Returns information about all operations.
-
getOperationsForResource(params = {}, callback) ⇒ AWS.Request
Gets operations for a specific resource (e.g., an instance or a static IP).
-
getRegions(params = {}, callback) ⇒ AWS.Request
Returns a list of all valid regions for Amazon Lightsail.
-
getRelationalDatabase(params = {}, callback) ⇒ AWS.Request
Returns information about a specific database in Amazon Lightsail.
-
getRelationalDatabaseBlueprints(params = {}, callback) ⇒ AWS.Request
Returns a list of available database blueprints in Amazon Lightsail.
-
getRelationalDatabaseBundles(params = {}, callback) ⇒ AWS.Request
Returns the list of bundles that are available in Amazon Lightsail.
-
getRelationalDatabaseEvents(params = {}, callback) ⇒ AWS.Request
Returns a list of events for a specific database in Amazon Lightsail.
-
getRelationalDatabaseLogEvents(params = {}, callback) ⇒ AWS.Request
Returns a list of log events for a database in Amazon Lightsail.
-
getRelationalDatabaseLogStreams(params = {}, callback) ⇒ AWS.Request
Returns a list of available log streams for a specific database in Amazon Lightsail.
-
getRelationalDatabaseMasterUserPassword(params = {}, callback) ⇒ AWS.Request
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
-
getRelationalDatabaseMetricData(params = {}, callback) ⇒ AWS.Request
Returns the data points of the specified metric for a database in Amazon Lightsail.
-
getRelationalDatabaseParameters(params = {}, callback) ⇒ AWS.Request
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
-
getRelationalDatabases(params = {}, callback) ⇒ AWS.Request
Returns information about all of your databases in Amazon Lightsail.
-
getRelationalDatabaseSnapshot(params = {}, callback) ⇒ AWS.Request
Returns information about a specific database snapshot in Amazon Lightsail.
-
getRelationalDatabaseSnapshots(params = {}, callback) ⇒ AWS.Request
Returns information about all of your database snapshots in Amazon Lightsail.
-
getStaticIp(params = {}, callback) ⇒ AWS.Request
Returns information about a specific static IP.
-
getStaticIps(params = {}, callback) ⇒ AWS.Request
Returns information about all static IPs in the user's account.
-
importKeyPair(params = {}, callback) ⇒ AWS.Request
Imports a public SSH key from a specific key pair.
-
isVpcPeered(params = {}, callback) ⇒ AWS.Request
Returns a Boolean value indicating whether your Lightsail VPC is peered.
-
openInstancePublicPorts(params = {}, callback) ⇒ AWS.Request
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.
-
peerVpc(params = {}, callback) ⇒ AWS.Request
Tries to peer the Lightsail VPC with the user's default VPC.
-
putAlarm(params = {}, callback) ⇒ AWS.Request
Creates or updates an alarm, and associates it with the specified metric.
-
putInstancePublicPorts(params = {}, callback) ⇒ AWS.Request
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.
-
rebootInstance(params = {}, callback) ⇒ AWS.Request
Restarts a specific instance.
-
rebootRelationalDatabase(params = {}, callback) ⇒ AWS.Request
Restarts a specific database in Amazon Lightsail.
-
registerContainerImage(params = {}, callback) ⇒ AWS.Request
Registers a container image to your Amazon Lightsail container service.
-
releaseStaticIp(params = {}, callback) ⇒ AWS.Request
Deletes a specific static IP from your account.
-
resetDistributionCache(params = {}, callback) ⇒ AWS.Request
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
-
sendContactMethodVerification(params = {}, callback) ⇒ AWS.Request
Sends a verification request to an email contact method to ensure it's owned by the requester.
-
setIpAddressType(params = {}, callback) ⇒ AWS.Request
Sets the IP address type for an Amazon Lightsail resource.
-
startInstance(params = {}, callback) ⇒ AWS.Request
Starts a specific Amazon Lightsail instance from a stopped state.
-
startRelationalDatabase(params = {}, callback) ⇒ AWS.Request
Starts a specific database from a stopped state in Amazon Lightsail.
-
stopInstance(params = {}, callback) ⇒ AWS.Request
Stops a specific Amazon Lightsail instance that is currently running.
-
stopRelationalDatabase(params = {}, callback) ⇒ AWS.Request
Stops a specific database that is currently running in Amazon Lightsail.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Adds one or more tags to the specified Amazon Lightsail resource.
-
testAlarm(params = {}, callback) ⇒ AWS.Request
Tests an alarm by displaying a banner on the Amazon Lightsail console.
-
unpeerVpc(params = {}, callback) ⇒ AWS.Request
Attempts to unpeer the Lightsail VPC from the user's default VPC.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
-
updateContainerService(params = {}, callback) ⇒ AWS.Request
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
-
updateDistribution(params = {}, callback) ⇒ AWS.Request
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
-
updateDistributionBundle(params = {}, callback) ⇒ AWS.Request
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
-
updateDomainEntry(params = {}, callback) ⇒ AWS.Request
Updates a domain recordset after it is created.
-
updateLoadBalancerAttribute(params = {}, callback) ⇒ AWS.Request
Updates the specified attribute for a load balancer.
-
updateRelationalDatabase(params = {}, callback) ⇒ AWS.Request
Allows the update of one or more attributes of a database in Amazon Lightsail.
-
updateRelationalDatabaseParameters(params = {}, callback) ⇒ AWS.Request
Allows the update of one or more parameters of a database in Amazon Lightsail.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.Lightsail(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a Lightsail object
var lightsail = new AWS.Lightsail({apiVersion: '2016-11-28'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.Lightsail.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.Lightsail.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.Lightsail.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
computeChecksums
(Boolean)
—
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
-
convertResponseTypes
(Boolean)
—
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to
true
. -
correctClockSkew
(Boolean)
—
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to
false
. -
s3ForcePathStyle
(Boolean)
—
whether to force path style URLs for S3 objects.
-
s3BucketEndpoint
(Boolean)
—
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an
endpoint
to be provided explicitly to the service constructor. -
s3DisableBodySigning
(Boolean)
—
whether S3 body signing should be disabled when using signature version
v4
. Body signing can only be disabled when using https. Defaults totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
Property Details
Method Details
allocateStaticIp(params = {}, callback) ⇒ AWS.Request
Allocates a static IP address.
Service Reference:
Examples:
Calling the allocateStaticIp operation
var params = {
staticIpName: 'STRING_VALUE' /* required */
};
lightsail.allocateStaticIp(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
staticIpName
— (String
)The name of the static IP address.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
attachCertificateToDistribution(params = {}, callback) ⇒ AWS.Request
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.
Use the CreateCertificate
action to create a certificate that you can attach to your distribution.
Only certificates created in the us-east-1
AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1
Region.
Service Reference:
Examples:
Calling the attachCertificateToDistribution operation
var params = {
certificateName: 'STRING_VALUE', /* required */
distributionName: 'STRING_VALUE' /* required */
};
lightsail.attachCertificateToDistribution(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
distributionName
— (String
)The name of the distribution that the certificate will be attached to.
Use the
GetDistributions
action to get a list of distribution names that you can specify.certificateName
— (String
)The name of the certificate to attach to a distribution.
Only certificates with a status of
ISSUED
can be attached to a distribution.Use the
GetCertificates
action to get a list of certificate names that you can specify.Note: This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might beWordPress-Blog-Certificate
and the domain name of the certificate might beexample.com
.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operation
— (map
)An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
attachDisk(params = {}, callback) ⇒ AWS.Request
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
The attach disk
operation supports tag-based access control via resource tags applied to the resource identified by disk name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the attachDisk operation
var params = {
diskName: 'STRING_VALUE', /* required */
diskPath: 'STRING_VALUE', /* required */
instanceName: 'STRING_VALUE' /* required */
};
lightsail.attachDisk(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
diskName
— (String
)The unique Lightsail disk name (e.g.,
my-disk
).instanceName
— (String
)The name of the Lightsail instance where you want to utilize the storage disk.
diskPath
— (String
)The disk path to expose to the instance (e.g.,
/dev/xvdf
).
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
attachInstancesToLoadBalancer(params = {}, callback) ⇒ AWS.Request
Attaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
The attach instances to load balancer
operation supports tag-based access control via resource tags applied to the resource identified by load balancer name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the attachInstancesToLoadBalancer operation
var params = {
instanceNames: [ /* required */
'STRING_VALUE',
/* more items */
],
loadBalancerName: 'STRING_VALUE' /* required */
};
lightsail.attachInstancesToLoadBalancer(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
loadBalancerName
— (String
)The name of the load balancer.
instanceNames
— (Array<String>
)An array of strings representing the instance name(s) you want to attach to your load balancer.
An instance must be
running
before you can attach it to your load balancer.There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
attachLoadBalancerTlsCertificate(params = {}, callback) ⇒ AWS.Request
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate
action with the non-attached certificate, and it will replace the existing one and become the attached certificate.
The AttachLoadBalancerTlsCertificate
operation supports tag-based access control via resource tags applied to the resource identified by load balancer name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the attachLoadBalancerTlsCertificate operation
var params = {
certificateName: 'STRING_VALUE', /* required */
loadBalancerName: 'STRING_VALUE' /* required */
};
lightsail.attachLoadBalancerTlsCertificate(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
loadBalancerName
— (String
)The name of the load balancer to which you want to associate the SSL/TLS certificate.
certificateName
— (String
)The name of your SSL/TLS certificate.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get the certificate and use it for another purpose.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
attachStaticIp(params = {}, callback) ⇒ AWS.Request
Attaches a static IP address to a specific Amazon Lightsail instance.
Service Reference:
Examples:
Calling the attachStaticIp operation
var params = {
instanceName: 'STRING_VALUE', /* required */
staticIpName: 'STRING_VALUE' /* required */
};
lightsail.attachStaticIp(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
staticIpName
— (String
)The name of the static IP.
instanceName
— (String
)The instance name to which you want to attach the static IP address.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
closeInstancePublicPorts(params = {}, callback) ⇒ AWS.Request
Closes ports for a specific Amazon Lightsail instance.
The CloseInstancePublicPorts
action supports tag-based access control via resource tags applied to the resource identified by instanceName
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the closeInstancePublicPorts operation
var params = {
instanceName: 'STRING_VALUE', /* required */
portInfo: { /* required */
cidrListAliases: [
'STRING_VALUE',
/* more items */
],
cidrs: [
'STRING_VALUE',
/* more items */
],
fromPort: 'NUMBER_VALUE',
ipv6Cidrs: [
'STRING_VALUE',
/* more items */
],
protocol: tcp | all | udp | icmp,
toPort: 'NUMBER_VALUE'
}
};
lightsail.closeInstancePublicPorts(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
portInfo
— (map
)An object to describe the ports to close for the specified instance.
fromPort
— (Integer
)The first port in a range of open ports on an instance.
Allowed ports:
-
TCP and UDP -
0
to65535
-
ICMP - The ICMP type for IPv4 addresses. For example, specify
8
as thefromPort
(ICMP type), and-1
as thetoPort
(ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. -
ICMPv6 - The ICMP type for IPv6 addresses. For example, specify
128
as thefromPort
(ICMPv6 type), and0
astoPort
(ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.
-
toPort
— (Integer
)The last port in a range of open ports on an instance.
Allowed ports:
-
TCP and UDP -
0
to65535
-
ICMP - The ICMP code for IPv4 addresses. For example, specify
8
as thefromPort
(ICMP type), and-1
as thetoPort
(ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. -
ICMPv6 - The ICMP code for IPv6 addresses. For example, specify
128
as thefromPort
(ICMPv6 type), and0
astoPort
(ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.
-
protocol
— (String
)The IP protocol name.
The name can be one of the following:
-
tcp
- Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead. -
all
- All transport layer protocol types. For more general information, see Transport layer on Wikipedia. -
udp
- With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead. -
icmp
- Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specifyicmp
as theprotocol
, you must specify the ICMP type using thefromPort
parameter, and ICMP code using thetoPort
parameter.
"tcp"
"all"
"udp"
"icmp"
-
cidrs
— (Array<String>
)The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.
Note: Theipv6Cidrs
parameter lists the IPv6 addresses that are allowed to connect to an instance.Examples:
-
To allow the IP address
192.0.2.44
, specify192.0.2.44
or192.0.2.44/32
. -
To allow the IP addresses
192.0.2.0
to192.0.2.255
, specify192.0.2.0/24
.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
-
ipv6Cidrs
— (Array<String>
)The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.
Note: Thecidrs
parameter lists the IPv4 addresses that are allowed to connect to an instance.For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
cidrListAliases
— (Array<String>
)An alias that defines access for a preconfigured range of IP addresses.
The only alias currently supported is
lightsail-connect
, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
instanceName
— (String
)The name of the instance for which to close ports.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operation
— (map
)An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
copySnapshot(params = {}, callback) ⇒ AWS.Request
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.
When copying a manual snapshot, be sure to define the source region
, source snapshot name
, and target snapshot name
parameters.
When copying an automatic snapshot, be sure to define the source region
, source resource name
, target snapshot name
, and either the restore date
or the use latest restorable auto snapshot
parameters.
Service Reference:
Examples:
Calling the copySnapshot operation
var params = {
sourceRegion: us-east-1 | us-east-2 | us-west-1 | us-west-2 | eu-west-1 | eu-west-2 | eu-west-3 | eu-central-1 | ca-central-1 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | ap-northeast-2, /* required */
targetSnapshotName: 'STRING_VALUE', /* required */
restoreDate: 'STRING_VALUE',
sourceResourceName: 'STRING_VALUE',
sourceSnapshotName: 'STRING_VALUE',
useLatestRestorableAutoSnapshot: true || false
};
lightsail.copySnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
sourceSnapshotName
— (String
)The name of the source manual snapshot to copy.
Constraint:
-
Define this parameter only when copying a manual snapshot as another manual snapshot.
-
sourceResourceName
— (String
)The name of the source instance or disk from which the source automatic snapshot was created.
Constraint:
-
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.
-
restoreDate
— (String
)The date of the source automatic snapshot to copy. Use the
get auto snapshots
operation to identify the dates of the available automatic snapshots.Constraints:
-
Must be specified in
YYYY-MM-DD
format. -
This parameter cannot be defined together with the
use latest restorable auto snapshot
parameter. Therestore date
anduse latest restorable auto snapshot
parameters are mutually exclusive. -
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.
-
useLatestRestorableAutoSnapshot
— (Boolean
)A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.
Constraints:
-
This parameter cannot be defined together with the
restore date
parameter. Theuse latest restorable auto snapshot
andrestore date
parameters are mutually exclusive. -
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.
-
targetSnapshotName
— (String
)The name of the new manual snapshot to be created as a copy.
sourceRegion
— (String
)The AWS Region where the source manual or automatic snapshot is located.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createCertificate(params = {}, callback) ⇒ AWS.Request
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
After the certificate is valid, use the AttachCertificateToDistribution
action to use the certificate and its domains with your distribution. Or use the UpdateContainerService
action to use the certificate and its domains with your container service.
Only certificates created in the us-east-1
AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1
Region.
Service Reference:
Examples:
Calling the createCertificate operation
var params = {
certificateName: 'STRING_VALUE', /* required */
domainName: 'STRING_VALUE', /* required */
subjectAlternativeNames: [
'STRING_VALUE',
/* more items */
],
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createCertificate(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
certificateName
— (String
)The name for the certificate.
domainName
— (String
)The domain name (e.g.,
example.com
) for the certificate.subjectAlternativeNames
— (Array<String>
)An array of strings that specify the alternate domains (e.g.,
example2.com
) and subdomains (e.g.,blog.example.com
) for the certificate.You can specify a maximum of nine alternate domains (in addition to the primary domain name).
Wildcard domain entries (e.g.,
*.example.com
) are not supported.tags
— (Array<map>
)The tag keys and optional values to add to the certificate during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:certificate
— (map
)An object that describes the certificate created.
certificateArn
— (String
)The Amazon Resource Name (ARN) of the certificate.
certificateName
— (String
)The name of the certificate.
domainName
— (String
)The domain name of the certificate.
certificateDetail
— (map
)An object that describes a certificate in detail.
arn
— (String
)The Amazon Resource Name (ARN) of the certificate.
name
— (String
)The name of the certificate (e.g.,
my-certificate
).domainName
— (String
)The domain name of the certificate.
status
— (String
)The validation status of the certificate.
Possible values include:"PENDING_VALIDATION"
"ISSUED"
"INACTIVE"
"EXPIRED"
"VALIDATION_TIMED_OUT"
"REVOKED"
"FAILED"
serialNumber
— (String
)The serial number of the certificate.
subjectAlternativeNames
— (Array<String>
)An array of strings that specify the alternate domains (e.g.,
example2.com
) and subdomains (e.g.,blog.example.com
) of the certificate.domainValidationRecords
— (Array<map>
)An array of objects that describe the domain validation records of the certificate.
domainName
— (String
)The domain name of the certificate validation record. For example,
example.com
orwww.example.com
.resourceRecord
— (map
)An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.
name
— (String
)The name of the record.
type
— (String
)The DNS record type.
value
— (String
)The value for the DNS record.
requestFailureReason
— (String
)The validation failure reason, if any, of the certificate.
The following failure reasons are possible:
-
NO_AVAILABLE_CONTACTS
- This failure applies to email validation, which is not available for Lightsail certificates. -
ADDITIONAL_VERIFICATION_REQUIRED
- Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.Note: You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com. -
DOMAIN_NOT_ALLOWED
- One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
-
INVALID_PUBLIC_DOMAIN
- One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate forexample.invalidpublicdomain
becauseinvalidpublicdomain
is not a valid top-level domain. -
OTHER
- Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.
-
inUseResourceCount
— (Integer
)The number of Lightsail resources that the certificate is attached to.
keyAlgorithm
— (String
)The algorithm used to generate the key pair (the public and private key) of the certificate.
createdAt
— (Date
)The timestamp when the certificate was created.
issuedAt
— (Date
)The timestamp when the certificate was issued.
issuerCA
— (String
)The certificate authority that issued the certificate.
notBefore
— (Date
)The timestamp when the certificate is first valid.
notAfter
— (Date
)The timestamp when the certificate expires.
eligibleToRenew
— (String
)The renewal eligibility of the certificate.
renewalSummary
— (map
)An object that describes the status of the certificate renewal managed by Lightsail.
domainValidationRecords
— (Array<map>
)An array of objects that describe the domain validation records of the certificate.
domainName
— (String
)The domain name of the certificate validation record. For example,
example.com
orwww.example.com
.resourceRecord
— (map
)An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.
name
— (String
)The name of the record.
type
— (String
)The DNS record type.
value
— (String
)The value for the DNS record.
renewalStatus
— (String
)The renewal status of the certificate.
The following renewal status are possible:
-
PendingAutoRenewal
- Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required. -
PendingValidation
- Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. 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.
"PendingAutoRenewal"
"PendingValidation"
"Success"
"Failed"
-
renewalStatusReason
— (String
)The reason for the renewal status of the certificate.
updatedAt
— (Date
)The timestamp when the certificate was last updated.
revokedAt
— (Date
)The timestamp when the certificate was revoked. This value is present only when the certificate status is
REVOKED
.revocationReason
— (String
)The reason the certificate was revoked. This value is present only when the certificate status is
REVOKED
.tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
supportCode
— (String
)The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.
tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createCloudFormationStack(params = {}, callback) ⇒ AWS.Request
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records
operation to get a list of the CloudFormation stacks created.
Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack
operation again with the same export snapshot record.
Service Reference:
Examples:
Calling the createCloudFormationStack operation
var params = {
instances: [ /* required */
{
availabilityZone: 'STRING_VALUE', /* required */
instanceType: 'STRING_VALUE', /* required */
portInfoSource: DEFAULT | INSTANCE | NONE | CLOSED, /* required */
sourceName: 'STRING_VALUE', /* required */
userData: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createCloudFormationStack(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
instances
— (Array<map>
)An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.
sourceName
— required — (String
)The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.
Use the
get export snapshot records
operation to get a list of export snapshot records that you can use to create a CloudFormation stack.instanceType
— required — (String
)The instance type (e.g.,
t2.micro
) to use for the new Amazon EC2 instance.portInfoSource
— required — (String
)The port configuration to use for the new Amazon EC2 instance.
The following configuration options are available:
-
DEFAULT
- Use the default firewall settings from the Lightsail instance blueprint. If this is specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. -
INSTANCE
- Use the configured firewall settings from the source Lightsail instance. If this is specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2. -
NONE
- Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2. -
CLOSED
- All ports closed. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.
Note: If you configuredPossible values include:lightsail-connect
as acidrListAliases
on your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance."DEFAULT"
"INSTANCE"
"NONE"
"CLOSED"
-
userData
— (String
)A launch script you can create that configures a server with additional user data. For example, you might want to run
apt-get -y update
.Note: Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS useyum
, Debian and Ubuntu useapt-get
, and FreeBSD usespkg
.availabilityZone
— required — (String
)The Availability Zone for the new Amazon EC2 instance.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createContactMethod(params = {}, callback) ⇒ AWS.Request
Creates an email or SMS text message contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
Service Reference:
Examples:
Calling the createContactMethod operation
var params = {
contactEndpoint: 'STRING_VALUE', /* required */
protocol: Email | SMS /* required */
};
lightsail.createContactMethod(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
protocol
— (String
)The protocol of the contact method, such as
Email
orSMS
(text messaging).The
SMS
protocol is supported only in the following AWS Regions.-
US East (N. Virginia) (
us-east-1
) -
US West (Oregon) (
us-west-2
) -
Europe (Ireland) (
eu-west-1
) -
Asia Pacific (Tokyo) (
ap-northeast-1
) -
Asia Pacific (Singapore) (
ap-southeast-1
) -
Asia Pacific (Sydney) (
ap-southeast-2
)
For a list of countries/regions where SMS text messages can be sent, and the latest AWS Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.
For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.
Possible values include:"Email"
"SMS"
-
contactEndpoint
— (String
)The destination of the contact method, such as an email address or a mobile phone number.
Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createContainerService(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Lightsail container service.
A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createContainerService operation
var params = {
power: nano | micro | small | medium | large | xlarge, /* required */
scale: 'NUMBER_VALUE', /* required */
serviceName: 'STRING_VALUE', /* required */
deployment: {
containers: {
'<ContainerName>': {
command: [
'STRING_VALUE',
/* more items */
],
environment: {
'<string>': 'STRING_VALUE',
/* '<string>': ... */
},
image: 'STRING_VALUE',
ports: {
'<string>': HTTP | HTTPS | TCP | UDP,
/* '<string>': ... */
}
},
/* '<ContainerName>': ... */
},
publicEndpoint: {
containerName: 'STRING_VALUE', /* required */
containerPort: 'NUMBER_VALUE', /* required */
healthCheck: {
healthyThreshold: 'NUMBER_VALUE',
intervalSeconds: 'NUMBER_VALUE',
path: 'STRING_VALUE',
successCodes: 'STRING_VALUE',
timeoutSeconds: 'NUMBER_VALUE',
unhealthyThreshold: 'NUMBER_VALUE'
}
}
},
publicDomainNames: {
'<string>': [
'STRING_VALUE',
/* more items */
],
/* '<string>': ... */
},
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createContainerService(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
serviceName
— (String
)The name for the container service.
The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically
https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com
. If the name of your container service iscontainer-service-1
, and it's located in the US East (Ohio) AWS region (us-east-2
), then the domain for your container service will be like the following example:https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com
The following are the requirements for container service names:
-
Must be unique within each AWS Region in your Lightsail account.
-
Must contain 1 to 63 characters.
-
Must contain only alphanumeric characters and hyphens.
-
A hyphen (-) can separate words but cannot be at the start or end of the name.
-
power
— (String
)The power specification for the container service.
The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The
power
andscale
of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of thepower
with thescale
(the number of nodes) of the service.Use the
Possible values include:GetContainerServicePowers
action to get a list of power options that you can specify using this parameter, and their base monthly cost."nano"
"micro"
"small"
"medium"
"large"
"xlarge"
scale
— (Integer
)The scale specification for the container service.
The scale specifies the allocated compute nodes of the container service. The
power
andscale
of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of thepower
with thescale
(the number of nodes) of the service.tags
— (Array<map>
)The tag keys and optional values for the container service.
For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
publicDomainNames
— (map<Array<String>>
)The public domain names to use with the container service, such as
example.com
andwww.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 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
CreateCertificate
action to create a certificate for the public domain names you want to use with your container service.You can specify public domain names using a string to array map as shown in the example later on this page.
deployment
— (map
)An object that describes a deployment for the container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
containers
— (map<map>
)An object that describes the configuration for the containers of the deployment.
image
— (String
)The name of the image used for the container.
Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (
:
). For example,:container-service-1.mystaticwebsite.1
. Container images sourced from a public registry like Docker Hub don't start with a colon. For example,nginx:latest
ornginx
.command
— (Array<String>
)The launch command for the container.
environment
— (map<String>
)The environment variables of the container.
ports
— (map<String>
)The open firewall ports of the container.
publicEndpoint
— (map
)An object that describes the endpoint of the deployment.
containerName
— required — (String
)The name of the container for the endpoint.
containerPort
— required — (Integer
)The port of the container to which traffic is forwarded to.
healthCheck
— (map
)An object that describes the health check configuration of the container.
healthyThreshold
— (Integer
)The number of consecutive health checks successes required before moving the container to the
Healthy
state. The default value is2
.unhealthyThreshold
— (Integer
)The number of consecutive health check failures required before moving the container to the
Unhealthy
state. The default value is2
.timeoutSeconds
— (Integer
)The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is
2
.intervalSeconds
— (Integer
)The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is
5
.path
— (String
)The path on the container on which to perform the health check. The default value is
/
.successCodes
— (String
)The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:containerService
— (map
)An object that describes a container service.
containerServiceName
— (String
)The name of the container service.
arn
— (String
)The Amazon Resource Name (ARN) of the container service.
createdAt
— (Date
)The timestamp when the container service was created.
location
— (map
)An object that describes the location of the container service, such as the AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The Lightsail resource type of the container service (i.e.,
Possible values include:ContainerService
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
power
— (String
)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.
Possible values include:"nano"
"micro"
"small"
"medium"
"large"
"xlarge"
powerId
— (String
)The ID of the power of the container service.
state
— (String
)The current state of the container service.
The state can be:
-
Pending
- The container service is being created. -
Ready
- The container service is created but does not have a container deployment. -
Disabled
- The container service is disabled. -
Updating
- The container service capacity or other setting is being updated. -
Deploying
- The container service is launching a container deployment. -
Running
- The container service is created and it has a container deployment.
"PENDING"
"READY"
"RUNNING"
"UPDATING"
"DELETING"
"DISABLED"
-
scale
— (Integer
)The scale specification of the container service.
The scale specifies the allocated compute nodes of the container service.
currentDeployment
— (map
)An object that describes the current container deployment of the container service.
version
— (Integer
)The version number of the deployment.
state
— (String
)The state of the deployment.
A deployment can be in one of the following states:
-
Activating
- The deployment is being created. -
Active
- The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. -
Inactive
- The deployment was previously successfully created, but it is not currently running on the container service. -
Failed
- The deployment failed. Use theGetContainerLog
action to view the log events for the containers in the deployment to try to determine the reason for the failure.
"ACTIVATING"
"ACTIVE"
"INACTIVE"
"FAILED"
-
containers
— (map<map>
)An object that describes the configuration for the containers of the deployment.
image
— (String
)The name of the image used for the container.
Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (
:
). For example,:container-service-1.mystaticwebsite.1
. Container images sourced from a public registry like Docker Hub don't start with a colon. For example,nginx:latest
ornginx
.command
— (Array<String>
)The launch command for the container.
environment
— (map<String>
)The environment variables of the container.
ports
— (map<String>
)The open firewall ports of the container.
publicEndpoint
— (map
)An object that describes the endpoint of the deployment.
containerName
— (String
)The name of the container entry of the deployment that the endpoint configuration applies to.
containerPort
— (Integer
)The port of the specified container to which traffic is forwarded to.
healthCheck
— (map
)An object that describes the health check configuration of the container.
healthyThreshold
— (Integer
)The number of consecutive health checks successes required before moving the container to the
Healthy
state. The default value is2
.unhealthyThreshold
— (Integer
)The number of consecutive health check failures required before moving the container to the
Unhealthy
state. The default value is2
.timeoutSeconds
— (Integer
)The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is
2
.intervalSeconds
— (Integer
)The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is
5
.path
— (String
)The path on the container on which to perform the health check. The default value is
/
.successCodes
— (String
)The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
createdAt
— (Date
)The timestamp when the deployment was created.
nextDeployment
— (map
)An object that describes the next deployment of the container service.
This value is
null
when there is no deployment in apending
state.version
— (Integer
)The version number of the deployment.
state
— (String
)The state of the deployment.
A deployment can be in one of the following states:
-
Activating
- The deployment is being created. -
Active
- The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. -
Inactive
- The deployment was previously successfully created, but it is not currently running on the container service. -
Failed
- The deployment failed. Use theGetContainerLog
action to view the log events for the containers in the deployment to try to determine the reason for the failure.
"ACTIVATING"
"ACTIVE"
"INACTIVE"
"FAILED"
-
containers
— (map<map>
)An object that describes the configuration for the containers of the deployment.
image
— (String
)The name of the image used for the container.
Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (
:
). For example,:container-service-1.mystaticwebsite.1
. Container images sourced from a public registry like Docker Hub don't start with a colon. For example,nginx:latest
ornginx
.command
— (Array<String>
)The launch command for the container.
environment
— (map<String>
)The environment variables of the container.
ports
— (map<String>
)The open firewall ports of the container.
publicEndpoint
— (map
)An object that describes the endpoint of the deployment.
containerName
— (String
)The name of the container entry of the deployment that the endpoint configuration applies to.
containerPort
— (Integer
)The port of the specified container to which traffic is forwarded to.
healthCheck
— (map
)An object that describes the health check configuration of the container.
healthyThreshold
— (Integer
)The number of consecutive health checks successes required before moving the container to the
Healthy
state. The default value is2
.unhealthyThreshold
— (Integer
)The number of consecutive health check failures required before moving the container to the
Unhealthy
state. The default value is2
.timeoutSeconds
— (Integer
)The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is
2
.intervalSeconds
— (Integer
)The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is
5
.path
— (String
)The path on the container on which to perform the health check. The default value is
/
.successCodes
— (String
)The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
createdAt
— (Date
)The timestamp when the deployment was created.
isDisabled
— (Boolean
)A Boolean value indicating whether the container service is disabled.
principalArn
— (String
)The principal ARN of the container service.
The principal ARN can be used to create a trust relationship between your standard AWS account and your Lightsail container service. This allows you to give your service permission to access resources in your standard AWS account.
privateDomainName
— (String
)The private domain name of the container service.
The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.
publicDomainNames
— (map<Array<String>>
)The public domain name of the container service, such as
example.com
andwww.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 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
CreateCertificate
action to create a certificate for the public domain names you want to use with your container service.See
CreateContainerService
orUpdateContainerService
for information about how to specify public domain names for your Lightsail container service.url
— (String
)The publicly accessible URL of the container service.
If no public endpoint is specified in the
currentDeployment
, this URL returns a 404 response.
-
(AWS.Response)
—
Returns:
createContainerServiceDeployment(params = {}, callback) ⇒ AWS.Request
Creates a deployment for your Amazon Lightsail container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from a public registry like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createContainerServiceDeployment operation
var params = {
serviceName: 'STRING_VALUE', /* required */
containers: {
'<ContainerName>': {
command: [
'STRING_VALUE',
/* more items */
],
environment: {
'<string>': 'STRING_VALUE',
/* '<string>': ... */
},
image: 'STRING_VALUE',
ports: {
'<string>': HTTP | HTTPS | TCP | UDP,
/* '<string>': ... */
}
},
/* '<ContainerName>': ... */
},
publicEndpoint: {
containerName: 'STRING_VALUE', /* required */
containerPort: 'NUMBER_VALUE', /* required */
healthCheck: {
healthyThreshold: 'NUMBER_VALUE',
intervalSeconds: 'NUMBER_VALUE',
path: 'STRING_VALUE',
successCodes: 'STRING_VALUE',
timeoutSeconds: 'NUMBER_VALUE',
unhealthyThreshold: 'NUMBER_VALUE'
}
}
};
lightsail.createContainerServiceDeployment(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
serviceName
— (String
)The name of the container service for which to create the deployment.
containers
— (map<map>
)An object that describes the settings of the containers that will be launched on the container service.
image
— (String
)The name of the image used for the container.
Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (
:
). For example,:container-service-1.mystaticwebsite.1
. Container images sourced from a public registry like Docker Hub don't start with a colon. For example,nginx:latest
ornginx
.command
— (Array<String>
)The launch command for the container.
environment
— (map<String>
)The environment variables of the container.
ports
— (map<String>
)The open firewall ports of the container.
publicEndpoint
— (map
)An object that describes the settings of the public endpoint for the container service.
containerName
— required — (String
)The name of the container for the endpoint.
containerPort
— required — (Integer
)The port of the container to which traffic is forwarded to.
healthCheck
— (map
)An object that describes the health check configuration of the container.
healthyThreshold
— (Integer
)The number of consecutive health checks successes required before moving the container to the
Healthy
state. The default value is2
.unhealthyThreshold
— (Integer
)The number of consecutive health check failures required before moving the container to the
Unhealthy
state. The default value is2
.timeoutSeconds
— (Integer
)The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is
2
.intervalSeconds
— (Integer
)The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is
5
.path
— (String
)The path on the container on which to perform the health check. The default value is
/
.successCodes
— (String
)The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:containerService
— (map
)An object that describes a container service.
containerServiceName
— (String
)The name of the container service.
arn
— (String
)The Amazon Resource Name (ARN) of the container service.
createdAt
— (Date
)The timestamp when the container service was created.
location
— (map
)An object that describes the location of the container service, such as the AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The Lightsail resource type of the container service (i.e.,
Possible values include:ContainerService
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
power
— (String
)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.
Possible values include:"nano"
"micro"
"small"
"medium"
"large"
"xlarge"
powerId
— (String
)The ID of the power of the container service.
state
— (String
)The current state of the container service.
The state can be:
-
Pending
- The container service is being created. -
Ready
- The container service is created but does not have a container deployment. -
Disabled
- The container service is disabled. -
Updating
- The container service capacity or other setting is being updated. -
Deploying
- The container service is launching a container deployment. -
Running
- The container service is created and it has a container deployment.
"PENDING"
"READY"
"RUNNING"
"UPDATING"
"DELETING"
"DISABLED"
-
scale
— (Integer
)The scale specification of the container service.
The scale specifies the allocated compute nodes of the container service.
currentDeployment
— (map
)An object that describes the current container deployment of the container service.
version
— (Integer
)The version number of the deployment.
state
— (String
)The state of the deployment.
A deployment can be in one of the following states:
-
Activating
- The deployment is being created. -
Active
- The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. -
Inactive
- The deployment was previously successfully created, but it is not currently running on the container service. -
Failed
- The deployment failed. Use theGetContainerLog
action to view the log events for the containers in the deployment to try to determine the reason for the failure.
"ACTIVATING"
"ACTIVE"
"INACTIVE"
"FAILED"
-
containers
— (map<map>
)An object that describes the configuration for the containers of the deployment.
image
— (String
)The name of the image used for the container.
Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (
:
). For example,:container-service-1.mystaticwebsite.1
. Container images sourced from a public registry like Docker Hub don't start with a colon. For example,nginx:latest
ornginx
.command
— (Array<String>
)The launch command for the container.
environment
— (map<String>
)The environment variables of the container.
ports
— (map<String>
)The open firewall ports of the container.
publicEndpoint
— (map
)An object that describes the endpoint of the deployment.
containerName
— (String
)The name of the container entry of the deployment that the endpoint configuration applies to.
containerPort
— (Integer
)The port of the specified container to which traffic is forwarded to.
healthCheck
— (map
)An object that describes the health check configuration of the container.
healthyThreshold
— (Integer
)The number of consecutive health checks successes required before moving the container to the
Healthy
state. The default value is2
.unhealthyThreshold
— (Integer
)The number of consecutive health check failures required before moving the container to the
Unhealthy
state. The default value is2
.timeoutSeconds
— (Integer
)The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is
2
.intervalSeconds
— (Integer
)The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is
5
.path
— (String
)The path on the container on which to perform the health check. The default value is
/
.successCodes
— (String
)The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
createdAt
— (Date
)The timestamp when the deployment was created.
nextDeployment
— (map
)An object that describes the next deployment of the container service.
This value is
null
when there is no deployment in apending
state.version
— (Integer
)The version number of the deployment.
state
— (String
)The state of the deployment.
A deployment can be in one of the following states:
-
Activating
- The deployment is being created. -
Active
- The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. -
Inactive
- The deployment was previously successfully created, but it is not currently running on the container service. -
Failed
- The deployment failed. Use theGetContainerLog
action to view the log events for the containers in the deployment to try to determine the reason for the failure.
"ACTIVATING"
"ACTIVE"
"INACTIVE"
"FAILED"
-
containers
— (map<map>
)An object that describes the configuration for the containers of the deployment.
image
— (String
)The name of the image used for the container.
Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (
:
). For example,:container-service-1.mystaticwebsite.1
. Container images sourced from a public registry like Docker Hub don't start with a colon. For example,nginx:latest
ornginx
.command
— (Array<String>
)The launch command for the container.
environment
— (map<String>
)The environment variables of the container.
ports
— (map<String>
)The open firewall ports of the container.
publicEndpoint
— (map
)An object that describes the endpoint of the deployment.
containerName
— (String
)The name of the container entry of the deployment that the endpoint configuration applies to.
containerPort
— (Integer
)The port of the specified container to which traffic is forwarded to.
healthCheck
— (map
)An object that describes the health check configuration of the container.
healthyThreshold
— (Integer
)The number of consecutive health checks successes required before moving the container to the
Healthy
state. The default value is2
.unhealthyThreshold
— (Integer
)The number of consecutive health check failures required before moving the container to the
Unhealthy
state. The default value is2
.timeoutSeconds
— (Integer
)The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is
2
.intervalSeconds
— (Integer
)The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is
5
.path
— (String
)The path on the container on which to perform the health check. The default value is
/
.successCodes
— (String
)The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
createdAt
— (Date
)The timestamp when the deployment was created.
isDisabled
— (Boolean
)A Boolean value indicating whether the container service is disabled.
principalArn
— (String
)The principal ARN of the container service.
The principal ARN can be used to create a trust relationship between your standard AWS account and your Lightsail container service. This allows you to give your service permission to access resources in your standard AWS account.
privateDomainName
— (String
)The private domain name of the container service.
The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.
publicDomainNames
— (map<Array<String>>
)The public domain name of the container service, such as
example.com
andwww.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 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
CreateCertificate
action to create a certificate for the public domain names you want to use with your container service.See
CreateContainerService
orUpdateContainerService
for information about how to specify public domain names for your Lightsail container service.url
— (String
)The publicly accessible URL of the container service.
If no public endpoint is specified in the
currentDeployment
, this URL returns a 404 response.
-
(AWS.Response)
—
Returns:
createContainerServiceRegistryLogin(params = {}, callback) ⇒ AWS.Request
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.
After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage
action to register the pushed images to a specific Lightsail container service.
Service Reference:
Examples:
Calling the createContainerServiceRegistryLogin operation
var params = {
};
lightsail.createContainerServiceRegistryLogin(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
- params (Object) (defaults to: {})
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:registryLogin
— (map
)An object that describes the log in information for the container service registry of your Lightsail account.
username
— (String
)The container service registry username to use to push container images to the container image registry of a Lightsail account.
password
— (String
)The container service registry password to use to push container images to the container image registry of a Lightsail account
expiresAt
— (Date
)The timestamp of when the container image registry username and password expire.
The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials using the
CreateContainerServiceRegistryLogin
action.registry
— (String
)The address to use to push container images to the container image registry of a Lightsail account.
-
(AWS.Response)
—
Returns:
createDisk(params = {}, callback) ⇒ AWS.Request
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a
).
The create disk
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createDisk operation
var params = {
availabilityZone: 'STRING_VALUE', /* required */
diskName: 'STRING_VALUE', /* required */
sizeInGb: 'NUMBER_VALUE', /* required */
addOns: [
{
addOnType: AutoSnapshot, /* required */
autoSnapshotAddOnRequest: {
snapshotTimeOfDay: 'STRING_VALUE'
}
},
/* more items */
],
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createDisk(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
diskName
— (String
)The unique Lightsail disk name (e.g.,
my-disk
).availabilityZone
— (String
)The Availability Zone where you want to create the disk (e.g.,
us-east-2a
). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.Use the
get regions
operation to list the Availability Zones where Lightsail is currently available.sizeInGb
— (Integer
)The size of the disk in GB (e.g.,
32
).tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
addOns
— (Array<map>
)An array of objects that represent the add-ons to enable for the new disk.
addOnType
— required — (String
)The add-on type.
Possible values include:"AutoSnapshot"
autoSnapshotAddOnRequest
— (map
)An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
snapshotTimeOfDay
— (String
)The daily time when an automatic snapshot will be created.
Constraints:
-
Must be in
HH:00
format, and in an hourly increment. -
Specified in Coordinated Universal Time (UTC).
-
The snapshot will be automatically created between the time specified and up to 45 minutes after.
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createDiskFromSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a
).
The create disk from snapshot
operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createDiskFromSnapshot operation
var params = {
availabilityZone: 'STRING_VALUE', /* required */
diskName: 'STRING_VALUE', /* required */
sizeInGb: 'NUMBER_VALUE', /* required */
addOns: [
{
addOnType: AutoSnapshot, /* required */
autoSnapshotAddOnRequest: {
snapshotTimeOfDay: 'STRING_VALUE'
}
},
/* more items */
],
diskSnapshotName: 'STRING_VALUE',
restoreDate: 'STRING_VALUE',
sourceDiskName: 'STRING_VALUE',
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
],
useLatestRestorableAutoSnapshot: true || false
};
lightsail.createDiskFromSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
diskName
— (String
)The unique Lightsail disk name (e.g.,
my-disk
).diskSnapshotName
— (String
)The name of the disk snapshot (e.g.,
my-snapshot
) from which to create the new storage disk.Constraint:
-
This parameter cannot be defined together with the
source disk name
parameter. Thedisk snapshot name
andsource disk name
parameters are mutually exclusive.
-
availabilityZone
— (String
)The Availability Zone where you want to create the disk (e.g.,
us-east-2a
). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
sizeInGb
— (Integer
)The size of the disk in GB (e.g.,
32
).tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
addOns
— (Array<map>
)An array of objects that represent the add-ons to enable for the new disk.
addOnType
— required — (String
)The add-on type.
Possible values include:"AutoSnapshot"
autoSnapshotAddOnRequest
— (map
)An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
snapshotTimeOfDay
— (String
)The daily time when an automatic snapshot will be created.
Constraints:
-
Must be in
HH:00
format, and in an hourly increment. -
Specified in Coordinated Universal Time (UTC).
-
The snapshot will be automatically created between the time specified and up to 45 minutes after.
-
sourceDiskName
— (String
)The name of the source disk from which the source automatic snapshot was created.
Constraints:
-
This parameter cannot be defined together with the
disk snapshot name
parameter. Thesource disk name
anddisk snapshot name
parameters are mutually exclusive. -
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.
-
restoreDate
— (String
)The date of the automatic snapshot to use for the new disk. Use the
get auto snapshots
operation to identify the dates of the available automatic snapshots.Constraints:
-
Must be specified in
YYYY-MM-DD
format. -
This parameter cannot be defined together with the
use latest restorable auto snapshot
parameter. Therestore date
anduse latest restorable auto snapshot
parameters are mutually exclusive. -
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.
-
useLatestRestorableAutoSnapshot
— (Boolean
)A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
-
This parameter cannot be defined together with the
restore date
parameter. Theuse latest restorable auto snapshot
andrestore date
parameters are mutually exclusive. -
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createDiskSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name
parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.
The create disk snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createDiskSnapshot operation
var params = {
diskSnapshotName: 'STRING_VALUE', /* required */
diskName: 'STRING_VALUE',
instanceName: 'STRING_VALUE',
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createDiskSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
diskName
— (String
)The unique name of the source disk (e.g.,
Disk-Virginia-1
).Note: This parameter cannot be defined together with theinstance name
parameter. Thedisk name
andinstance name
parameters are mutually exclusive.diskSnapshotName
— (String
)The name of the destination disk snapshot (e.g.,
my-disk-snapshot
) based on the source disk.instanceName
— (String
)The unique name of the source instance (e.g.,
Amazon_Linux-512MB-Virginia-1
). When this is defined, a snapshot of the instance's system volume is created.Note: This parameter cannot be defined together with thedisk name
parameter. Theinstance name
anddisk name
parameters are mutually exclusive.tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createDistribution(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Lightsail content delivery network (CDN) distribution.
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. For more information, see Content delivery networks in Amazon Lightsail.
Service Reference:
Examples:
Calling the createDistribution operation
var params = {
bundleId: 'STRING_VALUE', /* required */
defaultCacheBehavior: { /* required */
behavior: dont-cache | cache
},
distributionName: 'STRING_VALUE', /* required */
origin: { /* required */
name: 'STRING_VALUE',
protocolPolicy: http-only | https-only,
regionName: us-east-1 | us-east-2 | us-west-1 | us-west-2 | eu-west-1 | eu-west-2 | eu-west-3 | eu-central-1 | ca-central-1 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | ap-northeast-2
},
cacheBehaviorSettings: {
allowedHTTPMethods: 'STRING_VALUE',
cachedHTTPMethods: 'STRING_VALUE',
defaultTTL: 'NUMBER_VALUE',
forwardedCookies: {
cookiesAllowList: [
'STRING_VALUE',
/* more items */
],
option: none | allow-list | all
},
forwardedHeaders: {
headersAllowList: [
Accept | Accept-Charset | Accept-Datetime | Accept-Encoding | Accept-Language | Authorization | CloudFront-Forwarded-Proto | CloudFront-Is-Desktop-Viewer | CloudFront-Is-Mobile-Viewer | CloudFront-Is-SmartTV-Viewer | CloudFront-Is-Tablet-Viewer | CloudFront-Viewer-Country | Host | Origin | Referer,
/* more items */
],
option: none | allow-list | all
},
forwardedQueryStrings: {
option: true || false,
queryStringsAllowList: [
'STRING_VALUE',
/* more items */
]
},
maximumTTL: 'NUMBER_VALUE',
minimumTTL: 'NUMBER_VALUE'
},
cacheBehaviors: [
{
behavior: dont-cache | cache,
path: 'STRING_VALUE'
},
/* more items */
],
ipAddressType: dualstack | ipv4,
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createDistribution(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
distributionName
— (String
)The name for the distribution.
origin
— (map
)An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.
The distribution pulls, caches, and serves content from the origin.
name
— (String
)The name of the origin resource.
regionName
— (String
)The AWS Region name of the origin resource.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
protocolPolicy
— (String
)The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
Possible values include:"http-only"
"https-only"
defaultCacheBehavior
— (map
)An object that describes the default cache behavior for the distribution.
behavior
— (String
)The cache behavior of the distribution.
The following cache behaviors can be specified:
-
cache
- This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content. -
dont-cache
- This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution'sCacheBehaviorPerPath
parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
"dont-cache"
"cache"
-
cacheBehaviorSettings
— (map
)An object that describes the cache behavior settings for the distribution.
defaultTTL
— (Integer
)The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.
Note: The value specified applies only when the origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects.minimumTTL
— (Integer
)The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
A value of
0
must be specified forminimumTTL
if the distribution is configured to forward all headers to the origin.maximumTTL
— (Integer
)The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
The value specified applies only when the origin adds HTTP headers such as
Cache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects.allowedHTTPMethods
— (String
)The HTTP methods that are processed and forwarded to the distribution's origin.
You can specify the following options:
-
GET,HEAD
- The distribution forwards theGET
andHEAD
methods. -
GET,HEAD,OPTIONS
- The distribution forwards theGET
,HEAD
, andOPTIONS
methods. -
GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE
- The distribution forwards theGET
,HEAD
,OPTIONS
,PUT
,PATCH
,POST
, andDELETE
methods.
If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
-
cachedHTTPMethods
— (String
)The HTTP method responses that are cached by your distribution.
You can specify the following options:
-
GET,HEAD
- The distribution caches responses to theGET
andHEAD
methods. -
GET,HEAD,OPTIONS
- The distribution caches responses to theGET
,HEAD
, andOPTIONS
methods.
-
forwardedCookies
— (map
)An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
option
— (String
)Specifies which cookies to forward to the distribution's origin for a cache behavior:
Possible values include:all
,none
, orallow-list
to forward only the cookies specified in thecookiesAllowList
parameter."none"
"allow-list"
"all"
cookiesAllowList
— (Array<String>
)The specific cookies to forward to your distribution's origin.
forwardedHeaders
— (map
)An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
option
— (String
)The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
-
all
- Forward all headers to your origin. -
none
- Forward only the default headers. -
allow-list
- Forward only the headers you specify using theheadersAllowList
parameter.
"none"
"allow-list"
"all"
-
headersAllowList
— (Array<String>
)The specific headers to forward to your distribution's origin.
forwardedQueryStrings
— (map
)An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
option
— (Boolean
)Indicates whether the distribution forwards and caches based on query strings.
queryStringsAllowList
— (Array<String>
)The specific query strings that the distribution forwards to the origin.
Your distribution will cache content based on the specified query strings.
If the
option
parameter is true, then your distribution forwards all query strings, regardless of what you specify using thequeryStringsAllowList
parameter.
cacheBehaviors
— (Array<map>
)An array of objects that describe the per-path cache behavior for the distribution.
path
— (String
)The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (
path/to/assets/*
), and file types (*.html, *jpg, *js
). Directories and file paths are case-sensitive.Examples:
-
Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.
var/www/html/
-
Specify the following file to cache only the index page in the document root of an Apache web server.
var/www/html/index.html
-
Specify the following to cache only the .html files in the document root of an Apache web server.
var/www/html/*.html
-
Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.
var/www/html/images/*.jpg
var/www/html/images/*.png
var/www/html/images/*.gif
Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.
var/www/html/images/
-
behavior
— (String
)The cache behavior for the specified path.
You can specify one of the following per-path cache behaviors:
-
cache
- This behavior caches the specified path. -
dont-cache
- This behavior doesn't cache the specified path.
"dont-cache"
"cache"
-
bundleId
— (String
)The bundle ID to use for the distribution.
A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.
Use the
GetDistributionBundles
action to get a list of distribution bundle IDs that you can specify.ipAddressType
— (String
)The IP address type for the distribution.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.The default value is
Possible values include:dualstack
."dualstack"
"ipv4"
tags
— (Array<map>
)The tag keys and optional values to add to the distribution during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:distribution
— (map
)An object that describes the distribution created.
name
— (String
)The name of the distribution.
arn
— (String
)The Amazon Resource Name (ARN) of the distribution.
supportCode
— (String
)The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.
createdAt
— (Date
)The timestamp when the distribution was created.
location
— (map
)An object that describes the location of the distribution, such as the AWS Region and Availability Zone.
Note: Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in theus-east-1
Region.availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The Lightsail resource type (e.g.,
Possible values include:Distribution
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
alternativeDomainNames
— (Array<String>
)The alternate domain names of the distribution.
status
— (String
)The status of the distribution.
isEnabled
— (Boolean
)Indicates whether the distribution is enabled.
domainName
— (String
)The domain name of the distribution.
bundleId
— (String
)The ID of the bundle currently applied to the distribution.
certificateName
— (String
)The name of the SSL/TLS certificate attached to the distribution, if any.
origin
— (map
)An object that describes the origin resource of the distribution, such as a Lightsail instance or load balancer.
The distribution pulls, caches, and serves content from the origin.
name
— (String
)The name of the origin resource.
resourceType
— (String
)The resource type of the origin resource (e.g., Instance).
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
regionName
— (String
)The AWS Region name of the origin resource.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
protocolPolicy
— (String
)The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
Possible values include:"http-only"
"https-only"
originPublicDNS
— (String
)The public DNS of the origin.
defaultCacheBehavior
— (map
)An object that describes the default cache behavior of the distribution.
behavior
— (String
)The cache behavior of the distribution.
The following cache behaviors can be specified:
-
cache
- This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content. -
dont-cache
- This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution'sCacheBehaviorPerPath
parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
"dont-cache"
"cache"
-
cacheBehaviorSettings
— (map
)An object that describes the cache behavior settings of the distribution.
defaultTTL
— (Integer
)The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.
Note: The value specified applies only when the origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects.minimumTTL
— (Integer
)The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
A value of
0
must be specified forminimumTTL
if the distribution is configured to forward all headers to the origin.maximumTTL
— (Integer
)The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
The value specified applies only when the origin adds HTTP headers such as
Cache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects.allowedHTTPMethods
— (String
)The HTTP methods that are processed and forwarded to the distribution's origin.
You can specify the following options:
-
GET,HEAD
- The distribution forwards theGET
andHEAD
methods. -
GET,HEAD,OPTIONS
- The distribution forwards theGET
,HEAD
, andOPTIONS
methods. -
GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE
- The distribution forwards theGET
,HEAD
,OPTIONS
,PUT
,PATCH
,POST
, andDELETE
methods.
If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
-
cachedHTTPMethods
— (String
)The HTTP method responses that are cached by your distribution.
You can specify the following options:
-
GET,HEAD
- The distribution caches responses to theGET
andHEAD
methods. -
GET,HEAD,OPTIONS
- The distribution caches responses to theGET
,HEAD
, andOPTIONS
methods.
-
forwardedCookies
— (map
)An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
option
— (String
)Specifies which cookies to forward to the distribution's origin for a cache behavior:
Possible values include:all
,none
, orallow-list
to forward only the cookies specified in thecookiesAllowList
parameter."none"
"allow-list"
"all"
cookiesAllowList
— (Array<String>
)The specific cookies to forward to your distribution's origin.
forwardedHeaders
— (map
)An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
option
— (String
)The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
-
all
- Forward all headers to your origin. -
none
- Forward only the default headers. -
allow-list
- Forward only the headers you specify using theheadersAllowList
parameter.
"none"
"allow-list"
"all"
-
headersAllowList
— (Array<String>
)The specific headers to forward to your distribution's origin.
forwardedQueryStrings
— (map
)An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
option
— (Boolean
)Indicates whether the distribution forwards and caches based on query strings.
queryStringsAllowList
— (Array<String>
)The specific query strings that the distribution forwards to the origin.
Your distribution will cache content based on the specified query strings.
If the
option
parameter is true, then your distribution forwards all query strings, regardless of what you specify using thequeryStringsAllowList
parameter.
cacheBehaviors
— (Array<map>
)An array of objects that describe the per-path cache behavior of the distribution.
path
— (String
)The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (
path/to/assets/*
), and file types (*.html, *jpg, *js
). Directories and file paths are case-sensitive.Examples:
-
Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.
var/www/html/
-
Specify the following file to cache only the index page in the document root of an Apache web server.
var/www/html/index.html
-
Specify the following to cache only the .html files in the document root of an Apache web server.
var/www/html/*.html
-
Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.
var/www/html/images/*.jpg
var/www/html/images/*.png
var/www/html/images/*.gif
Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.
var/www/html/images/
-
behavior
— (String
)The cache behavior for the specified path.
You can specify one of the following per-path cache behaviors:
-
cache
- This behavior caches the specified path. -
dont-cache
- This behavior doesn't cache the specified path.
"dont-cache"
"cache"
-
ableToUpdateBundle
— (Boolean
)Indicates whether the bundle that is currently applied to your distribution, specified using the
distributionName
parameter, can be changed to another bundle.Use the
UpdateDistributionBundle
action to change your distribution's bundle.ipAddressType
— (String
)The IP address type of the distribution.
The possible values are
Possible values include:ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6."dualstack"
"ipv4"
tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
operation
— (map
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createDomain(params = {}, callback) ⇒ AWS.Request
Creates a domain resource for the specified domain (e.g., example.com).
The create domain
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createDomain operation
var params = {
domainName: 'STRING_VALUE', /* required */
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createDomain(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
domainName
— (String
)The domain name to manage (e.g.,
example.com
).Note: You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operation
— (map
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createDomainEntry(params = {}, callback) ⇒ AWS.Request
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The create domain entry
operation supports tag-based access control via resource tags applied to the resource identified by domain name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createDomainEntry operation
var params = {
domainEntry: { /* required */
id: 'STRING_VALUE',
isAlias: true || false,
name: 'STRING_VALUE',
options: {
'<DomainEntryOptionsKeys>': 'STRING_VALUE',
/* '<DomainEntryOptionsKeys>': ... */
},
target: 'STRING_VALUE',
type: 'STRING_VALUE'
},
domainName: 'STRING_VALUE' /* required */
};
lightsail.createDomainEntry(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
domainName
— (String
)The domain name (e.g.,
example.com
) for which you want to create the domain entry.domainEntry
— (map
)An array of key-value pairs containing information about the domain entry request.
id
— (String
)The ID of the domain recordset entry.
name
— (String
)The name of the domain.
target
— (String
)The target AWS name server (e.g.,
ns-111.awsdns-22.com.
).For Lightsail load balancers, the value looks like
ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com
. Be sure to also setisAlias
totrue
when setting up an A record for a load balancer.isAlias
— (Boolean
)When
true
, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer.type
— (String
)The type of domain entry, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The following domain entry types can be used:
-
A
-
CNAME
-
MX
-
NS
-
SOA
-
SRV
-
TXT
-
options
— (map<String>
)(Deprecated) The options for the domain entry.
Note: In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operation
— (map
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createInstances(params = {}, callback) ⇒ AWS.Request
Creates one or more Amazon Lightsail instances.
The create instances
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createInstances operation
var params = {
availabilityZone: 'STRING_VALUE', /* required */
blueprintId: 'STRING_VALUE', /* required */
bundleId: 'STRING_VALUE', /* required */
instanceNames: [ /* required */
'STRING_VALUE',
/* more items */
],
addOns: [
{
addOnType: AutoSnapshot, /* required */
autoSnapshotAddOnRequest: {
snapshotTimeOfDay: 'STRING_VALUE'
}
},
/* more items */
],
customImageName: 'STRING_VALUE',
ipAddressType: dualstack | ipv4,
keyPairName: 'STRING_VALUE',
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
],
userData: 'STRING_VALUE'
};
lightsail.createInstances(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
instanceNames
— (Array<String>
)The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example:
["MyFirstInstance","MySecondInstance"]
availabilityZone
— (String
)The Availability Zone in which to create your instance. Use the following format:
us-east-2a
(case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add theinclude Availability Zones
parameter to your request.customImageName
— (String
)(Deprecated) The name for your custom image.
Note: In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.blueprintId
— (String
)The ID for a virtual private server image (e.g.,
app_wordpress_4_4
orapp_lamp_7_0
). Use theget blueprints
operation to return a list of available images (or blueprints).Note: Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.bundleId
— (String
)The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g.,
micro_1_0
).userData
— (String
)A launch script you can create that configures a server with additional user data. For example, you might want to run
apt-get -y update
.Note: Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS useyum
, Debian and Ubuntu useapt-get
, and FreeBSD usespkg
. For a complete list, see the Dev Guide.keyPairName
— (String
)The name of your key pair.
tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
addOns
— (Array<map>
)An array of objects representing the add-ons to enable for the new instance.
addOnType
— required — (String
)The add-on type.
Possible values include:"AutoSnapshot"
autoSnapshotAddOnRequest
— (map
)An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
snapshotTimeOfDay
— (String
)The daily time when an automatic snapshot will be created.
Constraints:
-
Must be in
HH:00
format, and in an hourly increment. -
Specified in Coordinated Universal Time (UTC).
-
The snapshot will be automatically created between the time specified and up to 45 minutes after.
-
ipAddressType
— (String
)The IP address type for the instance.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.The default value is
Possible values include:dualstack
."dualstack"
"ipv4"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createInstancesFromSnapshot(params = {}, callback) ⇒ AWS.Request
Creates one or more new instances from a manual or automatic snapshot of an instance.
The create instances from snapshot
operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createInstancesFromSnapshot operation
var params = {
availabilityZone: 'STRING_VALUE', /* required */
bundleId: 'STRING_VALUE', /* required */
instanceNames: [ /* required */
'STRING_VALUE',
/* more items */
],
addOns: [
{
addOnType: AutoSnapshot, /* required */
autoSnapshotAddOnRequest: {
snapshotTimeOfDay: 'STRING_VALUE'
}
},
/* more items */
],
attachedDiskMapping: {
'<ResourceName>': [
{
newDiskName: 'STRING_VALUE',
originalDiskPath: 'STRING_VALUE'
},
/* more items */
],
/* '<ResourceName>': ... */
},
instanceSnapshotName: 'STRING_VALUE',
ipAddressType: dualstack | ipv4,
keyPairName: 'STRING_VALUE',
restoreDate: 'STRING_VALUE',
sourceInstanceName: 'STRING_VALUE',
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
],
useLatestRestorableAutoSnapshot: true || false,
userData: 'STRING_VALUE'
};
lightsail.createInstancesFromSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
instanceNames
— (Array<String>
)The names for your new instances.
attachedDiskMapping
— (map<Array<map>>
)An object containing information about one or more disk mappings.
originalDiskPath
— (String
)The original disk path exposed to the instance (for example,
/dev/sdh
).newDiskName
— (String
)The new disk name (e.g.,
my-new-disk
).
availabilityZone
— (String
)The Availability Zone where you want to create your instances. Use the following formatting:
us-east-2a
(case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add theinclude Availability Zones
parameter to your request.instanceSnapshotName
— (String
)The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.
Constraint:
-
This parameter cannot be defined together with the
source instance name
parameter. Theinstance snapshot name
andsource instance name
parameters are mutually exclusive.
-
bundleId
— (String
)The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g.,
micro_1_0
).userData
— (String
)You can create a launch script that configures a server with additional user data. For example,
apt-get -y update
.Note: Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS useyum
, Debian and Ubuntu useapt-get
, and FreeBSD usespkg
. For a complete list, see the Dev Guide.keyPairName
— (String
)The name for your key pair.
tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
addOns
— (Array<map>
)An array of objects representing the add-ons to enable for the new instance.
addOnType
— required — (String
)The add-on type.
Possible values include:"AutoSnapshot"
autoSnapshotAddOnRequest
— (map
)An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
snapshotTimeOfDay
— (String
)The daily time when an automatic snapshot will be created.
Constraints:
-
Must be in
HH:00
format, and in an hourly increment. -
Specified in Coordinated Universal Time (UTC).
-
The snapshot will be automatically created between the time specified and up to 45 minutes after.
-
ipAddressType
— (String
)The IP address type for the instance.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.The default value is
Possible values include:dualstack
."dualstack"
"ipv4"
sourceInstanceName
— (String
)The name of the source instance from which the source automatic snapshot was created.
Constraints:
-
This parameter cannot be defined together with the
instance snapshot name
parameter. Thesource instance name
andinstance snapshot name
parameters are mutually exclusive. -
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
-
restoreDate
— (String
)The date of the automatic snapshot to use for the new instance. Use the
get auto snapshots
operation to identify the dates of the available automatic snapshots.Constraints:
-
Must be specified in
YYYY-MM-DD
format. -
This parameter cannot be defined together with the
use latest restorable auto snapshot
parameter. Therestore date
anduse latest restorable auto snapshot
parameters are mutually exclusive. -
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
-
useLatestRestorableAutoSnapshot
— (Boolean
)A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
-
This parameter cannot be defined together with the
restore date
parameter. Theuse latest restorable auto snapshot
andrestore date
parameters are mutually exclusive. -
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createInstanceSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
The create instance snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createInstanceSnapshot operation
var params = {
instanceName: 'STRING_VALUE', /* required */
instanceSnapshotName: 'STRING_VALUE', /* required */
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createInstanceSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
instanceSnapshotName
— (String
)The name for your new snapshot.
instanceName
— (String
)The Lightsail instance on which to base your snapshot.
tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createKeyPair(params = {}, callback) ⇒ AWS.Request
Creates an SSH key pair.
The create key pair
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createKeyPair operation
var params = {
keyPairName: 'STRING_VALUE', /* required */
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createKeyPair(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
keyPairName
— (String
)The name for your new key pair.
tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:keyPair
— (map
)An array of key-value pairs containing information about the new key pair you just created.
name
— (String
)The friendly name of the SSH key pair.
arn
— (String
)The Amazon Resource Name (ARN) of the key pair (e.g.,
arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE
).supportCode
— (String
)The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
createdAt
— (Date
)The timestamp when the key pair was created (e.g.,
1479816991.349
).location
— (map
)The region name and Availability Zone where the key pair was created.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The resource type (usually
Possible values include:KeyPair
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
fingerprint
— (String
)The RSA fingerprint of the key pair.
publicKeyBase64
— (String
)A base64-encoded public key of the
ssh-rsa
type.privateKeyBase64
— (String
)A base64-encoded RSA private key.
operation
— (map
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createLoadBalancer(params = {}, callback) ⇒ AWS.Request
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute
operation.
The create load balancer
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createLoadBalancer operation
var params = {
instancePort: 'NUMBER_VALUE', /* required */
loadBalancerName: 'STRING_VALUE', /* required */
certificateAlternativeNames: [
'STRING_VALUE',
/* more items */
],
certificateDomainName: 'STRING_VALUE',
certificateName: 'STRING_VALUE',
healthCheckPath: 'STRING_VALUE',
ipAddressType: dualstack | ipv4,
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createLoadBalancer(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
loadBalancerName
— (String
)The name of your load balancer.
instancePort
— (Integer
)The instance port where you're creating your load balancer.
healthCheckPath
— (String
)The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g.,
"/"
).You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.
certificateName
— (String
)The name of the SSL/TLS certificate.
If you specify
certificateName
, thencertificateDomainName
is required (and vice-versa).certificateDomainName
— (String
)The domain name with which your certificate is associated (e.g.,
example.com
).If you specify
certificateDomainName
, thencertificateName
is required (and vice-versa).certificateAlternativeNames
— (Array<String>
)The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g.,
www.example.com
,example.com
,m.example.com
,blog.example.com
).tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
ipAddressType
— (String
)The IP address type for the load balancer.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.The default value is
Possible values include:dualstack
."dualstack"
"ipv4"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createLoadBalancerTlsCertificate(params = {}, callback) ⇒ AWS.Request
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
The CreateLoadBalancerTlsCertificate
operation supports tag-based access control via resource tags applied to the resource identified by load balancer name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createLoadBalancerTlsCertificate operation
var params = {
certificateDomainName: 'STRING_VALUE', /* required */
certificateName: 'STRING_VALUE', /* required */
loadBalancerName: 'STRING_VALUE', /* required */
certificateAlternativeNames: [
'STRING_VALUE',
/* more items */
],
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createLoadBalancerTlsCertificate(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
loadBalancerName
— (String
)The load balancer name where you want to create the SSL/TLS certificate.
certificateName
— (String
)The SSL/TLS certificate name.
You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.
certificateDomainName
— (String
)The domain name (e.g.,
example.com
) for your SSL/TLS certificate.certificateAlternativeNames
— (Array<String>
)An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g.,
*.example.com
).tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createRelationalDatabase(params = {}, callback) ⇒ AWS.Request
Creates a new database in Amazon Lightsail.
The create relational database
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createRelationalDatabase operation
var params = {
masterDatabaseName: 'STRING_VALUE', /* required */
masterUsername: 'STRING_VALUE', /* required */
relationalDatabaseBlueprintId: 'STRING_VALUE', /* required */
relationalDatabaseBundleId: 'STRING_VALUE', /* required */
relationalDatabaseName: 'STRING_VALUE', /* required */
availabilityZone: 'STRING_VALUE',
masterUserPassword: 'STRING_VALUE',
preferredBackupWindow: 'STRING_VALUE',
preferredMaintenanceWindow: 'STRING_VALUE',
publiclyAccessible: true || false,
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createRelationalDatabase(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
relationalDatabaseName
— (String
)The name to use for your new Lightsail database resource.
Constraints:
-
Must contain from 2 to 255 alphanumeric characters, or hyphens.
-
The first and last character must be a letter or number.
-
availabilityZone
— (String
)The Availability Zone in which to create your new database. Use the
us-east-2a
case-sensitive format.You can get a list of Availability Zones by using the
get regions
operation. Be sure to add theinclude relational database Availability Zones
parameter to your request.relationalDatabaseBlueprintId
— (String
)The blueprint ID for your new database. A blueprint describes the major engine version of a database.
You can get a list of database blueprints IDs by using the
get relational database blueprints
operation.relationalDatabaseBundleId
— (String
)The bundle ID for your new database. A bundle describes the performance specifications for your database.
You can get a list of database bundle IDs by using the
get relational database bundles
operation.masterDatabaseName
— (String
)The name of the master database created when the Lightsail database resource is created.
Constraints:
-
Must contain from 1 to 64 alphanumeric characters.
-
Cannot be a word reserved by the specified database engine
-
masterUsername
— (String
)The master user name for your new database.
Constraints:
-
Master user name is required.
-
Must contain from 1 to 16 alphanumeric characters.
-
The first character must be a letter.
-
Cannot be a reserved word for the database engine you choose.
For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6 or MySQL 5.7 respectively.
-
masterUserPassword
— (String
)The password for the master user of your new database. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain 8 to 41 characters.
preferredBackupWindow
— (String
)The daily time range during which automated backups are created for your new database if automated backups are enabled.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.
Constraints:
-
Must be in the
hh24:mi-hh24:mi
format.Example:
16:00-16:30
-
Specified in Coordinated Universal Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
-
preferredMaintenanceWindow
— (String
)The weekly time range during which system maintenance can occur on your new database.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints:
-
Must be in the
ddd:hh24:mi-ddd:hh24:mi
format. -
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
-
Must be at least 30 minutes.
-
Specified in Coordinated Universal Time (UTC).
-
Example:
Tue:17:00-Tue:17:30
-
publiclyAccessible
— (Boolean
)Specifies 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 offalse
specifies a database that is available only to your Lightsail resources in the same region as your database.tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createRelationalDatabaseFromSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a new database from an existing database snapshot in Amazon Lightsail.
You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.
The create relational database from snapshot
operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createRelationalDatabaseFromSnapshot operation
var params = {
relationalDatabaseName: 'STRING_VALUE', /* required */
availabilityZone: 'STRING_VALUE',
publiclyAccessible: true || false,
relationalDatabaseBundleId: 'STRING_VALUE',
relationalDatabaseSnapshotName: 'STRING_VALUE',
restoreTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
sourceRelationalDatabaseName: 'STRING_VALUE',
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
],
useLatestRestorableTime: true || false
};
lightsail.createRelationalDatabaseFromSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
relationalDatabaseName
— (String
)The name to use for your new database.
Constraints:
-
Must contain from 2 to 255 alphanumeric characters, or hyphens.
-
The first and last character must be a letter or number.
-
availabilityZone
— (String
)The Availability Zone in which to create your new database. Use the
us-east-2a
case-sensitive format.You can get a list of Availability Zones by using the
get regions
operation. Be sure to add theinclude relational database Availability Zones
parameter to your request.publiclyAccessible
— (Boolean
)Specifies 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 offalse
specifies a database that is available only to your Lightsail resources in the same region as your database.relationalDatabaseSnapshotName
— (String
)The name of the database snapshot from which to create your new database.
relationalDatabaseBundleId
— (String
)The bundle ID for your new database. A bundle describes the performance specifications for your database.
You can get a list of database bundle IDs by using the
get relational database bundles
operation.When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.
sourceRelationalDatabaseName
— (String
)The name of the source database.
restoreTime
— (Date
)The date and time to restore your database from.
Constraints:
-
Must be before the latest restorable time for the database.
-
Cannot be specified if the
use latest restorable time
parameter istrue
. -
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input
1538424000
as the restore time.
-
useLatestRestorableTime
— (Boolean
)Specifies whether your database is restored from the latest backup time. A value of
true
restores from the latest backup time.Default:
false
Constraints: Cannot be specified if the
restore time
parameter is provided.tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
createRelationalDatabaseSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.
The create relational database snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the createRelationalDatabaseSnapshot operation
var params = {
relationalDatabaseName: 'STRING_VALUE', /* required */
relationalDatabaseSnapshotName: 'STRING_VALUE', /* required */
tags: [
{
key: 'STRING_VALUE',
value: 'STRING_VALUE'
},
/* more items */
]
};
lightsail.createRelationalDatabaseSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
relationalDatabaseName
— (String
)The name of the database on which to base your new snapshot.
relationalDatabaseSnapshotName
— (String
)The name for your new database snapshot.
Constraints:
-
Must contain from 2 to 255 alphanumeric characters, or hyphens.
-
The first and last character must be a letter or number.
-
tags
— (Array<map>
)The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteAlarm(params = {}, callback) ⇒ AWS.Request
Deletes an alarm.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
Service Reference:
Examples:
Calling the deleteAlarm operation
var params = {
alarmName: 'STRING_VALUE' /* required */
};
lightsail.deleteAlarm(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
alarmName
— (String
)The name of the alarm to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteAutoSnapshot(params = {}, callback) ⇒ AWS.Request
Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteAutoSnapshot operation
var params = {
date: 'STRING_VALUE', /* required */
resourceName: 'STRING_VALUE' /* required */
};
lightsail.deleteAutoSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceName
— (String
)The name of the source instance or disk from which to delete the automatic snapshot.
date
— (String
)The date of the automatic snapshot to delete in
YYYY-MM-DD
format. Use theget auto snapshots
operation to get the available automatic snapshots for a resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteCertificate(params = {}, callback) ⇒ AWS.Request
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution
action to detach a certificate from a distribution.
Service Reference:
Examples:
Calling the deleteCertificate operation
var params = {
certificateName: 'STRING_VALUE' /* required */
};
lightsail.deleteCertificate(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
certificateName
— (String
)The name of the certificate to delete.
Use the
GetCertificates
action to get a list of certificate names that you can specify.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteContactMethod(params = {}, callback) ⇒ AWS.Request
Deletes a contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
Service Reference:
Examples:
Calling the deleteContactMethod operation
var params = {
protocol: Email | SMS /* required */
};
lightsail.deleteContactMethod(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
protocol
— (String
)The protocol that will be deleted, such as
Email
orSMS
(text messaging).Note: To delete anPossible values include:Email
and anSMS
contact method if you added both, you must run separateDeleteContactMethod
actions to delete each protocol."Email"
"SMS"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteContainerImage(params = {}, callback) ⇒ AWS.Request
Deletes a container image that is registered to your Amazon Lightsail container service.
Service Reference:
Examples:
Calling the deleteContainerImage operation
var params = {
image: 'STRING_VALUE', /* required */
serviceName: 'STRING_VALUE' /* required */
};
lightsail.deleteContainerImage(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
serviceName
— (String
)The name of the container service for which to delete a registered container image.
image
— (String
)The name of the container image to delete from the container service.
Use the
GetContainerImages
action to get the name of the container images that are registered to a container service.Note: Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:
). For example,:container-service-1.mystaticwebsite.1
. Container images sourced from a public registry like Docker Hub don't start with a colon. For example,nginx:latest
ornginx
.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteContainerService(params = {}, callback) ⇒ AWS.Request
Deletes your Amazon Lightsail container service.
Service Reference:
Examples:
Calling the deleteContainerService operation
var params = {
serviceName: 'STRING_VALUE' /* required */
};
lightsail.deleteContainerService(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
serviceName
— (String
)The name of the container service to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteDisk(params = {}, callback) ⇒ AWS.Request
Deletes the specified block storage disk. The disk must be in the available
state (not attached to a Lightsail instance).
deleting
state for several minutes. The delete disk
operation supports tag-based access control via resource tags applied to the resource identified by disk name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteDisk operation
var params = {
diskName: 'STRING_VALUE', /* required */
forceDeleteAddOns: true || false
};
lightsail.deleteDisk(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
diskName
— (String
)The unique name of the disk you want to delete (e.g.,
my-disk
).forceDeleteAddOns
— (Boolean
)A Boolean value to indicate whether to delete the enabled add-ons for the disk.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteDiskSnapshot(params = {}, callback) ⇒ AWS.Request
Deletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
The delete disk snapshot
operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteDiskSnapshot operation
var params = {
diskSnapshotName: 'STRING_VALUE' /* required */
};
lightsail.deleteDiskSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
diskSnapshotName
— (String
)The name of the disk snapshot you want to delete (e.g.,
my-disk-snapshot
).
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteDistribution(params = {}, callback) ⇒ AWS.Request
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
Service Reference:
Examples:
Calling the deleteDistribution operation
var params = {
distributionName: 'STRING_VALUE'
};
lightsail.deleteDistribution(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
distributionName
— (String
)The name of the distribution to delete.
Use the
GetDistributions
action to get a list of distribution names that you can specify.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operation
— (map
)An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteDomain(params = {}, callback) ⇒ AWS.Request
Deletes the specified domain recordset and all of its domain records.
The delete domain
operation supports tag-based access control via resource tags applied to the resource identified by domain name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteDomain operation
var params = {
domainName: 'STRING_VALUE' /* required */
};
lightsail.deleteDomain(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
domainName
— (String
)The specific domain name to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operation
— (map
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteDomainEntry(params = {}, callback) ⇒ AWS.Request
Deletes a specific domain entry.
The delete domain entry
operation supports tag-based access control via resource tags applied to the resource identified by domain name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteDomainEntry operation
var params = {
domainEntry: { /* required */
id: 'STRING_VALUE',
isAlias: true || false,
name: 'STRING_VALUE',
options: {
'<DomainEntryOptionsKeys>': 'STRING_VALUE',
/* '<DomainEntryOptionsKeys>': ... */
},
target: 'STRING_VALUE',
type: 'STRING_VALUE'
},
domainName: 'STRING_VALUE' /* required */
};
lightsail.deleteDomainEntry(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
domainName
— (String
)The name of the domain entry to delete.
domainEntry
— (map
)An array of key-value pairs containing information about your domain entries.
id
— (String
)The ID of the domain recordset entry.
name
— (String
)The name of the domain.
target
— (String
)The target AWS name server (e.g.,
ns-111.awsdns-22.com.
).For Lightsail load balancers, the value looks like
ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com
. Be sure to also setisAlias
totrue
when setting up an A record for a load balancer.isAlias
— (Boolean
)When
true
, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer.type
— (String
)The type of domain entry, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The following domain entry types can be used:
-
A
-
CNAME
-
MX
-
NS
-
SOA
-
SRV
-
TXT
-
options
— (map<String>
)(Deprecated) The options for the domain entry.
Note: In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operation
— (map
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteInstance(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Lightsail instance.
The delete instance
operation supports tag-based access control via resource tags applied to the resource identified by instance name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteInstance operation
var params = {
instanceName: 'STRING_VALUE', /* required */
forceDeleteAddOns: true || false
};
lightsail.deleteInstance(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
instanceName
— (String
)The name of the instance to delete.
forceDeleteAddOns
— (Boolean
)A Boolean value to indicate whether to delete the enabled add-ons for the disk.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteInstanceSnapshot(params = {}, callback) ⇒ AWS.Request
Deletes a specific snapshot of a virtual private server (or instance).
The delete instance snapshot
operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteInstanceSnapshot operation
var params = {
instanceSnapshotName: 'STRING_VALUE' /* required */
};
lightsail.deleteInstanceSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
instanceSnapshotName
— (String
)The name of the snapshot to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteKeyPair(params = {}, callback) ⇒ AWS.Request
Deletes a specific SSH key pair.
The delete key pair
operation supports tag-based access control via resource tags applied to the resource identified by key pair name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteKeyPair operation
var params = {
keyPairName: 'STRING_VALUE' /* required */
};
lightsail.deleteKeyPair(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
keyPairName
— (String
)The name of the key pair to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operation
— (map
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteKnownHostKeys(params = {}, callback) ⇒ AWS.Request
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.
Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.
Service Reference:
Examples:
Calling the deleteKnownHostKeys operation
var params = {
instanceName: 'STRING_VALUE' /* required */
};
lightsail.deleteKnownHostKeys(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
instanceName
— (String
)The name of the instance for which you want to reset the host key or certificate.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteLoadBalancer(params = {}, callback) ⇒ AWS.Request
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.
The delete load balancer
operation supports tag-based access control via resource tags applied to the resource identified by load balancer name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteLoadBalancer operation
var params = {
loadBalancerName: 'STRING_VALUE' /* required */
};
lightsail.deleteLoadBalancer(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
loadBalancerName
— (String
)The name of the load balancer you want to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteLoadBalancerTlsCertificate(params = {}, callback) ⇒ AWS.Request
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
The DeleteLoadBalancerTlsCertificate
operation supports tag-based access control via resource tags applied to the resource identified by load balancer name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteLoadBalancerTlsCertificate operation
var params = {
certificateName: 'STRING_VALUE', /* required */
loadBalancerName: 'STRING_VALUE', /* required */
force: true || false
};
lightsail.deleteLoadBalancerTlsCertificate(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
loadBalancerName
— (String
)The load balancer name.
certificateName
— (String
)The SSL/TLS certificate name.
force
— (Boolean
)When
true
, forces the deletion of an SSL/TLS certificate.There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The
force
parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteRelationalDatabase(params = {}, callback) ⇒ AWS.Request
Deletes a database in Amazon Lightsail.
The delete relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteRelationalDatabase operation
var params = {
relationalDatabaseName: 'STRING_VALUE', /* required */
finalRelationalDatabaseSnapshotName: 'STRING_VALUE',
skipFinalSnapshot: true || false
};
lightsail.deleteRelationalDatabase(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
relationalDatabaseName
— (String
)The name of the database that you are deleting.
skipFinalSnapshot
— (Boolean
)Determines whether a final database snapshot is created before your database is deleted. If
true
is specified, no database snapshot is created. Iffalse
is specified, a database snapshot is created before your database is deleted.You must specify the
final relational database snapshot name
parameter if theskip final snapshot
parameter isfalse
.Default:
false
finalRelationalDatabaseSnapshotName
— (String
)The name of the database snapshot created if
skip final snapshot
isfalse
, which is the default value for that parameter.Note: Specifying this parameter and also specifying theskip final snapshot
parameter totrue
results in an error.Constraints:
-
Must contain from 2 to 255 alphanumeric characters, or hyphens.
-
The first and last character must be a letter or number.
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
deleteRelationalDatabaseSnapshot(params = {}, callback) ⇒ AWS.Request
Deletes a database snapshot in Amazon Lightsail.
The delete relational database snapshot
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the deleteRelationalDatabaseSnapshot operation
var params = {
relationalDatabaseSnapshotName: 'STRING_VALUE' /* required */
};
lightsail.deleteRelationalDatabaseSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
relationalDatabaseSnapshotName
— (String
)The name of the database snapshot that you are deleting.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
detachCertificateFromDistribution(params = {}, callback) ⇒ AWS.Request
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.
Service Reference:
Examples:
Calling the detachCertificateFromDistribution operation
var params = {
distributionName: 'STRING_VALUE' /* required */
};
lightsail.detachCertificateFromDistribution(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
distributionName
— (String
)The name of the distribution from which to detach the certificate.
Use the
GetDistributions
action to get a list of distribution names that you can specify.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operation
— (map
)An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
detachDisk(params = {}, callback) ⇒ AWS.Request
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
The detach disk
operation supports tag-based access control via resource tags applied to the resource identified by disk name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the detachDisk operation
var params = {
diskName: 'STRING_VALUE' /* required */
};
lightsail.detachDisk(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
diskName
— (String
)The unique name of the disk you want to detach from your instance (e.g.,
my-disk
).
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
detachInstancesFromLoadBalancer(params = {}, callback) ⇒ AWS.Request
Detaches the specified instances from a Lightsail load balancer.
This operation waits until the instances are no longer needed before they are detached from the load balancer.
The detach instances from load balancer
operation supports tag-based access control via resource tags applied to the resource identified by load balancer name
. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the detachInstancesFromLoadBalancer operation
var params = {
instanceNames: [ /* required */
'STRING_VALUE',
/* more items */
],
loadBalancerName: 'STRING_VALUE' /* required */
};
lightsail.detachInstancesFromLoadBalancer(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
loadBalancerName
— (String
)The name of the Lightsail load balancer.
instanceNames
— (Array<String>
)An array of strings containing the names of the instances you want to detach from the load balancer.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
detachStaticIp(params = {}, callback) ⇒ AWS.Request
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
Service Reference:
Examples:
Calling the detachStaticIp operation
var params = {
staticIpName: 'STRING_VALUE' /* required */
};
lightsail.detachStaticIp(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
staticIpName
— (String
)The name of the static IP to detach from the instance.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
disableAddOn(params = {}, callback) ⇒ AWS.Request
Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the disableAddOn operation
var params = {
addOnType: AutoSnapshot, /* required */
resourceName: 'STRING_VALUE' /* required */
};
lightsail.disableAddOn(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
addOnType
— (String
)The add-on type to disable.
Possible values include:"AutoSnapshot"
resourceName
— (String
)The name of the source resource for which to disable the add-on.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
downloadDefaultKeyPair(params = {}, callback) ⇒ AWS.Request
Downloads the default SSH key pair from the user's account.
Service Reference:
Examples:
Calling the downloadDefaultKeyPair operation
var params = {
};
lightsail.downloadDefaultKeyPair(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
- params (Object) (defaults to: {})
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:publicKeyBase64
— (String
)A base64-encoded public key of the
ssh-rsa
type.privateKeyBase64
— (String
)A base64-encoded RSA private key.
-
(AWS.Response)
—
Returns:
enableAddOn(params = {}, callback) ⇒ AWS.Request
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the enableAddOn operation
var params = {
addOnRequest: { /* required */
addOnType: AutoSnapshot, /* required */
autoSnapshotAddOnRequest: {
snapshotTimeOfDay: 'STRING_VALUE'
}
},
resourceName: 'STRING_VALUE' /* required */
};
lightsail.enableAddOn(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceName
— (String
)The name of the source resource for which to enable or modify the add-on.
addOnRequest
— (map
)An array of strings representing the add-on to enable or modify.
addOnType
— required — (String
)The add-on type.
Possible values include:"AutoSnapshot"
autoSnapshotAddOnRequest
— (map
)An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
snapshotTimeOfDay
— (String
)The daily time when an automatic snapshot will be created.
Constraints:
-
Must be in
HH:00
format, and in an hourly increment. -
Specified in Coordinated Universal Time (UTC).
-
The snapshot will be automatically created between the time specified and up to 45 minutes after.
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
exportSnapshot(params = {}, callback) ⇒ AWS.Request
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack
operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.
The export snapshot
operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name
. For more information, see the Lightsail Dev Guide.
get instance snapshots
or get disk snapshots
operations to get a list of snapshots that you can export to Amazon EC2. Service Reference:
Examples:
Calling the exportSnapshot operation
var params = {
sourceSnapshotName: 'STRING_VALUE' /* required */
};
lightsail.exportSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
sourceSnapshotName
— (String
)The name of the instance or disk snapshot to be exported to Amazon EC2.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:operations
— (Array<map>
)An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id
— (String
)The ID of the operation.
resourceName
— (String
)The resource name.
resourceType
— (String
)The resource type.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
createdAt
— (Date
)The timestamp when the operation was initialized (e.g.,
1479816991.349
).location
— (map
)The AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
isTerminal
— (Boolean
)A Boolean value indicating whether the operation is terminal.
operationDetails
— (String
)Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType
— (String
)The type of operation.
Possible values include:"DeleteKnownHostKeys"
"DeleteInstance"
"CreateInstance"
"StopInstance"
"StartInstance"
"RebootInstance"
"OpenInstancePublicPorts"
"PutInstancePublicPorts"
"CloseInstancePublicPorts"
"AllocateStaticIp"
"ReleaseStaticIp"
"AttachStaticIp"
"DetachStaticIp"
"UpdateDomainEntry"
"DeleteDomainEntry"
"CreateDomain"
"DeleteDomain"
"CreateInstanceSnapshot"
"DeleteInstanceSnapshot"
"CreateInstancesFromSnapshot"
"CreateLoadBalancer"
"DeleteLoadBalancer"
"AttachInstancesToLoadBalancer"
"DetachInstancesFromLoadBalancer"
"UpdateLoadBalancerAttribute"
"CreateLoadBalancerTlsCertificate"
"DeleteLoadBalancerTlsCertificate"
"AttachLoadBalancerTlsCertificate"
"CreateDisk"
"DeleteDisk"
"AttachDisk"
"DetachDisk"
"CreateDiskSnapshot"
"DeleteDiskSnapshot"
"CreateDiskFromSnapshot"
"CreateRelationalDatabase"
"UpdateRelationalDatabase"
"DeleteRelationalDatabase"
"CreateRelationalDatabaseFromSnapshot"
"CreateRelationalDatabaseSnapshot"
"DeleteRelationalDatabaseSnapshot"
"UpdateRelationalDatabaseParameters"
"StartRelationalDatabase"
"RebootRelationalDatabase"
"StopRelationalDatabase"
"EnableAddOn"
"DisableAddOn"
"PutAlarm"
"GetAlarms"
"DeleteAlarm"
"TestAlarm"
"CreateContactMethod"
"GetContactMethods"
"SendContactMethodVerification"
"DeleteContactMethod"
"CreateDistribution"
"UpdateDistribution"
"DeleteDistribution"
"ResetDistributionCache"
"AttachCertificateToDistribution"
"DetachCertificateFromDistribution"
"UpdateDistributionBundle"
"SetIpAddressType"
"CreateCertificate"
"DeleteCertificate"
"CreateContainerService"
"UpdateContainerService"
"DeleteContainerService"
"CreateContainerServiceDeployment"
"CreateContainerServiceRegistryLogin"
"RegisterContainerImage"
"DeleteContainerImage"
status
— (String
)The status of the operation.
Possible values include:"NotStarted"
"Started"
"Failed"
"Completed"
"Succeeded"
statusChangedAt
— (Date
)The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode
— (String
)The error code.
errorDetails
— (String
)The error details.
-
(AWS.Response)
—
Returns:
getActiveNames(params = {}, callback) ⇒ AWS.Request
Returns the names of all active (not deleted) resources.
Service Reference:
Examples:
Calling the getActiveNames operation
var params = {
pageToken: 'STRING_VALUE'
};
lightsail.getActiveNames(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
pageToken
— (String
)The token to advance to the next page of results from your request.
To get a page token, perform an initial
GetActiveNames
request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:activeNames
— (Array<String>
)The list of active names returned by the get active names request.
nextPageToken
— (String
)The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another
GetActiveNames
request and specify the next page token using thepageToken
parameter.
-
(AWS.Response)
—
Returns:
getAlarms(params = {}, callback) ⇒ AWS.Request
Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
Service Reference:
Examples:
Calling the getAlarms operation
var params = {
alarmName: 'STRING_VALUE',
monitoredResourceName: 'STRING_VALUE',
pageToken: 'STRING_VALUE'
};
lightsail.getAlarms(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
alarmName
— (String
)The name of the alarm.
Specify an alarm name to return information about a specific alarm.
pageToken
— (String
)The token to advance to the next page of results from your request.
To get a page token, perform an initial
GetAlarms
request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.monitoredResourceName
— (String
)The name of the Lightsail resource being monitored by the alarm.
Specify a monitored resource name to return information about all alarms for a specific resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:alarms
— (Array<map>
)An array of objects that describe the alarms.
name
— (String
)The name of the alarm.
arn
— (String
)The Amazon Resource Name (ARN) of the alarm.
createdAt
— (Date
)The timestamp when the alarm was created.
location
— (map
)An object that lists information about the location of the alarm.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The Lightsail resource type (e.g.,
Possible values include:Alarm
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
supportCode
— (String
)The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
monitoredResourceInfo
— (map
)An object that lists information about the resource monitored by the alarm.
arn
— (String
)The Amazon Resource Name (ARN) of the resource being monitored.
name
— (String
)The name of the Lightsail resource being monitored.
resourceType
— (String
)The Lightsail resource type of the resource being monitored.
Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.
Possible values include:"ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
comparisonOperator
— (String
)The arithmetic operation used when comparing the specified statistic and threshold.
Possible values include:"GreaterThanOrEqualToThreshold"
"GreaterThanThreshold"
"LessThanThreshold"
"LessThanOrEqualToThreshold"
evaluationPeriods
— (Integer
)The number of periods over which data is compared to the specified threshold.
period
— (Integer
)The period, in seconds, over which the statistic is applied.
threshold
— (Float
)The value against which the specified statistic is compared.
datapointsToAlarm
— (Integer
)The number of data points that must not within the specified threshold to trigger the alarm.
treatMissingData
— (String
)Specifies how the alarm handles missing data points.
An alarm can treat missing data in the following ways:
-
breaching
- Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold. -
notBreaching
- Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold. -
ignore
- Ignore the missing data. Maintains the current alarm state. -
missing
- Missing data is treated as missing.
"breaching"
"notBreaching"
"ignore"
"missing"
-
statistic
— (String
)The statistic for the metric associated with the alarm.
The following statistics are available:
-
Minimum
- The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. -
Maximum
- The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. -
Sum
- All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. -
Average
- The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. -
SampleCount
- The count, or number, of data points used for the statistical calculation.
"Minimum"
"Maximum"
"Sum"
"Average"
"SampleCount"
-
metricName
— (String
)The name of the metric associated with the alarm.
Possible values include:"CPUUtilization"
"NetworkIn"
"NetworkOut"
"StatusCheckFailed"
"StatusCheckFailed_Instance"
"StatusCheckFailed_System"
"ClientTLSNegotiationErrorCount"
"HealthyHostCount"
"UnhealthyHostCount"
"HTTPCode_LB_4XX_Count"
"HTTPCode_LB_5XX_Count"
"HTTPCode_Instance_2XX_Count"
"HTTPCode_Instance_3XX_Count"
"HTTPCode_Instance_4XX_Count"
"HTTPCode_Instance_5XX_Count"
"InstanceResponseTime"
"RejectedConnectionCount"
"RequestCount"
"DatabaseConnections"
"DiskQueueDepth"
"FreeStorageSpace"
"NetworkReceiveThroughput"
"NetworkTransmitThroughput"
"BurstCapacityTime"
"BurstCapacityPercentage"
state
— (String
)The current state of the alarm.
An alarm has the following possible states:
-
ALARM
- The metric is outside of the defined threshold. -
INSUFFICIENT_DATA
- The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. -
OK
- The metric is within the defined threshold.
"OK"
"ALARM"
"INSUFFICIENT_DATA"
-
unit
— (String
)The unit of the metric associated with the alarm.
Possible values include:"Seconds"
"Microseconds"
"Milliseconds"
"Bytes"
"Kilobytes"
"Megabytes"
"Gigabytes"
"Terabytes"
"Bits"
"Kilobits"
"Megabits"
"Gigabits"
"Terabits"
"Percent"
"Count"
"Bytes/Second"
"Kilobytes/Second"
"Megabytes/Second"
"Gigabytes/Second"
"Terabytes/Second"
"Bits/Second"
"Kilobits/Second"
"Megabits/Second"
"Gigabits/Second"
"Terabits/Second"
"Count/Second"
"None"
contactProtocols
— (Array<String>
)The contact protocols for the alarm, such as
Email
,SMS
(text messaging), or both.notificationTriggers
— (Array<String>
)The alarm states that trigger a notification.
notificationEnabled
— (Boolean
)Indicates whether the alarm is enabled.
nextPageToken
— (String
)The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another
GetAlarms
request and specify the next page token using thepageToken
parameter.
-
(AWS.Response)
—
Returns:
getAutoSnapshots(params = {}, callback) ⇒ AWS.Request
Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide.
Service Reference:
Examples:
Calling the getAutoSnapshots operation
var params = {
resourceName: 'STRING_VALUE' /* required */
};
lightsail.getAutoSnapshots(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceName
— (String
)The name of the source instance or disk from which to get automatic snapshot information.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:resourceName
— (String
)The name of the source instance or disk for the automatic snapshots.
resourceType
— (String
)The resource type (e.g.,
Possible values include:Instance
orDisk
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
autoSnapshots
— (Array<map>
)An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.
date
— (String
)The date of the automatic snapshot in
YYYY-MM-DD
format.createdAt
— (Date
)The timestamp when the automatic snapshot was created.
status
— (String
)The status of the automatic snapshot.
Possible values include:"Success"
"Failed"
"InProgress"
"NotFound"
fromAttachedDisks
— (Array<map>
)An array of objects that describe the block storage disks attached to the instance when the automatic snapshot was created.
path
— (String
)The path of the disk (e.g.,
/dev/xvdf
).sizeInGb
— (Integer
)The size of the disk in GB.
-
(AWS.Response)
—
Returns:
getBlueprints(params = {}, callback) ⇒ AWS.Request
Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
Service Reference:
Examples:
Calling the getBlueprints operation
var params = {
includeInactive: true || false,
pageToken: 'STRING_VALUE'
};
lightsail.getBlueprints(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
includeInactive
— (Boolean
)A Boolean value indicating whether to include inactive results in your request.
pageToken
— (String
)The token to advance to the next page of results from your request.
To get a page token, perform an initial
GetBlueprints
request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:blueprints
— (Array<map>
)An array of key-value pairs that contains information about the available blueprints.
blueprintId
— (String
)The ID for the virtual private server image (e.g.,
app_wordpress_4_4
orapp_lamp_7_0
).name
— (String
)The friendly name of the blueprint (e.g.,
Amazon Linux
).group
— (String
)The group name of the blueprint (e.g.,
amazon-linux
).type
— (String
)The type of the blueprint (e.g.,
Possible values include:os
orapp
)."os"
"app"
description
— (String
)The description of the blueprint.
isActive
— (Boolean
)A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
minPower
— (Integer
)The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.
0
indicates that the blueprint runs on all instance sizes.version
— (String
)The version number of the operating system, application, or stack (e.g.,
2016.03.0
).versionCode
— (String
)The version code.
productUrl
— (String
)The product URL to learn more about the image or blueprint.
licenseUrl
— (String
)The end-user license agreement URL for the image or blueprint.
platform
— (String
)The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
Possible values include:"LINUX_UNIX"
"WINDOWS"
nextPageToken
— (String
)The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another
GetBlueprints
request and specify the next page token using thepageToken
parameter.
-
(AWS.Response)
—
Returns:
getBundles(params = {}, callback) ⇒ AWS.Request
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
Service Reference:
Examples:
Calling the getBundles operation
var params = {
includeInactive: true || false,
pageToken: 'STRING_VALUE'
};
lightsail.getBundles(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
includeInactive
— (Boolean
)A Boolean value that indicates whether to include inactive bundle results in your request.
pageToken
— (String
)The token to advance to the next page of results from your request.
To get a page token, perform an initial
GetBundles
request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:bundles
— (Array<map>
)An array of key-value pairs that contains information about the available bundles.
price
— (Float
)The price in US dollars (e.g.,
5.0
) of the bundle.cpuCount
— (Integer
)The number of vCPUs included in the bundle (e.g.,
2
).diskSizeInGb
— (Integer
)The size of the SSD (e.g.,
30
).bundleId
— (String
)The bundle ID (e.g.,
micro_1_0
).instanceType
— (String
)The Amazon EC2 instance type (e.g.,
t2.micro
).isActive
— (Boolean
)A Boolean value indicating whether the bundle is active.
name
— (String
)A friendly name for the bundle (e.g.,
Micro
).power
— (Integer
)A numeric value that represents the power of the bundle (e.g.,
500
). You can use the bundle's power value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.ramSizeInGb
— (Float
)The amount of RAM in GB (e.g.,
2.0
).transferPerMonthInGb
— (Integer
)The data transfer rate per month in GB (e.g.,
2000
).supportedPlatforms
— (Array<String>
)The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a
WINDOWS
bundle on a blueprint that supports theWINDOWS
platform.LINUX_UNIX
blueprints require aLINUX_UNIX
bundle.
nextPageToken
— (String
)The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another
GetBundles
request and specify the next page token using thepageToken
parameter.
-
(AWS.Response)
—
Returns:
getCertificates(params = {}, callback) ⇒ AWS.Request
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
includeCertificateDetails
from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags. Service Reference:
Examples:
Calling the getCertificates operation
var params = {
certificateName: 'STRING_VALUE',
certificateStatuses: [
PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED,
/* more items */
],
includeCertificateDetails: true || false
};
lightsail.getCertificates(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
certificateStatuses
— (Array<String>
)The status of the certificates for which to return information.
For example, specify
ISSUED
to return only certificates with anISSUED
status.When omitted, the response includes all of your certificates in the AWS Region where the request is made, regardless of their current status.
includeCertificateDetails
— (Boolean
)Indicates whether to include detailed information about the certificates in the response.
When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.
certificateName
— (String
)The name for the certificate for which to return information.
When omitted, the response includes all of your certificates in the AWS Region where the request is made.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:certificates
— (Array<map>
)An object that describes certificates.
certificateArn
— (String
)The Amazon Resource Name (ARN) of the certificate.
certificateName
— (String
)The name of the certificate.
domainName
— (String
)The domain name of the certificate.
certificateDetail
— (map
)An object that describes a certificate in detail.
arn
— (String
)The Amazon Resource Name (ARN) of the certificate.
name
— (String
)The name of the certificate (e.g.,
my-certificate
).domainName
— (String
)The domain name of the certificate.
status
— (String
)The validation status of the certificate.
Possible values include:"PENDING_VALIDATION"
"ISSUED"
"INACTIVE"
"EXPIRED"
"VALIDATION_TIMED_OUT"
"REVOKED"
"FAILED"
serialNumber
— (String
)The serial number of the certificate.
subjectAlternativeNames
— (Array<String>
)An array of strings that specify the alternate domains (e.g.,
example2.com
) and subdomains (e.g.,blog.example.com
) of the certificate.domainValidationRecords
— (Array<map>
)An array of objects that describe the domain validation records of the certificate.
domainName
— (String
)The domain name of the certificate validation record. For example,
example.com
orwww.example.com
.resourceRecord
— (map
)An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.
name
— (String
)The name of the record.
type
— (String
)The DNS record type.
value
— (String
)The value for the DNS record.
requestFailureReason
— (String
)The validation failure reason, if any, of the certificate.
The following failure reasons are possible:
-
NO_AVAILABLE_CONTACTS
- This failure applies to email validation, which is not available for Lightsail certificates. -
ADDITIONAL_VERIFICATION_REQUIRED
- Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.Note: You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com. -
DOMAIN_NOT_ALLOWED
- One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
-
INVALID_PUBLIC_DOMAIN
- One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate forexample.invalidpublicdomain
becauseinvalidpublicdomain
is not a valid top-level domain. -
OTHER
- Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.
-
inUseResourceCount
— (Integer
)The number of Lightsail resources that the certificate is attached to.
keyAlgorithm
— (String
)The algorithm used to generate the key pair (the public and private key) of the certificate.
createdAt
— (Date
)The timestamp when the certificate was created.
issuedAt
— (Date
)The timestamp when the certificate was issued.
issuerCA
— (String
)The certificate authority that issued the certificate.
notBefore
— (Date
)The timestamp when the certificate is first valid.
notAfter
— (Date
)The timestamp when the certificate expires.
eligibleToRenew
— (String
)The renewal eligibility of the certificate.
renewalSummary
— (map
)An object that describes the status of the certificate renewal managed by Lightsail.
domainValidationRecords
— (Array<map>
)An array of objects that describe the domain validation records of the certificate.
domainName
— (String
)The domain name of the certificate validation record. For example,
example.com
orwww.example.com
.resourceRecord
— (map
)An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.
name
— (String
)The name of the record.
type
— (String
)The DNS record type.
value
— (String
)The value for the DNS record.
renewalStatus
— (String
)The renewal status of the certificate.
The following renewal status are possible:
-
PendingAutoRenewal
- Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required. -
PendingValidation
- Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. 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.
"PendingAutoRenewal"
"PendingValidation"
"Success"
"Failed"
-
renewalStatusReason
— (String
)The reason for the renewal status of the certificate.
updatedAt
— (Date
)The timestamp when the certificate was last updated.
revokedAt
— (Date
)The timestamp when the certificate was revoked. This value is present only when the certificate status is
REVOKED
.revocationReason
— (String
)The reason the certificate was revoked. This value is present only when the certificate status is
REVOKED
.tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
supportCode
— (String
)The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.
tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
-
(AWS.Response)
—
Returns:
getCloudFormationStackRecords(params = {}, callback) ⇒ AWS.Request
Returns the CloudFormation stack record created as a result of the create cloud formation stack
operation.
An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.
Service Reference:
Examples:
Calling the getCloudFormationStackRecords operation
var params = {
pageToken: 'STRING_VALUE'
};
lightsail.getCloudFormationStackRecords(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
pageToken
— (String
)The token to advance to the next page of results from your request.
To get a page token, perform an initial
GetClouFormationStackRecords
request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:cloudFormationStackRecords
— (Array<map>
)A list of objects describing the CloudFormation stack records.
name
— (String
)The name of the CloudFormation stack record. It starts with
CloudFormationStackRecord
followed by a GUID.arn
— (String
)The Amazon Resource Name (ARN) of the CloudFormation stack record.
createdAt
— (Date
)The date when the CloudFormation stack record was created.
location
— (map
)A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The Lightsail resource type (e.g.,
Possible values include:CloudFormationStackRecord
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
state
— (String
)The current state of the CloudFormation stack record.
Possible values include:"Started"
"Succeeded"
"Failed"
sourceInfo
— (Array<map>
)A list of objects describing the source of the CloudFormation stack record.
resourceType
— (String
)The Lightsail resource type (e.g.,
Possible values include:ExportSnapshotRecord
)."ExportSnapshotRecord"
name
— (String
)The name of the record.
arn
— (String
)The Amazon Resource Name (ARN) of the export snapshot record.
destinationInfo
— (map
)A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.
id
— (String
)The ID of the resource created at the destination.
service
— (String
)The destination service of the record.
nextPageToken
— (String
)The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another
GetCloudFormationStackRecords
request and specify the next page token using thepageToken
parameter.
-
(AWS.Response)
—
Returns:
getContactMethods(params = {}, callback) ⇒ AWS.Request
Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
Service Reference:
Examples:
Calling the getContactMethods operation
var params = {
protocols: [
Email | SMS,
/* more items */
]
};
lightsail.getContactMethods(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
protocols
— (Array<String>
)The protocols used to send notifications, such as
Email
, orSMS
(text messaging).Specify a protocol in your request to return information about a specific contact method protocol.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:contactMethods
— (Array<map>
)An array of objects that describe the contact methods.
contactEndpoint
— (String
)The destination of the contact method, such as an email address or a mobile phone number.
status
— (String
)The current status of the contact method.
A contact method has the following possible status:
-
PendingVerification
- The contact method has not yet been verified, and the verification has not yet expired. -
Valid
- The contact method has been verified. -
InValid
- An attempt was made to verify the contact method, but the verification has expired.
"PendingVerification"
"Valid"
"Invalid"
-
protocol
— (String
)The protocol of the contact method, such as email or SMS (text messaging).
Possible values include:"Email"
"SMS"
name
— (String
)The name of the contact method.
arn
— (String
)The Amazon Resource Name (ARN) of the contact method.
createdAt
— (Date
)The timestamp when the contact method was created.
location
— (map
)Describes the resource location.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The Lightsail resource type (e.g.,
Possible values include:ContactMethod
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
supportCode
— (String
)The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.
-
(AWS.Response)
—
Returns:
getContainerAPIMetadata(params = {}, callback) ⇒ AWS.Request
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
Service Reference:
Examples:
Calling the getContainerAPIMetadata operation
var params = {
};
lightsail.getContainerAPIMetadata(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
- params (Object) (defaults to: {})
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:metadata
— (Array<map<String>>
)Metadata about Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
-
(AWS.Response)
—
Returns:
getContainerImages(params = {}, callback) ⇒ AWS.Request
Returns the container images that are registered to your Amazon Lightsail container service.
Service Reference:
Examples:
Calling the getContainerImages operation
var params = {
serviceName: 'STRING_VALUE' /* required */
};
lightsail.getContainerImages(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
serviceName
— (String
)The name of the container service for which to return registered container images.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:containerImages
— (Array<map>
)An array of objects that describe container images that are registered to the container service.
image
— (String
)The name of the container image.
digest
— (String
)The digest of the container image.
createdAt
— (Date
)The timestamp when the container image was created.
-
(AWS.Response)
—
Returns:
getContainerLog(params = {}, callback) ⇒ AWS.Request
Returns the log events of a container of your Amazon Lightsail container service.
If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.
Service Reference:
Examples:
Calling the getContainerLog operation
var params = {
containerName: 'STRING_VALUE', /* required */
serviceName: 'STRING_VALUE', /* required */
endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
filterPattern: 'STRING_VALUE',
pageToken: 'STRING_VALUE',
startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
lightsail.getContainerLog(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
serviceName
— (String
)The name of the container service for which to get a container log.
containerName
— (String
)The name of the container that is either running or previously ran on the container service for which to return a log.
startTime
— (Date
)The start of the time interval for which to get log data.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
1538424000
as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
-
endTime
— (Date
)The end of the time interval for which to get log data.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify
1538427600
as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
-
filterPattern
— (String
)The pattern to use to filter the returned log events to a specific term.
The following are a few examples of filter patterns that you can specify:
-
To return all log events, specify a filter pattern of
""
. -
To exclude log events that contain the
ERROR
term, and return all other log events, specify a filter pattern of"-ERROR"
. -
To return log events that contain the
ERROR
term, specify a filter pattern of"ERROR"
. -
To return log events that contain both the
ERROR
andException
terms, specify a filter pattern of"ERROR Exception"
. -
To return log events that contain the
ERROR
or theException
term, specify a filter pattern of"?ERROR ?Exception"
.
-
pageToken
— (String
)The token to advance to the next page of results from your request.
To get a page token, perform an initial
GetContainerLog
request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:logEvents
— (Array<map>
)An array of objects that describe the log events of a container.
createdAt
— (Date
)The timestamp when the container service log event was created.
message
— (String
)The message of the container service log event.
nextPageToken
— (String
)The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another
GetContainerLog
request and specify the next page token using thepageToken
parameter.
-
(AWS.Response)
—
Returns:
getContainerServiceDeployments(params = {}, callback) ⇒ AWS.Request
Returns the deployments for your 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.
The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.
Service Reference:
Examples:
Calling the getContainerServiceDeployments operation
var params = {
serviceName: 'STRING_VALUE' /* required */
};
lightsail.getContainerServiceDeployments(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
serviceName
— (String
)The name of the container service for which to return deployments.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:deployments
— (Array<map>
)An array of objects that describe deployments for a container service.
version
— (Integer
)The version number of the deployment.
state
— (String
)The state of the deployment.
A deployment can be in one of the following states:
-
Activating
- The deployment is being created. -
Active
- The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. -
Inactive
- The deployment was previously successfully created, but it is not currently running on the container service. -
Failed
- The deployment failed. Use theGetContainerLog
action to view the log events for the containers in the deployment to try to determine the reason for the failure.
"ACTIVATING"
"ACTIVE"
"INACTIVE"
"FAILED"
-
containers
— (map<map>
)An object that describes the configuration for the containers of the deployment.
image
— (String
)The name of the image used for the container.
Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (
:
). For example,:container-service-1.mystaticwebsite.1
. Container images sourced from a public registry like Docker Hub don't start with a colon. For example,nginx:latest
ornginx
.command
— (Array<String>
)The launch command for the container.
environment
— (map<String>
)The environment variables of the container.
ports
— (map<String>
)The open firewall ports of the container.
publicEndpoint
— (map
)An object that describes the endpoint of the deployment.
containerName
— (String
)The name of the container entry of the deployment that the endpoint configuration applies to.
containerPort
— (Integer
)The port of the specified container to which traffic is forwarded to.
healthCheck
— (map
)An object that describes the health check configuration of the container.
healthyThreshold
— (Integer
)The number of consecutive health checks successes required before moving the container to the
Healthy
state. The default value is2
.unhealthyThreshold
— (Integer
)The number of consecutive health check failures required before moving the container to the
Unhealthy
state. The default value is2
.timeoutSeconds
— (Integer
)The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is
2
.intervalSeconds
— (Integer
)The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is
5
.path
— (String
)The path on the container on which to perform the health check. The default value is
/
.successCodes
— (String
)The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
createdAt
— (Date
)The timestamp when the deployment was created.
-
(AWS.Response)
—
Returns:
getContainerServiceMetricData(params = {}, callback) ⇒ AWS.Request
Returns the data points of a specific metric of your Amazon Lightsail container service.
Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
Service Reference:
Examples:
Calling the getContainerServiceMetricData operation
var params = {
endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
metricName: CPUUtilization | MemoryUtilization, /* required */
period: 'NUMBER_VALUE', /* required */
serviceName: 'STRING_VALUE', /* required */
startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
statistics: [ /* required */
Minimum | Maximum | Sum | Average | SampleCount,
/* more items */
]
};
lightsail.getContainerServiceMetricData(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
serviceName
— (String
)The name of the container service for which to get metric data.
metricName
— (String
)The metric for which you want to return information.
Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
-
CPUUtilization
- The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.Statistics: The most useful statistics are
Maximum
andAverage
.Unit: The published unit is
Percent
. -
MemoryUtilization
- The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.Statistics: The most useful statistics are
Maximum
andAverage
.Unit: The published unit is
Percent
.
"CPUUtilization"
"MemoryUtilization"
-
startTime
— (Date
)The start time of the time period.
endTime
— (Date
)The end time of the time period.
period
— (Integer
)The granularity, in seconds, of the returned data points.
All container service metric data is available in 5-minute (300 seconds) granularity.
statistics
— (Array<String>
)The statistic for the metric.
The following statistics are available:
-
Minimum
- The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. -
Maximum
- The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. -
Sum
- All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. -
Average
- The value ofSum
/SampleCount
during the specified period. By comparing this statistic with theMinimum
andMaximum
values, you can determine the full scope of a metric and how close the average use is to theMinimum
andMaximum
values. This comparison helps you to know when to increase or decrease your resources. -
SampleCount
- The count, or number, of data points used for the statistical calculation.
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:metricName
— (String
)The name of the metric returned.
Possible values include:"CPUUtilization"
"MemoryUtilization"
metricData
— (Array<map>
)An array of objects that describe the metric data returned.
average
— (Float
)The average.
maximum
— (Float
)The maximum.
minimum
— (Float
)The minimum.
sampleCount
— (Float
)The sample count.
sum
— (Float
)The sum.
timestamp
— (Date
)The timestamp (e.g.,
1479816991.349
).unit
— (String
)The unit.
Possible values include:"Seconds"
"Microseconds"
"Milliseconds"
"Bytes"
"Kilobytes"
"Megabytes"
"Gigabytes"
"Terabytes"
"Bits"
"Kilobits"
"Megabits"
"Gigabits"
"Terabits"
"Percent"
"Count"
"Bytes/Second"
"Kilobytes/Second"
"Megabytes/Second"
"Gigabytes/Second"
"Terabytes/Second"
"Bits/Second"
"Kilobits/Second"
"Megabits/Second"
"Gigabits/Second"
"Terabits/Second"
"Count/Second"
"None"
-
(AWS.Response)
—
Returns:
getContainerServicePowers(params = {}, callback) ⇒ AWS.Request
Returns the list of powers that can be specified for your Amazon Lightsail container services.
The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.
Service Reference:
Examples:
Calling the getContainerServicePowers operation
var params = {
};
lightsail.getContainerServicePowers(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
- params (Object) (defaults to: {})
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:powers
— (Array<map>
)An array of objects that describe the powers that can be specified for a container service.
powerId
— (String
)The ID of the power (e.g.,
nano-1
).price
— (Float
)The monthly price of the power in USD.
cpuCount
— (Float
)The number of vCPUs included in the power.
ramSizeInGb
— (Float
)The amount of RAM (in GB) of the power.
name
— (String
)The friendly name of the power (e.g.,
nano
).isActive
— (Boolean
)A Boolean value indicating whether the power is active and can be specified for container services.
-
(AWS.Response)
—
Returns:
getContainerServices(params = {}, callback) ⇒ AWS.Request
Returns information about one or more of your Amazon Lightsail container services.
Service Reference:
Examples:
Calling the getContainerServices operation
var params = {
serviceName: 'STRING_VALUE'
};
lightsail.getContainerServices(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
serviceName
— (String
)The name of the container service for which to return information.
When omitted, the response includes all of your container services in the AWS Region where the request is made.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:containerServices
— (Array<map>
)An array of objects that describe one or more container services.
containerServiceName
— (String
)The name of the container service.
arn
— (String
)The Amazon Resource Name (ARN) of the container service.
createdAt
— (Date
)The timestamp when the container service was created.
location
— (map
)An object that describes the location of the container service, such as the AWS Region and Availability Zone.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The Lightsail resource type of the container service (i.e.,
Possible values include:ContainerService
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
power
— (String
)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.
Possible values include:"nano"
"micro"
"small"
"medium"
"large"
"xlarge"
powerId
— (String
)The ID of the power of the container service.
state
— (String
)The current state of the container service.
The state can be:
-
Pending
- The container service is being created. -
Ready
- The container service is created but does not have a container deployment. -
Disabled
- The container service is disabled. -
Updating
- The container service capacity or other setting is being updated. -
Deploying
- The container service is launching a container deployment. -
Running
- The container service is created and it has a container deployment.
"PENDING"
"READY"
"RUNNING"
"UPDATING"
"DELETING"
"DISABLED"
-
scale
— (Integer
)The scale specification of the container service.
The scale specifies the allocated compute nodes of the container service.
currentDeployment
— (map
)An object that describes the current container deployment of the container service.
version
— (Integer
)The version number of the deployment.
state
— (String
)The state of the deployment.
A deployment can be in one of the following states:
-
Activating
- The deployment is being created. -
Active
- The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. -
Inactive
- The deployment was previously successfully created, but it is not currently running on the container service. -
Failed
- The deployment failed. Use theGetContainerLog
action to view the log events for the containers in the deployment to try to determine the reason for the failure.
"ACTIVATING"
"ACTIVE"
"INACTIVE"
"FAILED"
-
containers
— (map<map>
)An object that describes the configuration for the containers of the deployment.
image
— (String
)The name of the image used for the container.
Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (
:
). For example,:container-service-1.mystaticwebsite.1
. Container images sourced from a public registry like Docker Hub don't start with a colon. For example,nginx:latest
ornginx
.command
— (Array<String>
)The launch command for the container.
environment
— (map<String>
)The environment variables of the container.
ports
— (map<String>
)The open firewall ports of the container.
publicEndpoint
— (map
)An object that describes the endpoint of the deployment.
containerName
— (String
)The name of the container entry of the deployment that the endpoint configuration applies to.
containerPort
— (Integer
)The port of the specified container to which traffic is forwarded to.
healthCheck
— (map
)An object that describes the health check configuration of the container.
healthyThreshold
— (Integer
)The number of consecutive health checks successes required before moving the container to the
Healthy
state. The default value is2
.unhealthyThreshold
— (Integer
)The number of consecutive health check failures required before moving the container to the
Unhealthy
state. The default value is2
.timeoutSeconds
— (Integer
)The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is
2
.intervalSeconds
— (Integer
)The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is
5
.path
— (String
)The path on the container on which to perform the health check. The default value is
/
.successCodes
— (String
)The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
createdAt
— (Date
)The timestamp when the deployment was created.
nextDeployment
— (map
)An object that describes the next deployment of the container service.
This value is
null
when there is no deployment in apending
state.version
— (Integer
)The version number of the deployment.
state
— (String
)The state of the deployment.
A deployment can be in one of the following states:
-
Activating
- The deployment is being created. -
Active
- The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. -
Inactive
- The deployment was previously successfully created, but it is not currently running on the container service. -
Failed
- The deployment failed. Use theGetContainerLog
action to view the log events for the containers in the deployment to try to determine the reason for the failure.
"ACTIVATING"
"ACTIVE"
"INACTIVE"
"FAILED"
-
containers
— (map<map>
)An object that describes the configuration for the containers of the deployment.
image
— (String
)The name of the image used for the container.
Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (
:
). For example,:container-service-1.mystaticwebsite.1
. Container images sourced from a public registry like Docker Hub don't start with a colon. For example,nginx:latest
ornginx
.command
— (Array<String>
)The launch command for the container.
environment
— (map<String>
)The environment variables of the container.
ports
— (map<String>
)The open firewall ports of the container.
publicEndpoint
— (map
)An object that describes the endpoint of the deployment.
containerName
— (String
)The name of the container entry of the deployment that the endpoint configuration applies to.
containerPort
— (Integer
)The port of the specified container to which traffic is forwarded to.
healthCheck
— (map
)An object that describes the health check configuration of the container.
healthyThreshold
— (Integer
)The number of consecutive health checks successes required before moving the container to the
Healthy
state. The default value is2
.unhealthyThreshold
— (Integer
)The number of consecutive health check failures required before moving the container to the
Unhealthy
state. The default value is2
.timeoutSeconds
— (Integer
)The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is
2
.intervalSeconds
— (Integer
)The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is
5
.path
— (String
)The path on the container on which to perform the health check. The default value is
/
.successCodes
— (String
)The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
createdAt
— (Date
)The timestamp when the deployment was created.
isDisabled
— (Boolean
)A Boolean value indicating whether the container service is disabled.
principalArn
— (String
)The principal ARN of the container service.
The principal ARN can be used to create a trust relationship between your standard AWS account and your Lightsail container service. This allows you to give your service permission to access resources in your standard AWS account.
privateDomainName
— (String
)The private domain name of the container service.
The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.
publicDomainNames
— (map<Array<String>>
)The public domain name of the container service, such as
example.com
andwww.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 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
CreateCertificate
action to create a certificate for the public domain names you want to use with your container service.See
CreateContainerService
orUpdateContainerService
for information about how to specify public domain names for your Lightsail container service.url
— (String
)The publicly accessible URL of the container service.
If no public endpoint is specified in the
currentDeployment
, this URL returns a 404 response.
-
(AWS.Response)
—
Returns:
getDisk(params = {}, callback) ⇒ AWS.Request
Returns information about a specific block storage disk.
Service Reference:
Examples:
Calling the getDisk operation
var params = {
diskName: 'STRING_VALUE' /* required */
};
lightsail.getDisk(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
diskName
— (String
)The name of the disk (e.g.,
my-disk
).
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:disk
— (map
)An object containing information about the disk.
name
— (String
)The unique name of the disk.
arn
— (String
)The Amazon Resource Name (ARN) of the disk.
supportCode
— (String
)The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
createdAt
— (Date
)The date when the disk was created.
location
— (map
)The AWS Region and Availability Zone where the disk is located.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The Lightsail resource type (e.g.,
Possible values include:Disk
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
addOns
— (Array<map>
)An array of objects representing the add-ons enabled on the disk.
name
— (String
)The name of the add-on.
status
— (String
)The status of the add-on.
snapshotTimeOfDay
— (String
)The daily time when an automatic snapshot is created.
The time shown is in
HH:00
format, and in Coordinated Universal Time (UTC).The snapshot is automatically created between the time shown and up to 45 minutes after.
nextSnapshotTimeOfDay
— (String
)The next daily time an automatic snapshot will be created.
The time shown is in
HH:00
format, and in Coordinated Universal Time (UTC).The snapshot is automatically created between the time shown and up to 45 minutes after.
sizeInGb
— (Integer
)The size of the disk in GB.
isSystemDisk
— (Boolean
)A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
iops
— (Integer
)The input/output operations per second (IOPS) of the disk.
path
— (String
)The disk path.
state
— (String
)Describes the status of the disk.
Possible values include:"pending"
"error"
"available"
"in-use"
"unknown"
attachedTo
— (String
)The resources to which the disk is attached.
isAttached
— (Boolean
)A Boolean value indicating whether the disk is attached.
attachmentState
— (String
)(Deprecated) The attachment state of the disk.
Note: In releases prior to November 14, 2017, this parameter returnedattached
for system disks in the API response. It is now deprecated, but still included in the response. UseisAttached
instead.gbInUse
— (Integer
)(Deprecated) The number of GB in use by the disk.
Note: In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
-
(AWS.Response)
—
Returns:
getDisks(params = {}, callback) ⇒ AWS.Request
Returns information about all block storage disks in your AWS account and region.
Service Reference:
Examples:
Calling the getDisks operation
var params = {
pageToken: 'STRING_VALUE'
};
lightsail.getDisks(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
pageToken
— (String
)The token to advance to the next page of results from your request.
To get a page token, perform an initial
GetDisks
request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:disks
— (Array<map>
)An array of objects containing information about all block storage disks.
name
— (String
)The unique name of the disk.
arn
— (String
)The Amazon Resource Name (ARN) of the disk.
supportCode
— (String
)The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
createdAt
— (Date
)The date when the disk was created.
location
— (map
)The AWS Region and Availability Zone where the disk is located.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The Lightsail resource type (e.g.,
Possible values include:Disk
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
addOns
— (Array<map>
)An array of objects representing the add-ons enabled on the disk.
name
— (String
)The name of the add-on.
status
— (String
)The status of the add-on.
snapshotTimeOfDay
— (String
)The daily time when an automatic snapshot is created.
The time shown is in
HH:00
format, and in Coordinated Universal Time (UTC).The snapshot is automatically created between the time shown and up to 45 minutes after.
nextSnapshotTimeOfDay
— (String
)The next daily time an automatic snapshot will be created.
The time shown is in
HH:00
format, and in Coordinated Universal Time (UTC).The snapshot is automatically created between the time shown and up to 45 minutes after.
sizeInGb
— (Integer
)The size of the disk in GB.
isSystemDisk
— (Boolean
)A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
iops
— (Integer
)The input/output operations per second (IOPS) of the disk.
path
— (String
)The disk path.
state
— (String
)Describes the status of the disk.
Possible values include:"pending"
"error"
"available"
"in-use"
"unknown"
attachedTo
— (String
)The resources to which the disk is attached.
isAttached
— (Boolean
)A Boolean value indicating whether the disk is attached.
attachmentState
— (String
)(Deprecated) The attachment state of the disk.
Note: In releases prior to November 14, 2017, this parameter returnedattached
for system disks in the API response. It is now deprecated, but still included in the response. UseisAttached
instead.gbInUse
— (Integer
)(Deprecated) The number of GB in use by the disk.
Note: In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
nextPageToken
— (String
)The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another
GetDisks
request and specify the next page token using thepageToken
parameter.
-
(AWS.Response)
—
Returns:
getDiskSnapshot(params = {}, callback) ⇒ AWS.Request
Returns information about a specific block storage disk snapshot.
Service Reference:
Examples:
Calling the getDiskSnapshot operation
var params = {
diskSnapshotName: 'STRING_VALUE' /* required */
};
lightsail.getDiskSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
diskSnapshotName
— (String
)The name of the disk snapshot (e.g.,
my-disk-snapshot
).
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:diskSnapshot
— (map
)An object containing information about the disk snapshot.
name
— (String
)The name of the disk snapshot (e.g.,
my-disk-snapshot
).arn
— (String
)The Amazon Resource Name (ARN) of the disk snapshot.
supportCode
— (String
)The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
createdAt
— (Date
)The date when the disk snapshot was created.
location
— (map
)The AWS Region and Availability Zone where the disk snapshot was created.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The Lightsail resource type (e.g.,
Possible values include:DiskSnapshot
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
sizeInGb
— (Integer
)The size of the disk in GB.
state
— (String
)The status of the disk snapshot operation.
Possible values include:"pending"
"completed"
"error"
"unknown"
progress
— (String
)The progress of the snapshot.
fromDiskName
— (String
)The unique name of the source disk from which the disk snapshot was created.
fromDiskArn
— (String
)The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
fromInstanceName
— (String
)The unique name of the source instance from which the disk (system volume) snapshot was created.
fromInstanceArn
— (String
)The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
isFromAutoSnapshot
— (Boolean
)A Boolean value indicating whether the snapshot was created from an automatic snapshot.
-
(AWS.Response)
—
Returns:
getDiskSnapshots(params = {}, callback) ⇒ AWS.Request
Returns information about all block storage disk snapshots in your AWS account and region.
Service Reference:
Examples:
Calling the getDiskSnapshots operation
var params = {
pageToken: 'STRING_VALUE'
};
lightsail.getDiskSnapshots(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
pageToken
— (String
)The token to advance to the next page of results from your request.
To get a page token, perform an initial
GetDiskSnapshots
request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:diskSnapshots
— (Array<map>
)An array of objects containing information about all block storage disk snapshots.
name
— (String
)The name of the disk snapshot (e.g.,
my-disk-snapshot
).arn
— (String
)The Amazon Resource Name (ARN) of the disk snapshot.
supportCode
— (String
)The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
createdAt
— (Date
)The date when the disk snapshot was created.
location
— (map
)The AWS Region and Availability Zone where the disk snapshot was created.
availabilityZone
— (String
)The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName
— (String
)The AWS Region name.
Possible values include:"us-east-1"
"us-east-2"
"us-west-1"
"us-west-2"
"eu-west-1"
"eu-west-2"
"eu-west-3"
"eu-central-1"
"ca-central-1"
"ap-south-1"
"ap-southeast-1"
"ap-southeast-2"
"ap-northeast-1"
"ap-northeast-2"
resourceType
— (String
)The Lightsail resource type (e.g.,
Possible values include:DiskSnapshot
)."ContainerService"
"Instance"
"StaticIp"
"KeyPair"
"InstanceSnapshot"
"Domain"
"PeeredVpc"
"LoadBalancer"
"LoadBalancerTlsCertificate"
"Disk"
"DiskSnapshot"
"RelationalDatabase"
"RelationalDatabaseSnapshot"
"ExportSnapshotRecord"
"CloudFormationStackRecord"
"Alarm"
"ContactMethod"
"Distribution"
"Certificate"
tags
— (Array<map>
)The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
key
— (String
)The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value
— (String
)The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
sizeInGb
— (Integer
)The size of the disk in GB.
state
— (String
)The status of the disk snapshot operation.
Possible values include:"pending"
"completed"
"error"
"unknown"
progress
— (String
)The progress of the snapshot.
fromDiskName
— (String
)The unique name of the source disk from which the disk snapshot was created.
fromDiskArn
— (String
)The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
fromInstanceName
— (String
)The unique name of the source instance from which the disk (system volume) snapshot was created.
fromInstanceArn
— (String
)The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
isFromAutoSnapshot
— (Boolean
)A Boolean value indicating whether the snapshot was created from an automatic snapshot.
nextPageToken
— (String
)The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another
GetDiskSnapshots
request and specify the next page token using thepageToken
parameter.
-
(AWS.Response)
—
Returns:
getDistributionBundles(params = {}, callback) ⇒ AWS.Request
Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.
Service Reference:
Examples:
Calling the getDistributionBundles operation
var params = {
};
lightsail.getDistributionBundles(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
- params (Object) (defaults to: {})
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:bundles
— (Array<map>
)An object that describes a distribution bundle.
bundleId
— (String
)The ID of the bundle.
name
— (String
)The name of the distribution bundle.
price
— (Float
)The monthly price, in US dollars, of the bundle.
transferPerMonthInGb
— (Integer
)The monthly network transfer quota of the bundle.
isActive
— (Boolean
)Indicates whether the bundle is active, and can be specified for a new distribution.
-
(AWS.Response)
—
Returns:
getDistributionLatestCacheReset(params = {}, callback) ⇒ AWS.Request
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
Service Reference:
Examples:
Calling the getDistributionLatestCacheReset operation
var params = {
distributionName: 'STRING_VALUE'
};
lightsail.getDistributionLatestCacheReset(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
distributionName
— (String
)The name of the distribution for which to return the timestamp of the last cache reset.
Use the
GetDistributions
action to get a list of distribution names that you can specify.When omitted, the response includes the latest cache reset timestamp of all your distributions.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:status
— (String
)The status of the last cache reset.
createTime
— (Date
)The timestamp of the last cache reset (e.g.,
1479734909.17
) in Unix time format.
-
(AWS.Response)
—
Returns:
getDistributionMetricData(params = {}, callback) ⇒ AWS.Request
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
Service Reference:
Examples:
Calling the getDistributionMetricData operation
var params = {
distributionName: 'STRING_VALUE', /* required */
endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
metricName: Requests | BytesDownloaded | BytesUploaded | TotalErrorRate | Http4xxErrorRate | Http5xxErrorRate, /* required */
period: 'NUMBER_VALUE', /* required */
startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
statistics: [ /* required */
Minimum | Maximum | Sum | Average | SampleCount,
/* more items */
],
unit: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None /* required */
};
lightsail.getDistributionMetricData(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
distributionName
— (String
)The name of the distribution for which to get metric data.
Use the
GetDistributions
action to get a list of distribution names that you can specify.metricName
— (String
)The metric for which you want to return information.
Valid distribution metric names are listed below, along with the most useful
statistics
to include in your request, and the publishedunit
value.-
Requests
- The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.Statistics
: The most useful statistic isSum
.Unit
: The published unit isNone
. -
BytesDownloaded
- The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.Statistics
: The most useful statistic isSum
.Unit
: The published unit isNone
. -
BytesUploaded
- The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.Statistics
: The most useful statistic isSum
.Unit
: The published unit isNone
. -
TotalErrorRate
- The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isPercent
. -
4xxErrorRate
- The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isPercent
. -
5xxErrorRate
- The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isPercent
.
"Requests"
"BytesDownloaded"
"BytesUploaded"
"TotalErrorRate"
"Http4xxErrorRate"
"Http5xxErrorRate"
-
startTime
— (Date
)The start of the time interval for which to get metric data.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
1538424000
as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
-
endTime
— (Date
)The end of the time interval for which to get metric data.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify
1538427600
as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
-
period
— (Integer
)The granularity, in seconds, for the metric data points that will be returned.
unit
— (String
)The unit for the metric data request.
Valid units depend on the metric data being requested. For the valid units with each available metric, see the
Possible values include:metricName
parameter."Seconds"
"Microseconds"
"Milliseconds"
"Bytes"
"Kilobytes"
"Megabytes"
"Gigabytes"
"Terabytes"
"Bits"
"Kilobits"
"Megabits"
"Gigabits"
"Terabits"
"Percent"
"Count"
"Bytes/Second"
"Kilobytes/Second"
"Megabytes/Second"
"Gigabytes/Second"
"Terabytes/Second"
"Bits/Second"
"Kilobits/Second"
"Megabits/Second"
"Gigabits/Second"
"Terabits/Second"
"Count/Second"
"None"
statistics
— (Array<String>
)The statistic for the metric.
The following statistics are available:
-
Minimum
- The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. -
Maximum
- The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. -
Sum
- All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. -
Average
- The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. -
SampleCount
- The count, or number, of data points used for the statistical calculation.
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:metricName
— (String
)The name of the metric returned.
Possible values include:"Requests"
"BytesDownloaded"
"BytesUploaded"
"TotalErrorRate"
"Http4xxErrorRate"
"Http5xxErrorRate"
metricData
— (Array<map>
)An array of objects that describe the metric data returned.
average
— (Float
)The average.
maximum
— (Float
)The maximum.
minimum
— (Float
)The minimum.
sampleCount
— (Float
)The sample count.
sum
— (Float
)The sum.
timestamp
— (Date
)The timestamp (e.g.,
1479816991.349
).unit
— (String
)The unit.
Possible values include:"Seconds"
"Microseconds"
"Milliseconds"
"Bytes"
"Kilobytes"
"Megabytes"
"Gigabytes"
"Terabytes"
"Bits"
"Kilobits"
"Megabits"
"Gigabits"
"Terabits"
"Percent"
"Count"
"Bytes/Second"
"Kilobytes/Second"
"Megabytes/Second"
"Gigabytes/Second"
"Terabytes/Second"
"Bits/Second"
"Kilobits/Second"
"Megabits/Second"
"Gigabits/Second"
"Terabits/Second"
"Count/Second"
"None"
-
(AWS.Response)
—
Returns:
getDistributions(params = {}, callback) ⇒ AWS.Request
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
Service Reference:
Examples:
Calling the getDistributions operation
var params = {
distributionName: 'STRING_VALUE',
pageToken: 'STRING_VALUE'
};
lightsail.getDistributions(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
- params (Object)