Class: AWS.Lightsail

Inherits:
AWS.Service show all
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 AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, a managed database, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).

For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.

To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.

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

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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) —

    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'.

  • 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.
  • 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 to true.

  • 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.
  • 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

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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',
    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 to 65535

        • ICMP - 8 (to configure Ping)

          Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
      • toPort — (Integer)

        The last port in a range of open ports on an instance.

        Allowed ports:

        • TCP and UDP - 0 to 65535

        • ICMP - -1 (to configure Ping)

          Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
      • 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.

          Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
        Possible values include:
        • "tcp"
        • "all"
        • "udp"
        • "icmp"
      • cidrs — (Array<String>)

        The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

        Examples:

        • To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

        • To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

        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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The restore date and use 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. The use latest restorable auto snapshot and restore 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

        • INSTANCE - Use the configured firewall settings from the source Lightsail instance.

        • NONE - Use the default Amazon EC2 security group.

        • CLOSED - All ports closed.

        Note: If you configured lightsail-connect as a cidrListAliases 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.
        Possible values include:
        • "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 use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg.
      • 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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 or SMS (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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The disk snapshot name and source 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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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. The source disk name and disk 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. The restore date and use 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. The use latest restorable auto snapshot and restore 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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 the instance name parameter. The disk name and instance 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 the disk name parameter. The instance name and disk name parameters are mutually exclusive.
    • tags — (Array<map>)

      The tag keys and optional values to add to the resource during create.

      To tag a resource after it has been created, see the tag resource operation.

      • 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDomainEntry(params = {}, callback) ⇒ AWS.Request

Creates one of the following entry records associated with the domain: 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 set isAlias to true 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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',
  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 the include 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 or app_lamp_7_0). Use the get 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 use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. 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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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',
  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 the include 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. The instance snapshot name and source 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 use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. 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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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.

    • 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. The source instance name and instance 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. The restore date and use 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. The use latest restorable auto snapshot and restore 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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. The data 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 KeyPair).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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',
  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, then certificateDomainName is required (and vice-versa).

    • certificateDomainName — (String)

      The domain name with which your certificate is associated (e.g., example.com).

      If you specify certificateDomainName, then certificateName 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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLoadBalancerTlsCertificate(params = {}, callback) ⇒ AWS.Request

Creates a Lightsail load balancer TLS certificate.

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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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 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 the include 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 of false 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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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 the include 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 of false 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 is true.

      • 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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

      To tag a resource after it has been created, see the tag resource operation.

      • 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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 the get 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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 or SMS (text messaging).

      Note: To delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol.
      Possible values include:
      • "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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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).

Note: The disk may remain in the 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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 set isAlias to true 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. If false is specified, a database snapshot is created before your database is deleted.

      You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false.

      Default: false

    • finalRelationalDatabaseSnapshotName — (String)

      The name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter.

      Note: Specifying this parameter and also specifying the skip final snapshot parameter to true 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Note: Use the 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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 resutls 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 the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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., Alarm).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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:
            • "Instance"
            • "StaticIp"
            • "KeyPair"
            • "InstanceSnapshot"
            • "Domain"
            • "PeeredVpc"
            • "LoadBalancer"
            • "LoadBalancerTlsCertificate"
            • "Disk"
            • "DiskSnapshot"
            • "RelationalDatabase"
            • "RelationalDatabaseSnapshot"
            • "ExportSnapshotRecord"
            • "CloudFormationStackRecord"
            • "Alarm"
            • "ContactMethod"
        • 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.

          Possible values include:
          • "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.

          Possible values include:
          • "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"
        • 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.

          Possible values include:
          • "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 resutls 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 the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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., Instance or Disk).

        Possible values include:
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

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.

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. The data 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 or app_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., os or app).

          Possible values include:
          • "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 resutls 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 the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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).

        • 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 the WINDOWS platform. LINUX_UNIX blueprints require a LINUX_UNIX bundle.

      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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., CloudFormationStackRecord).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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., ExportSnapshotRecord).

            Possible values include:
            • "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 resutls 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 the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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, or SMS (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. The data 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.

          Possible values include:
          • "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., ContactMethod).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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., Disk).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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 returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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., Disk).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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 returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached 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 resutls 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 the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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., DiskSnapshot).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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 disk snapshot operation.

        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. The data 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., DiskSnapshot).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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 disk snapshot operation.

        • 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 resutls 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 the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getDomain(params = {}, callback) ⇒ AWS.Request

Returns information about a specific domain recordset.

Service Reference:

Examples:

Calling the getDomain operation

var params = {
  domainName: 'STRING_VALUE' /* required */
};
lightsail.getDomain(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 for which your want to return information about.

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. The data object has the following properties:

      • domain — (map)

        An array of key-value pairs containing information about your get domain request.

        • name — (String)

          The name of the domain.

        • arn — (String)

          The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-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 date when the domain recordset was created.

        • location — (map)

          The AWS Region and Availability Zones where the domain recordset 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.

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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: + - = . _ : / @

        • domainEntries — (Array<map>)

          An array of key-value pairs containing information about the 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 set isAlias to true 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getDomains(params = {}, callback) ⇒ AWS.Request

Returns a list of all domains in the user's account.

Service Reference:

Examples:

Calling the getDomains operation

var params = {
  pageToken: 'STRING_VALUE'
};
lightsail.getDomains(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 GetDomains 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. The data object has the following properties:

      • domains — (Array<map>)

        An array of key-value pairs containing information about each of the domain entries in the user's account.

        • name — (String)

          The name of the domain.

        • arn — (String)

          The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-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 date when the domain recordset was created.

        • location — (map)

          The AWS Region and Availability Zones where the domain recordset 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.

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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: + - = . _ : / @

        • domainEntries — (Array<map>)

          An array of key-value pairs containing information about the 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 set isAlias to true 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.
      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetDomains request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getExportSnapshotRecords(params = {}, callback) ⇒ AWS.Request

Returns the export snapshot record created as a result of the export snapshot operation.

An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the create cloud formation stack operation.

Service Reference:

Examples:

Calling the getExportSnapshotRecords operation

var params = {
  pageToken: 'STRING_VALUE'
};
lightsail.getExportSnapshotRecords(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 GetExportSnapshotRecords 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. The data object has the following properties:

      • exportSnapshotRecords — (Array<map>)

        A list of objects describing the export snapshot records.

        • name — (String)

          The export snapshot record name.

        • arn — (String)

          The Amazon Resource Name (ARN) of the export snapshot record.

        • createdAt — (Date)

          The date when the export snapshot record was created.

        • location — (map)

          The AWS Region and Availability Zone where the export snapshot record 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., ExportSnapshotRecord).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • state — (String)

          The state of the export snapshot record.

          Possible values include:
          • "Started"
          • "Succeeded"
          • "Failed"
        • sourceInfo — (map)

          A list of objects describing the source of the export snapshot record.

          • resourceType — (String)

            The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot).

            Possible values include:
            • "InstanceSnapshot"
            • "DiskSnapshot"
          • createdAt — (Date)

            The date when the source instance or disk snapshot was created.

          • name — (String)

            The name of the source instance or disk snapshot.

          • arn — (String)

            The Amazon Resource Name (ARN) of the source instance or disk snapshot.

          • fromResourceName — (String)

            The name of the snapshot's source instance or disk.

          • fromResourceArn — (String)

            The Amazon Resource Name (ARN) of the snapshot's source instance or disk.

          • instanceSnapshotInfo — (map)

            A list of objects describing an instance snapshot.

            • fromBundleId — (String)

              The bundle ID from which the source instance was created (e.g., micro_1_0).

            • fromBlueprintId — (String)

              The blueprint ID from which the source instance (e.g., os_debian_8_3).

            • fromDiskInfo — (Array<map>)

              A list of objects describing the disks that were attached to the source instance.

              • name — (String)

                The disk name.

              • path — (String)

                The disk path.

              • sizeInGb — (Integer)

                The size of the disk in GB (e.g., 32).

              • isSystemDisk — (Boolean)

                A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

          • diskSnapshotInfo — (map)

            A list of objects describing a disk snapshot.

            • sizeInGb — (Integer)

              The size of the disk in GB (e.g., 32).

        • destinationInfo — (map)

          A list of objects describing the destination of the export snapshot record.

          • 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 resutls 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 GetExportSnapshotRecords request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getInstance(params = {}, callback) ⇒ AWS.Request

Returns information about a specific Amazon Lightsail instance, which is a virtual private server.

Service Reference:

Examples:

Calling the getInstance operation

var params = {
  instanceName: 'STRING_VALUE' /* required */
};
lightsail.getInstance(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.

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. The data object has the following properties:

      • instance — (map)

        An array of key-value pairs containing information about the specified instance.

        • name — (String)

          The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).

        • arn — (String)

          The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-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 instance was created (e.g., 1479734909.17).

        • location — (map)

          The region name and Availability Zone where the instance 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 type of resource (usually Instance).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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: + - = . _ : / @

        • blueprintId — (String)

          The blueprint ID (e.g., os_amlinux_2016_03).

        • blueprintName — (String)

          The friendly name of the blueprint (e.g., Amazon Linux).

        • bundleId — (String)

          The bundle for the instance (e.g., micro_1_0).

        • addOns — (Array<map>)

          An array of objects representing the add-ons enabled on the instance.

          • 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.

        • isStaticIp — (Boolean)

          A Boolean value indicating whether this instance has a static IP assigned to it.

        • privateIpAddress — (String)

          The private IP address of the instance.

        • publicIpAddress — (String)

          The public IP address of the instance.

        • ipv6Address — (String)

          The IPv6 address of the instance.

        • hardware — (map)

          The size of the vCPU and the amount of RAM for the instance.

          • cpuCount — (Integer)

            The number of vCPUs the instance has.

          • disks — (Array<map>)

            The disks attached to the instance.

            • 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., Disk).

              Possible values include:
              • "Instance"
              • "StaticIp"
              • "KeyPair"
              • "InstanceSnapshot"
              • "Domain"
              • "PeeredVpc"
              • "LoadBalancer"
              • "LoadBalancerTlsCertificate"
              • "Disk"
              • "DiskSnapshot"
              • "RelationalDatabase"
              • "RelationalDatabaseSnapshot"
              • "ExportSnapshotRecord"
              • "CloudFormationStackRecord"
              • "Alarm"
              • "ContactMethod"
            • 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 returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached 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.
          • ramSizeInGb — (Float)

            The amount of RAM in GB on the instance (e.g., 1.0).

        • networking — (map)

          Information about the public ports and monthly data transfer rates for the instance.

          • monthlyTransfer — (map)

            The amount of data in GB allocated for monthly data transfers.

            • gbPerMonthAllocated — (Integer)

              The amount allocated per month (in GB).

          • ports — (Array<map>)

            An array of key-value pairs containing information about the ports on the instance.

            • fromPort — (Integer)

              The first port in a range of open ports on an instance.

              Allowed ports:

              • TCP and UDP - 0 to 65535

              • ICMP - 8 (to configure Ping)

                Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
            • toPort — (Integer)

              The last port in a range of open ports on an instance.

              Allowed ports:

              • TCP and UDP - 0 to 65535

              • ICMP - -1 (to configure Ping)

                Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
            • 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.

                Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
              Possible values include:
              • "tcp"
              • "all"
              • "udp"
              • "icmp"
            • accessFrom — (String)

              The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or Custom if a specific IP address or range of IP addresses is allowed.

            • accessType — (String)

              The type of access (Public or Private).

              Possible values include:
              • "Public"
              • "Private"
            • commonName — (String)

              The common name of the port information.

            • accessDirection — (String)

              The access direction (inbound or outbound).

              Note: Lightsail currently supports only inbound access direction.
              Possible values include:
              • "inbound"
              • "outbound"
            • cidrs — (Array<String>)

              The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

              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.

        • state — (map)

          The status code and the state (e.g., running) for the instance.

          • code — (Integer)

            The status code for the instance.

          • name — (String)

            The state of the instance (e.g., running or pending).

        • username — (String)

          The user name for connecting to the instance (e.g., ec2-user).

        • sshKeyName — (String)

          The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getInstanceAccessDetails(params = {}, callback) ⇒ AWS.Request

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

The get instance access details 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 getInstanceAccessDetails operation

var params = {
  instanceName: 'STRING_VALUE', /* required */
  protocol: ssh | rdp
};
lightsail.getInstanceAccessDetails(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 access.

    • protocol — (String)

      The protocol to use to connect to your instance. Defaults to ssh.

      Possible values include:
      • "ssh"
      • "rdp"

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. The data object has the following properties:

      • accessDetails — (map)

        An array of key-value pairs containing information about a get instance access request.

        • certKey — (String)

          For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub.

        • expiresAt — (Date)

          For SSH access, the date on which the temporary keys expire.

        • ipAddress — (String)

          The public IP address of the Amazon Lightsail instance.

        • password — (String)

          For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

          Note: If you create an instance using any key pair other than the default (LightsailDefaultKeyPair), password will always be an empty string. If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
        • passwordData — (map)

          For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.

          • ciphertext — (String)

            The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

            Note: If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available in the password field. If you are using a custom key pair, you need to use your own means of decryption. If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
          • keyPairName — (String)

            The name of the key pair that you used when creating your instance. If no key pair name was specified when creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair).

            If you are using a custom key pair, you need to use your own means of decrypting your password using the ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair.

        • privateKey — (String)

          For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).

        • protocol — (String)

          The protocol for these Amazon Lightsail instance access details.

          Possible values include:
          • "ssh"
          • "rdp"
        • instanceName — (String)

          The name of this Amazon Lightsail instance.

        • username — (String)

          The user name to use when logging in to the Amazon Lightsail instance.

        • hostKeys — (Array<map>)

          Describes the public SSH host keys or the RDP certificate.

          • algorithm — (String)

            The SSH host key algorithm or the RDP certificate format.

            For SSH host keys, the algorithm may be ssh-rsa, ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the algorithm is always x509-cert.

          • publicKey — (String)

            The public SSH host key or the RDP certificate.

          • witnessedAt — (Date)

            The time that the SSH host key or RDP certificate was recorded by Lightsail.

          • fingerprintSHA1 — (String)

            The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

            • Example of an SHA-1 SSH fingerprint:

              SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0

            • Example of an SHA-1 RDP fingerprint:

              af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45

          • fingerprintSHA256 — (String)

            The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

            • Example of an SHA-256 SSH fingerprint:

              SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o

            • Example of an SHA-256 RDP fingerprint:

              03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68

          • notValidBefore — (Date)

            The returned RDP certificate is valid after this point in time.

            This value is listed only for RDP certificates.

          • notValidAfter — (Date)

            The returned RDP certificate is not valid after this point in time.

            This value is listed only for RDP certificates.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getInstanceMetricData(params = {}, callback) ⇒ AWS.Request

Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.

Service Reference:

Examples:

Calling the getInstanceMetricData operation

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  instanceName: 'STRING_VALUE', /* required */
  metricName: CPUUtilization | NetworkIn | NetworkOut | StatusCheckFailed | StatusCheckFailed_Instance | StatusCheckFailed_System, /* 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.getInstanceMetricData(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 get metrics data.

    • metricName — (String)

      The metric for which you want to return information.

      Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

      • CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Bytes.

      • NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Bytes.

      • StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      Possible values include:
      • "CPUUtilization"
      • "NetworkIn"
      • "NetworkOut"
      • "StatusCheckFailed"
      • "StatusCheckFailed_Instance"
      • "StatusCheckFailed_System"
    • period — (Integer)

      The granularity, in seconds, of the returned data points.

      The StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is available in 1-minute (60 seconds) granularity. All other instance metric data is available in 5-minute (300 seconds) granularity.

    • startTime — (Date)

      The start time of the time period.

    • endTime — (Date)

      The end time of the time period.

    • unit — (String)

      The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units to specify with each available metric, see the metricName parameter.

      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"
    • 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. The data object has the following properties:

      • metricName — (String)

        The metric name to return data for.

        Possible values include:
        • "CPUUtilization"
        • "NetworkIn"
        • "NetworkOut"
        • "StatusCheckFailed"
        • "StatusCheckFailed_Instance"
        • "StatusCheckFailed_System"
      • metricData — (Array<map>)

        An array of key-value pairs containing information about the results of your get instance metric data request.

        • 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"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the getInstancePortStates operation

var params = {
  instanceName: 'STRING_VALUE' /* required */
};
lightsail.getInstancePortStates(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 to return firewall port states.

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. The data object has the following properties:

      • portStates — (Array<map>)

        An array of objects that describe the firewall port states for the specified instance.

        • fromPort — (Integer)

          The first port in a range of open ports on an instance.

          Allowed ports:

          • TCP and UDP - 0 to 65535

          • ICMP - 8 (to configure Ping)

            Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
        • toPort — (Integer)

          The last port in a range of open ports on an instance.

          Allowed ports:

          • TCP and UDP - 0 to 65535

          • ICMP - -1 (to configure Ping)

            Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
        • 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.

            Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
          Possible values include:
          • "tcp"
          • "all"
          • "udp"
          • "icmp"
        • state — (String)

          Specifies whether the instance port is open or closed.

          Note: The port state for Lightsail instances is always open.
          Possible values include:
          • "open"
          • "closed"
        • cidrs — (Array<String>)

          The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getInstances(params = {}, callback) ⇒ AWS.Request

Returns information about all Amazon Lightsail virtual private servers, or instances.

Service Reference:

Examples:

Calling the getInstances operation

var params = {
  pageToken: 'STRING_VALUE'
};
lightsail.getInstances(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 GetInstances 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. The data object has the following properties:

      • instances — (Array<map>)

        An array of key-value pairs containing information about your instances.

        • name — (String)

          The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).

        • arn — (String)

          The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-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 instance was created (e.g., 1479734909.17).

        • location — (map)

          The region name and Availability Zone where the instance 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 type of resource (usually Instance).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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: + - = . _ : / @

        • blueprintId — (String)

          The blueprint ID (e.g., os_amlinux_2016_03).

        • blueprintName — (String)

          The friendly name of the blueprint (e.g., Amazon Linux).

        • bundleId — (String)

          The bundle for the instance (e.g., micro_1_0).

        • addOns — (Array<map>)

          An array of objects representing the add-ons enabled on the instance.

          • 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.

        • isStaticIp — (Boolean)

          A Boolean value indicating whether this instance has a static IP assigned to it.

        • privateIpAddress — (String)

          The private IP address of the instance.

        • publicIpAddress — (String)

          The public IP address of the instance.

        • ipv6Address — (String)

          The IPv6 address of the instance.

        • hardware — (map)

          The size of the vCPU and the amount of RAM for the instance.

          • cpuCount — (Integer)

            The number of vCPUs the instance has.

          • disks — (Array<map>)

            The disks attached to the instance.

            • 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., Disk).

              Possible values include:
              • "Instance"
              • "StaticIp"
              • "KeyPair"
              • "InstanceSnapshot"
              • "Domain"
              • "PeeredVpc"
              • "LoadBalancer"
              • "LoadBalancerTlsCertificate"
              • "Disk"
              • "DiskSnapshot"
              • "RelationalDatabase"
              • "RelationalDatabaseSnapshot"
              • "ExportSnapshotRecord"
              • "CloudFormationStackRecord"
              • "Alarm"
              • "ContactMethod"
            • 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 returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached 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.
          • ramSizeInGb — (Float)

            The amount of RAM in GB on the instance (e.g., 1.0).

        • networking — (map)

          Information about the public ports and monthly data transfer rates for the instance.

          • monthlyTransfer — (map)

            The amount of data in GB allocated for monthly data transfers.

            • gbPerMonthAllocated — (Integer)

              The amount allocated per month (in GB).

          • ports — (Array<map>)

            An array of key-value pairs containing information about the ports on the instance.

            • fromPort — (Integer)

              The first port in a range of open ports on an instance.

              Allowed ports:

              • TCP and UDP - 0 to 65535

              • ICMP - 8 (to configure Ping)

                Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
            • toPort — (Integer)

              The last port in a range of open ports on an instance.

              Allowed ports:

              • TCP and UDP - 0 to 65535

              • ICMP - -1 (to configure Ping)

                Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
            • 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.

                Note: Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.
              Possible values include:
              • "tcp"
              • "all"
              • "udp"
              • "icmp"
            • accessFrom — (String)

              The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or Custom if a specific IP address or range of IP addresses is allowed.

            • accessType — (String)

              The type of access (Public or Private).

              Possible values include:
              • "Public"
              • "Private"
            • commonName — (String)

              The common name of the port information.

            • accessDirection — (String)

              The access direction (inbound or outbound).

              Note: Lightsail currently supports only inbound access direction.
              Possible values include:
              • "inbound"
              • "outbound"
            • cidrs — (Array<String>)

              The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

              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.

        • state — (map)

          The status code and the state (e.g., running) for the instance.

          • code — (Integer)

            The status code for the instance.

          • name — (String)

            The state of the instance (e.g., running or pending).

        • username — (String)

          The user name for connecting to the instance (e.g., ec2-user).

        • sshKeyName — (String)

          The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).

      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetInstances request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getInstanceSnapshot(params = {}, callback) ⇒ AWS.Request

Returns information about a specific instance snapshot.

Service Reference:

Examples:

Calling the getInstanceSnapshot operation

var params = {
  instanceSnapshotName: 'STRING_VALUE' /* required */
};
lightsail.getInstanceSnapshot(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 for which you are requesting 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. The data object has the following properties:

      • instanceSnapshot — (map)

        An array of key-value pairs containing information about the results of your get instance snapshot request.

        • name — (String)

          The name of the snapshot.

        • arn — (String)

          The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-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 snapshot was created (e.g., 1479907467.024).

        • location — (map)

          The region name and Availability Zone where you created the snapshot.

          • 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 type of resource (usually InstanceSnapshot).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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: + - = . _ : / @

        • state — (String)

          The state the snapshot is in.

          Possible values include:
          • "pending"
          • "error"
          • "available"
        • progress — (String)

          The progress of the snapshot.

        • fromAttachedDisks — (Array<map>)

          An array of disk 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., Disk).

            Possible values include:
            • "Instance"
            • "StaticIp"
            • "KeyPair"
            • "InstanceSnapshot"
            • "Domain"
            • "PeeredVpc"
            • "LoadBalancer"
            • "LoadBalancerTlsCertificate"
            • "Disk"
            • "DiskSnapshot"
            • "RelationalDatabase"
            • "RelationalDatabaseSnapshot"
            • "ExportSnapshotRecord"
            • "CloudFormationStackRecord"
            • "Alarm"
            • "ContactMethod"
          • 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 returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached 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.
        • fromInstanceName — (String)

          The instance from which the snapshot was created.

        • fromInstanceArn — (String)

          The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

        • fromBlueprintId — (String)

          The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.

        • fromBundleId — (String)

          The bundle ID from which you created the snapshot (e.g., micro_1_0).

        • isFromAutoSnapshot — (Boolean)

          A Boolean value indicating whether the snapshot was created from an automatic snapshot.

        • sizeInGb — (Integer)

          The size in GB of the SSD.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getInstanceSnapshots(params = {}, callback) ⇒ AWS.Request

Returns all instance snapshots for the user's account.

Service Reference:

Examples:

Calling the getInstanceSnapshots operation

var params = {
  pageToken: 'STRING_VALUE'
};
lightsail.getInstanceSnapshots(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 GetInstanceSnapshots 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. The data object has the following properties:

      • instanceSnapshots — (Array<map>)

        An array of key-value pairs containing information about the results of your get instance snapshots request.

        • name — (String)

          The name of the snapshot.

        • arn — (String)

          The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-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 snapshot was created (e.g., 1479907467.024).

        • location — (map)

          The region name and Availability Zone where you created the snapshot.

          • 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 type of resource (usually InstanceSnapshot).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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: + - = . _ : / @

        • state — (String)

          The state the snapshot is in.

          Possible values include:
          • "pending"
          • "error"
          • "available"
        • progress — (String)

          The progress of the snapshot.

        • fromAttachedDisks — (Array<map>)

          An array of disk 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., Disk).

            Possible values include:
            • "Instance"
            • "StaticIp"
            • "KeyPair"
            • "InstanceSnapshot"
            • "Domain"
            • "PeeredVpc"
            • "LoadBalancer"
            • "LoadBalancerTlsCertificate"
            • "Disk"
            • "DiskSnapshot"
            • "RelationalDatabase"
            • "RelationalDatabaseSnapshot"
            • "ExportSnapshotRecord"
            • "CloudFormationStackRecord"
            • "Alarm"
            • "ContactMethod"
          • 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 returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached 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.
        • fromInstanceName — (String)

          The instance from which the snapshot was created.

        • fromInstanceArn — (String)

          The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

        • fromBlueprintId — (String)

          The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.

        • fromBundleId — (String)

          The bundle ID from which you created the snapshot (e.g., micro_1_0).

        • isFromAutoSnapshot — (Boolean)

          A Boolean value indicating whether the snapshot was created from an automatic snapshot.

        • sizeInGb — (Integer)

          The size in GB of the SSD.

      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetInstanceSnapshots request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getInstanceState(params = {}, callback) ⇒ AWS.Request

Returns the state of a specific instance. Works on one instance at a time.

Service Reference:

Examples:

Calling the getInstanceState operation

var params = {
  instanceName: 'STRING_VALUE' /* required */
};
lightsail.getInstanceState(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 get state information about.

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. The data object has the following properties:

      • state — (map)

        The state of the instance.

        • code — (Integer)

          The status code for the instance.

        • name — (String)

          The state of the instance (e.g., running or pending).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getKeyPair(params = {}, callback) ⇒ AWS.Request

Returns information about a specific key pair.

Service Reference:

Examples:

Calling the getKeyPair operation

var params = {
  keyPairName: 'STRING_VALUE' /* required */
};
lightsail.getKeyPair(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 for which you are requesting 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. The data object has the following properties:

      • keyPair — (map)

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

        • 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 KeyPair).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getKeyPairs(params = {}, callback) ⇒ AWS.Request

Returns information about all key pairs in the user's account.

Service Reference:

Examples:

Calling the getKeyPairs operation

var params = {
  pageToken: 'STRING_VALUE'
};
lightsail.getKeyPairs(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 GetKeyPairs 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. The data object has the following properties:

      • keyPairs — (Array<map>)

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

        • 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 KeyPair).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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.

      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetKeyPairs request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getLoadBalancer(params = {}, callback) ⇒ AWS.Request

Returns information about the specified Lightsail load balancer.

Service Reference:

Examples:

Calling the getLoadBalancer operation

var params = {
  loadBalancerName: 'STRING_VALUE' /* required */
};
lightsail.getLoadBalancer(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.

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. The data object has the following properties:

      • loadBalancer — (map)

        An object containing information about your load balancer.

        • name — (String)

          The name of the load balancer (e.g., my-load-balancer).

        • arn — (String)

          The Amazon Resource Name (ARN) of the load balancer.

        • supportCode — (String)

          The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

        • createdAt — (Date)

          The date when your load balancer was created.

        • location — (map)

          The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

          • 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 (e.g., LoadBalancer.

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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: + - = . _ : / @

        • dnsName — (String)

          The DNS name of your Lightsail load balancer.

        • state — (String)

          The status of your load balancer. Valid values are below.

          Possible values include:
          • "active"
          • "provisioning"
          • "active_impaired"
          • "failed"
          • "unknown"
        • protocol — (String)

          The protocol you have enabled for your load balancer. Valid values are below.

          You can't just have HTTP_HTTPS, but you can have just HTTP.

          Possible values include:
          • "HTTP_HTTPS"
          • "HTTP"
        • publicPorts — (Array<Integer>)

          An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

        • healthCheckPath — (String)

          The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

        • instancePort — (Integer)

          The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

        • instanceHealthSummary — (Array<map>)

          An array of InstanceHealthSummary objects describing the health of the load balancer.

          • instanceName — (String)

            The name of the Lightsail instance for which you are requesting health check data.

          • instanceHealth — (String)

            Describes the overall instance health. Valid values are below.

            Possible values include:
            • "initial"
            • "healthy"
            • "unhealthy"
            • "unused"
            • "draining"
            • "unavailable"
          • instanceHealthReason — (String)

            More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

            If instanceHealth is initial, the instanceHealthReason value can be one of the following:

            • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

            • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

            If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

            • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

            • Instance.Timeout - The health check requests timed out.

            • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

            • Lb.InternalError - The health checks failed due to an internal error.

            If instanceHealth is unused, the instanceHealthReason value can be one of the following:

            • Instance.NotRegistered - The target instance is not registered with the target group.

            • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

            • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

            • Instance.InvalidState - The target is in the stopped or terminated state.

            If instanceHealth is draining, the instanceHealthReason value can be one of the following:

            • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

            Possible values include:
            • "Lb.RegistrationInProgress"
            • "Lb.InitialHealthChecking"
            • "Lb.InternalError"
            • "Instance.ResponseCodeMismatch"
            • "Instance.Timeout"
            • "Instance.FailedHealthChecks"
            • "Instance.NotRegistered"
            • "Instance.NotInUse"
            • "Instance.DeregistrationInProgress"
            • "Instance.InvalidState"
            • "Instance.IpUnusable"
        • tlsCertificateSummaries — (Array<map>)

          An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

          • name — (String)

            The name of the SSL/TLS certificate.

          • isAttached — (Boolean)

            When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

        • configurationOptions — (map<String>)

          A string to string map of the configuration options for your load balancer. Valid values are listed below.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getLoadBalancerMetricData(params = {}, callback) ⇒ AWS.Request

Returns information about health metrics for your Lightsail load balancer.

Service Reference:

Examples:

Calling the getLoadBalancerMetricData operation

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  loadBalancerName: 'STRING_VALUE', /* required */
  metricName: 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, /* 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.getLoadBalancerMetricData(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.

    • metricName — (String)

      The metric for which you want to return information.

      Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

      • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • HealthyHostCount - The number of target instances that are considered healthy.

        Statistics: The most useful statistic are Average, Minimum, and Maximum.

        Unit: The published unit is Count.

      • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Seconds.

      • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • UnhealthyHostCount - The number of target instances that are considered unhealthy.

        Statistics: The most useful statistic are Average, Minimum, and Maximum.

        Unit: The published unit is Count.

      Possible values include:
      • "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"
    • period — (Integer)

      The granularity, in seconds, of the returned data points.

    • startTime — (Date)

      The start time of the period.

    • endTime — (Date)

      The end time of the period.

    • unit — (String)

      The unit for the metric data request. Valid units depend on the metric data being required. For the valid units with each available metric, see the metricName parameter.

      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"
    • 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. The data object has the following properties:

      • metricName — (String)

        The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics to include in your request.

        • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.

          Statistics: The most useful statistic is Sum.

        • HealthyHostCount - The number of target instances that are considered healthy.

          Statistics: The most useful statistic are Average, Minimum, and Maximum.

        • UnhealthyHostCount - The number of target instances that are considered unhealthy.

          Statistics: The most useful statistic are Average, Minimum, and Maximum.

        • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.

          Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.

          Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1.

        • HTTPCode_Instance_2XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

          Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        • HTTPCode_Instance_3XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

          Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        • HTTPCode_Instance_4XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

          Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        • HTTPCode_Instance_5XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

          Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

          Statistics: The most useful statistic is Average.

        • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

          Statistics: The most useful statistic is Sum.

        • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

          Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Possible values include:
        • "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"
      • metricData — (Array<map>)

        An array of metric datapoint objects.

        • 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"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getLoadBalancers(params = {}, callback) ⇒ AWS.Request

Returns information about all load balancers in an account.

Service Reference:

Examples:

Calling the getLoadBalancers operation

var params = {
  pageToken: 'STRING_VALUE'
};
lightsail.getLoadBalancers(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 GetLoadBalancers 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. The data object has the following properties:

      • loadBalancers — (Array<map>)

        An array of LoadBalancer objects describing your load balancers.

        • name — (String)

          The name of the load balancer (e.g., my-load-balancer).

        • arn — (String)

          The Amazon Resource Name (ARN) of the load balancer.

        • supportCode — (String)

          The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

        • createdAt — (Date)

          The date when your load balancer was created.

        • location — (map)

          The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

          • 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 (e.g., LoadBalancer.

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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: + - = . _ : / @

        • dnsName — (String)

          The DNS name of your Lightsail load balancer.

        • state — (String)

          The status of your load balancer. Valid values are below.

          Possible values include:
          • "active"
          • "provisioning"
          • "active_impaired"
          • "failed"
          • "unknown"
        • protocol — (String)

          The protocol you have enabled for your load balancer. Valid values are below.

          You can't just have HTTP_HTTPS, but you can have just HTTP.

          Possible values include:
          • "HTTP_HTTPS"
          • "HTTP"
        • publicPorts — (Array<Integer>)

          An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

        • healthCheckPath — (String)

          The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

        • instancePort — (Integer)

          The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

        • instanceHealthSummary — (Array<map>)

          An array of InstanceHealthSummary objects describing the health of the load balancer.

          • instanceName — (String)

            The name of the Lightsail instance for which you are requesting health check data.

          • instanceHealth — (String)

            Describes the overall instance health. Valid values are below.

            Possible values include:
            • "initial"
            • "healthy"
            • "unhealthy"
            • "unused"
            • "draining"
            • "unavailable"
          • instanceHealthReason — (String)

            More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

            If instanceHealth is initial, the instanceHealthReason value can be one of the following:

            • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

            • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

            If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

            • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

            • Instance.Timeout - The health check requests timed out.

            • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

            • Lb.InternalError - The health checks failed due to an internal error.

            If instanceHealth is unused, the instanceHealthReason value can be one of the following:

            • Instance.NotRegistered - The target instance is not registered with the target group.

            • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

            • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

            • Instance.InvalidState - The target is in the stopped or terminated state.

            If instanceHealth is draining, the instanceHealthReason value can be one of the following:

            • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

            Possible values include:
            • "Lb.RegistrationInProgress"
            • "Lb.InitialHealthChecking"
            • "Lb.InternalError"
            • "Instance.ResponseCodeMismatch"
            • "Instance.Timeout"
            • "Instance.FailedHealthChecks"
            • "Instance.NotRegistered"
            • "Instance.NotInUse"
            • "Instance.DeregistrationInProgress"
            • "Instance.InvalidState"
            • "Instance.IpUnusable"
        • tlsCertificateSummaries — (Array<map>)

          An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

          • name — (String)

            The name of the SSL/TLS certificate.

          • isAttached — (Boolean)

            When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

        • configurationOptions — (map<String>)

          A string to string map of the configuration options for your load balancer. Valid values are listed below.

      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetLoadBalancers request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getLoadBalancerTlsCertificates(params = {}, callback) ⇒ AWS.Request

Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.

Service Reference:

Examples:

Calling the getLoadBalancerTlsCertificates operation

var params = {
  loadBalancerName: 'STRING_VALUE' /* required */
};
lightsail.getLoadBalancerTlsCertificates(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 associated with 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. The data object has the following properties:

      • tlsCertificates — (Array<map>)

        An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.

        • name — (String)

          The name of the SSL/TLS certificate (e.g., my-certificate).

        • arn — (String)

          The Amazon Resource Name (ARN) of the SSL/TLS certificate.

        • supportCode — (String)

          The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.

        • createdAt — (Date)

          The time when you created your SSL/TLS certificate.

        • location — (map)

          The AWS Region and Availability Zone where you created your certificate.

          • 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 (e.g., LoadBalancerTlsCertificate).

          • Instance - A Lightsail instance (a virtual private server)

          • StaticIp - A static IP address

          • KeyPair - The key pair used to connect to a Lightsail instance

          • InstanceSnapshot - A Lightsail instance snapshot

          • Domain - A DNS zone

          • PeeredVpc - A peered VPC

          • LoadBalancer - A Lightsail load balancer

          • LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer

          • Disk - A Lightsail block storage disk

          • DiskSnapshot - A block storage disk snapshot

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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: + - = . _ : / @

        • loadBalancerName — (String)

          The load balancer name where your SSL/TLS certificate is attached.

        • isAttached — (Boolean)

          When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

        • status — (String)

          The status of the SSL/TLS certificate. Valid values are below.

          Possible values include:
          • "PENDING_VALIDATION"
          • "ISSUED"
          • "INACTIVE"
          • "EXPIRED"
          • "VALIDATION_TIMED_OUT"
          • "REVOKED"
          • "FAILED"
          • "UNKNOWN"
        • domainName — (String)

          The domain name for your SSL/TLS certificate.

        • domainValidationRecords — (Array<map>)

          An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

          • name — (String)

            A fully qualified domain name in the certificate. For example, example.com.

          • type — (String)

            The type of validation record. For example, CNAME for domain validation.

          • value — (String)

            The value for that type.

          • validationStatus — (String)

            The validation status. Valid values are listed below.

            Possible values include:
            • "PENDING_VALIDATION"
            • "FAILED"
            • "SUCCESS"
          • domainName — (String)

            The domain name against which your SSL/TLS certificate was validated.

        • failureReason — (String)

          The reason for the SSL/TLS certificate validation failure.

          Possible values include:
          • "NO_AVAILABLE_CONTACTS"
          • "ADDITIONAL_VERIFICATION_REQUIRED"
          • "DOMAIN_NOT_ALLOWED"
          • "INVALID_PUBLIC_DOMAIN"
          • "OTHER"
        • issuedAt — (Date)

          The time when the SSL/TLS certificate was issued.

        • issuer — (String)

          The issuer of the certificate.

        • keyAlgorithm — (String)

          The algorithm that was used to generate the key pair (the public and private key).

        • notAfter — (Date)

          The timestamp when the SSL/TLS certificate expires.

        • notBefore — (Date)

          The timestamp when the SSL/TLS certificate is first valid.

        • renewalSummary — (map)

          An object containing information about the status of Lightsail's managed renewal for the certificate.

          • renewalStatus — (String)

            The status of Lightsail's managed renewal of the certificate. Valid values are listed below.

            Possible values include:
            • "PENDING_AUTO_RENEWAL"
            • "PENDING_VALIDATION"
            • "SUCCESS"
            • "FAILED"
          • domainValidationOptions — (Array<map>)

            Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.

            • domainName — (String)

              The fully qualified domain name in the certificate request.

            • validationStatus — (String)

              The status of the domain validation. Valid values are listed below.

              Possible values include:
              • "PENDING_VALIDATION"
              • "FAILED"
              • "SUCCESS"
        • revocationReason — (String)

          The reason the certificate was revoked. Valid values are below.

          Possible values include:
          • "UNSPECIFIED"
          • "KEY_COMPROMISE"
          • "CA_COMPROMISE"
          • "AFFILIATION_CHANGED"
          • "SUPERCEDED"
          • "CESSATION_OF_OPERATION"
          • "CERTIFICATE_HOLD"
          • "REMOVE_FROM_CRL"
          • "PRIVILEGE_WITHDRAWN"
          • "A_A_COMPROMISE"
        • revokedAt — (Date)

          The timestamp when the SSL/TLS certificate was revoked.

        • serial — (String)

          The serial number of the certificate.

        • signatureAlgorithm — (String)

          The algorithm that was used to sign the certificate.

        • subject — (String)

          The name of the entity that is associated with the public key contained in the certificate.

        • subjectAlternativeNames — (Array<String>)

          One or more domains or subdomains included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CNAME) of the certificate and additional domain names that can be used to connect to the website, such as example.com, www.example.com, or m.example.com.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getOperation(params = {}, callback) ⇒ AWS.Request

Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.

Service Reference:

Examples:

Calling the getOperation operation

var params = {
  operationId: 'STRING_VALUE' /* required */
};
lightsail.getOperation(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: {}) —
    • operationId — (String)

      A GUID used to identify the operation.

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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getOperations(params = {}, callback) ⇒ AWS.Request

Returns information about all operations.

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.

Service Reference:

Examples:

Calling the getOperations operation

var params = {
  pageToken: 'STRING_VALUE'
};
lightsail.getOperations(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 GetOperations 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetOperations request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getOperationsForResource(params = {}, callback) ⇒ AWS.Request

Gets operations for a specific resource (e.g., an instance or a static IP).

Service Reference:

Examples:

Calling the getOperationsForResource operation

var params = {
  resourceName: 'STRING_VALUE', /* required */
  pageToken: 'STRING_VALUE'
};
lightsail.getOperationsForResource(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 resource for which you are requesting information.

    • pageToken — (String)

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetOperationsForResource 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. The data 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:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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"
        • 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.

      • nextPageCount — (String)

        (Deprecated) Returns the number of pages of results that remain.

        Note: In releases prior to June 12, 2017, this parameter returned null by the API. It is now deprecated, and the API returns the next page token parameter instead.
      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetOperationsForResource request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRegions(params = {}, callback) ⇒ AWS.Request

Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.

Service Reference:

Examples:

Calling the getRegions operation

var params = {
  includeAvailabilityZones: true || false,
  includeRelationalDatabaseAvailabilityZones: true || false
};
lightsail.getRegions(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: {}) —
    • includeAvailabilityZones — (Boolean)

      A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., us-east-2a.

    • includeRelationalDatabaseAvailabilityZones — (Boolean)

      >A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (e.g., us-east-2a).

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. The data object has the following properties:

      • regions — (Array<map>)

        An array of key-value pairs containing information about your get regions request.

        • continentCode — (String)

          The continent code (e.g., NA, meaning North America).

        • description — (String)

          The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).

        • displayName — (String)

          The display name (e.g., Ohio).

        • name — (String)

          The region name (e.g., us-east-2).

          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"
        • availabilityZones — (Array<map>)

          The Availability Zones. Follows the format us-east-2a (case-sensitive).

          • zoneName — (String)

            The name of the Availability Zone. The format is us-east-2a (case-sensitive).

          • state — (String)

            The state of the Availability Zone.

        • relationalDatabaseAvailabilityZones — (Array<map>)

          The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).

          • zoneName — (String)

            The name of the Availability Zone. The format is us-east-2a (case-sensitive).

          • state — (String)

            The state of the Availability Zone.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRelationalDatabase(params = {}, callback) ⇒ AWS.Request

Returns information about a specific database in Amazon Lightsail.

Service Reference:

Examples:

Calling the getRelationalDatabase operation

var params = {
  relationalDatabaseName: 'STRING_VALUE' /* required */
};
lightsail.getRelationalDatabase(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 looking up.

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. The data object has the following properties:

      • relationalDatabase — (map)

        An object describing the specified database.

        • name — (String)

          The unique name of the database resource in Lightsail.

        • arn — (String)

          The Amazon Resource Name (ARN) of the database.

        • supportCode — (String)

          The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

        • createdAt — (Date)

          The timestamp when the database was created. Formatted in Unix time.

        • location — (map)

          The Region name and Availability Zone where the database 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 for the database (for example, RelationalDatabase).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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: + - = . _ : / @

        • relationalDatabaseBlueprintId — (String)

          The blueprint ID for the database. A blueprint describes the major engine version of a database.

        • relationalDatabaseBundleId — (String)

          The bundle ID for the database. A bundle describes the performance specifications for your database.

        • masterDatabaseName — (String)

          The name of the master database created when the Lightsail database resource is created.

        • hardware — (map)

          Describes the hardware of the database.

          • cpuCount — (Integer)

            The number of vCPUs for the database.

          • diskSizeInGb — (Integer)

            The size of the disk for the database.

          • ramSizeInGb — (Float)

            The amount of RAM in GB for the database.

        • state — (String)

          Describes the current state of the database.

        • secondaryAvailabilityZone — (String)

          Describes the secondary Availability Zone of a high availability database.

          The secondary database is used for failover support of a high availability database.

        • backupRetentionEnabled — (Boolean)

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

        • pendingModifiedValues — (map)

          Describes pending database value modifications.

          • masterUserPassword — (String)

            The password for the master user of the database.

          • engineVersion — (String)

            The database engine version.

          • backupRetentionEnabled — (Boolean)

            A Boolean value indicating whether automated backup retention is enabled.

        • engine — (String)

          The database software (for example, MySQL).

        • engineVersion — (String)

          The database engine version (for example, 5.7.23).

        • latestRestorableTime — (Date)

          The latest point in time to which the database can be restored. Formatted in Unix time.

        • masterUsername — (String)

          The master user name of the database.

        • parameterApplyStatus — (String)

          The status of parameter updates for the database.

        • preferredBackupWindow — (String)

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

        • preferredMaintenanceWindow — (String)

          The weekly time range during which system maintenance can occur on the database.

          In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.

        • publiclyAccessible — (Boolean)

          A Boolean value indicating whether the database is publicly accessible.

        • masterEndpoint — (map)

          The master endpoint for the database.

          • port — (Integer)

            Specifies the port that the database is listening on.

          • address — (String)

            Specifies the DNS address of the database.

        • pendingMaintenanceActions — (Array<map>)

          Describes the pending maintenance actions for the database.

          • action — (String)

            The type of pending database maintenance action.

          • description — (String)

            Additional detail about the pending database maintenance action.

          • currentApplyDate — (Date)

            The effective date of the pending database maintenance action.

        • caCertificateIdentifier — (String)

          The certificate associated with the database.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRelationalDatabaseBlueprints(params = {}, callback) ⇒ AWS.Request

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.

You can use a blueprint ID to create a new database that runs a specific database engine.

Service Reference:

Examples:

Calling the getRelationalDatabaseBlueprints operation

var params = {
  pageToken: 'STRING_VALUE'
};
lightsail.getRelationalDatabaseBlueprints(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 GetRelationalDatabaseBlueprints 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. The data object has the following properties:

      • blueprints — (Array<map>)

        An object describing the result of your get relational database blueprints request.

        • blueprintId — (String)

          The ID for the database blueprint.

        • engine — (String)

          The database software of the database blueprint (for example, MySQL).

          Possible values include:
          • "mysql"
        • engineVersion — (String)

          The database engine version for the database blueprint (for example, 5.7.23).

        • engineDescription — (String)

          The description of the database engine for the database blueprint.

        • engineVersionDescription — (String)

          The description of the database engine version for the database blueprint.

        • isEngineDefault — (Boolean)

          A Boolean value indicating whether the engine version is the default for the database blueprint.

      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetRelationalDatabaseBlueprints request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRelationalDatabaseBundles(params = {}, callback) ⇒ AWS.Request

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.

You can use a bundle ID to create a new database with explicit performance specifications.

Service Reference:

Examples:

Calling the getRelationalDatabaseBundles operation

var params = {
  pageToken: 'STRING_VALUE'
};
lightsail.getRelationalDatabaseBundles(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 GetRelationalDatabaseBundles 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. The data object has the following properties:

      • bundles — (Array<map>)

        An object describing the result of your get relational database bundles request.

        • bundleId — (String)

          The ID for the database bundle.

        • name — (String)

          The name for the database bundle.

        • price — (Float)

          The cost of the database bundle in US currency.

        • ramSizeInGb — (Float)

          The amount of RAM in GB (for example, 2.0) for the database bundle.

        • diskSizeInGb — (Integer)

          The size of the disk for the database bundle.

        • transferPerMonthInGb — (Integer)

          The data transfer rate per month in GB for the database bundle.

        • cpuCount — (Integer)

          The number of virtual CPUs (vCPUs) for the database bundle.

        • isEncrypted — (Boolean)

          A Boolean value indicating whether the database bundle is encrypted.

        • isActive — (Boolean)

          A Boolean value indicating whether the database bundle is active.

      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetRelationalDatabaseBundles request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRelationalDatabaseEvents(params = {}, callback) ⇒ AWS.Request

Returns a list of events for a specific database in Amazon Lightsail.

Service Reference:

Examples:

Calling the getRelationalDatabaseEvents operation

var params = {
  relationalDatabaseName: 'STRING_VALUE', /* required */
  durationInMinutes: 'NUMBER_VALUE',
  pageToken: 'STRING_VALUE'
};
lightsail.getRelationalDatabaseEvents(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 from which to get events.

    • durationInMinutes — (Integer)

      The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.

      Default: 60

      The minimum is 1 and the maximum is 14 days (20160 minutes).

    • pageToken — (String)

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetRelationalDatabaseEvents 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. The data object has the following properties:

      • relationalDatabaseEvents — (Array<map>)

        An object describing the result of your get relational database events request.

        • resource — (String)

          The database that the database event relates to.

        • createdAt — (Date)

          The timestamp when the database event was created.

        • message — (String)

          The message of the database event.

        • eventCategories — (Array<String>)

          The category that the database event belongs to.

      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetRelationalDatabaseEvents request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRelationalDatabaseLogEvents(params = {}, callback) ⇒ AWS.Request

Returns a list of log events for a database in Amazon Lightsail.

Service Reference:

Examples:

Calling the getRelationalDatabaseLogEvents operation

var params = {
  logStreamName: 'STRING_VALUE', /* required */
  relationalDatabaseName: 'STRING_VALUE', /* required */
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  pageToken: 'STRING_VALUE',
  startFromHead: true || false,
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
lightsail.getRelationalDatabaseLogEvents(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 your database for which to get log events.

    • logStreamName — (String)

      The name of the log stream.

      Use the get relational database log streams operation to get a list of available log streams.

    • startTime — (Date)

      The start of the time interval from which to get log events.

      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, then you input 1538424000 as the start time.

    • endTime — (Date)

      The end of the time interval from which to get log events.

      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 8 PM UTC, then you input 1538424000 as the end time.

    • startFromHead — (Boolean)

      Parameter to specify if the log should start from head or tail. If true is specified, the log event starts from the head of the log. If false is specified, the log event starts from the tail of the log.

      Note: For PostgreSQL, the default value of false is the only option available.
    • pageToken — (String)

      The token to advance to the next or previous page of results from your request.

      To get a page token, perform an initial GetRelationalDatabaseLogEvents request. If your results are paginated, the response will return a next forward token and/or next backward 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. The data object has the following properties:

      • resourceLogEvents — (Array<map>)

        An object describing the result of your get relational database log events request.

        • createdAt — (Date)

          The timestamp when the database log event was created.

        • message — (String)

          The message of the database log event.

      • nextBackwardToken — (String)

        A token used for advancing to the previous page of results from your get relational database log events request.

      • nextForwardToken — (String)

        A token used for advancing to the next page of results from your get relational database log events request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRelationalDatabaseLogStreams(params = {}, callback) ⇒ AWS.Request

Returns a list of available log streams for a specific database in Amazon Lightsail.

Service Reference:

Examples:

Calling the getRelationalDatabaseLogStreams operation

var params = {
  relationalDatabaseName: 'STRING_VALUE' /* required */
};
lightsail.getRelationalDatabaseLogStreams(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 your database for which to get log streams.

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. The data object has the following properties:

      • logStreams — (Array<String>)

        An object describing the result of your get relational database log streams request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRelationalDatabaseMasterUserPassword(params = {}, callback) ⇒ AWS.Request

Returns the current, previous, or pending versions of the master user password for a Lightsail database.

The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

Service Reference:

Examples:

Calling the getRelationalDatabaseMasterUserPassword operation

var params = {
  relationalDatabaseName: 'STRING_VALUE', /* required */
  passwordVersion: CURRENT | PREVIOUS | PENDING
};
lightsail.getRelationalDatabaseMasterUserPassword(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 your database for which to get the master user password.

    • passwordVersion — (String)

      The password version to return.

      Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively. Specifying PENDING returns the newest version of the password that will rotate to CURRENT. After the PENDING password rotates to CURRENT, the PENDING password is no longer available.

      Default: CURRENT

      Possible values include:
      • "CURRENT"
      • "PREVIOUS"
      • "PENDING"

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. The data object has the following properties:

      • masterUserPassword — (String)

        The master user password for the password version specified.

      • createdAt — (Date)

        The timestamp when the specified version of the master user password was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRelationalDatabaseMetricData(params = {}, callback) ⇒ AWS.Request

Returns the data points of the specified metric for a database in Amazon Lightsail.

Service Reference:

Examples:

Calling the getRelationalDatabaseMetricData operation

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  metricName: CPUUtilization | DatabaseConnections | DiskQueueDepth | FreeStorageSpace | NetworkReceiveThroughput | NetworkTransmitThroughput, /* required */
  period: 'NUMBER_VALUE', /* required */
  relationalDatabaseName: '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 */
  ],
  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.getRelationalDatabaseMetricData(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 your database from which to get metric data.

    • metricName — (String)

      The metric for which you want to return information.

      Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.

      • CPUUtilization - The percentage of CPU utilization currently in use on the database.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • DatabaseConnections - The number of database connections in use.

        Statistics: The most useful statistics are Maximum and Sum.

        Unit: The published unit is Count.

      • DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • FreeStorageSpace - The amount of available storage space.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Bytes.

      • NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

      • NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

      Possible values include:
      • "CPUUtilization"
      • "DatabaseConnections"
      • "DiskQueueDepth"
      • "FreeStorageSpace"
      • "NetworkReceiveThroughput"
      • "NetworkTransmitThroughput"
    • period — (Integer)

      The granularity, in seconds, of the returned data points.

      All relational database metric data is available in 1-minute (60 seconds) granularity.

    • startTime — (Date)

      The start of the time interval from 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, then you input 1538424000 as the start time.

    • endTime — (Date)

      The end of the time interval from 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 8 PM UTC, then you input 1538424000 as the end time.

    • unit — (String)

      The unit for the metric data request. Valid units depend on the metric data being required. For the valid units with each available metric, see the metricName parameter.

      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"
    • 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. The data object has the following properties:

      • metricName — (String)

        The name of the metric.

        Possible values include:
        • "CPUUtilization"
        • "DatabaseConnections"
        • "DiskQueueDepth"
        • "FreeStorageSpace"
        • "NetworkReceiveThroughput"
        • "NetworkTransmitThroughput"
      • metricData — (Array<map>)

        An object describing the result of your get relational database metric data request.

        • 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"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.

Service Reference:

Examples:

Calling the getRelationalDatabaseParameters operation

var params = {
  relationalDatabaseName: 'STRING_VALUE', /* required */
  pageToken: 'STRING_VALUE'
};
lightsail.getRelationalDatabaseParameters(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 your database for which to get parameters.

    • pageToken — (String)

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetRelationalDatabaseParameters 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. The data object has the following properties:

      • parameters — (Array<map>)

        An object describing the result of your get relational database parameters request.

        • allowedValues — (String)

          Specifies the valid range of values for the parameter.

        • applyMethod — (String)

          Indicates when parameter updates are applied.

          Can be immediate or pending-reboot.

        • applyType — (String)

          Specifies the engine-specific parameter type.

        • dataType — (String)

          Specifies the valid data type for the parameter.

        • description — (String)

          Provides a description of the parameter.

        • isModifiable — (Boolean)

          A Boolean value indicating whether the parameter can be modified.

        • parameterName — (String)

          Specifies the name of the parameter.

        • parameterValue — (String)

          Specifies the value of the parameter.

      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetRelationalDatabaseParameters request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRelationalDatabases(params = {}, callback) ⇒ AWS.Request

Returns information about all of your databases in Amazon Lightsail.

Service Reference:

Examples:

Calling the getRelationalDatabases operation

var params = {
  pageToken: 'STRING_VALUE'
};
lightsail.getRelationalDatabases(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 GetRelationalDatabases 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. The data object has the following properties:

      • relationalDatabases — (Array<map>)

        An object describing the result of your get relational databases request.

        • name — (String)

          The unique name of the database resource in Lightsail.

        • arn — (String)

          The Amazon Resource Name (ARN) of the database.

        • supportCode — (String)

          The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

        • createdAt — (Date)

          The timestamp when the database was created. Formatted in Unix time.

        • location — (map)

          The Region name and Availability Zone where the database 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 for the database (for example, RelationalDatabase).

          Possible values include:
          • "Instance"
          • "StaticIp"
          • "KeyPair"
          • "InstanceSnapshot"
          • "Domain"
          • "PeeredVpc"
          • "LoadBalancer"
          • "LoadBalancerTlsCertificate"
          • "Disk"
          • "DiskSnapshot"
          • "RelationalDatabase"
          • "RelationalDatabaseSnapshot"
          • "ExportSnapshotRecord"
          • "CloudFormationStackRecord"
          • "Alarm"
          • "ContactMethod"
        • 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: + - = . _ : / @

        • relationalDatabaseBlueprintId — (String)

          The blueprint ID for the database. A blueprint describes the major engine version of a database.

        • relationalDatabaseBundleId — (String)

          The bundle ID for the database. A bundle describes the performance specifications for your database.

        • masterDatabaseName — (String)

          The name of the master database created when the Lightsail database resource is created.

        • hardware — (map)

          Describes the hardware of the database.

          • cpuCount — (Integer)

            The number of vCPUs for the database.

          • diskSizeInGb — (Integer)

            The size of the disk for the database.

          • ramSizeInGb — (Float)

            The amount of RAM in GB for the database.

        • state — (String)

          Describes the current state of the database.

        • secondaryAvailabilityZone — (String)

          Describes the secondary Availability Zone of a high availability database.

          The secondary database is used for failover support of a high availability database.

        • backupRetentionEnabled — (Boolean)

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

        • pendingModifiedValues — (map)

          Describes pending database value modifications.

          • masterUserPassword — (String)

            The password for the master user of the database.

          • engineVersion — (String)

            The database engine version.

          • backupRetentionEnabled — (Boolean)

            A Boolean value indicating whether automated backup retention is enabled.

        • engine — (String)

          The database software (for example, MySQL).

        • engineVersion — (String)

          The database engine version (for example, 5.7.23).

        • latestRestorableTime — (Date)

          The latest point in time to which the database can be restored. Formatted in Unix time.

        • masterUsername — (String)

          The master user name of the database.

        • parameterApplyStatus — (String)

          The status of parameter updates for the database.

        • preferredBackupWindow — (String)

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

        • preferredMaintenanceWindow — (String)

          The weekly time range during which system maintenance can occur on the database.

          In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.

        • publiclyAccessible — (Boolean)

          A Boolean value indicating whether the database is publicly accessible.

        • masterEndpoint — (map)

          The master endpoint for the database.

          • port — (Integer)

            Specifies the port that the database is listening on.

          • address — (String)

            Specifies the DNS address of the database.

        • pendingMaintenanceActions — (Array<map>)

          Describes the pending maintenance actions for the database.

          • action — (String)

            The type of pending database maintenance action.

          • description — (String)

            Additional detail about the pending database maintenance action.

          • currentApplyDate — (Date)

            The effective date of the pending database maintenance action.

        • caCertificateIdentifier — (String)

          The certificate associated with the database.

      • nextPageToken — (String)

        The token to advance to the next page of resutls 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 GetRelationalDatabases request and specify the next page token using the pageToken parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRelationalDatabaseSnapshot(params = {}, callback) ⇒ AWS.Request

Returns information about a specific database snapshot in Amazon Lightsail.

Service Reference:

Examples:

Calling the getRelationalDatabaseSnapshot operation

var params = {
  relationalDatabaseSnapshotName: 'STRING_VALUE' /* required */
};
lightsail.getRelationalDatabaseSnapshot(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 for which to get 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. The data object has the following properties:

      • relationalDatabaseSnapshot — (map)

        An object describing the specified database snapshot.

        • name —