Class: AWS.Lightsail

var params = {
  certificateName: 'STRING_VALUE', /* required */
  distributionName: 'STRING_VALUE' /* required */
};
lightsail.attachCertificateToDistribution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • distributionName — (String)

    The name of the distribution that the certificate will be attached to.

    Use the GetDistributions action to get a list of distribution names that you can specify.

  • certificateName — (String)

    The name of the certificate to attach to a distribution.

    Only certificates with a status of ISSUED can be attached to a distribution.

    Use the GetCertificates action to get a list of certificate names that you can specify.

    Note: This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate and the domain name of the certificate might be example.com.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. 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:
        • "ContainerService"
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
        • "Distribution"
        • "Certificate"
        • "Bucket"
      • createdAt — (Date)

        The timestamp when the operation was initialized (1479816991.349).

      • location — (map)

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • isTerminal — (Boolean)

        A Boolean value indicating whether the operation is terminal.

      • operationDetails — (String)

        Details about the operation (Debian-1GB-Ohio-1).

      • operationType — (String)

        The type of operation.

        Possible values include:
        • "DeleteKnownHostKeys"
        • "DeleteInstance"
        • "CreateInstance"
        • "StopInstance"
        • "StartInstance"
        • "RebootInstance"
        • "OpenInstancePublicPorts"
        • "PutInstancePublicPorts"
        • "CloseInstancePublicPorts"
        • "AllocateStaticIp"
        • "ReleaseStaticIp"
        • "AttachStaticIp"
        • "DetachStaticIp"
        • "UpdateDomainEntry"
        • "DeleteDomainEntry"
        • "CreateDomain"
        • "DeleteDomain"
        • "CreateInstanceSnapshot"
        • "DeleteInstanceSnapshot"
        • "CreateInstancesFromSnapshot"
        • "CreateLoadBalancer"
        • "DeleteLoadBalancer"
        • "AttachInstancesToLoadBalancer"
        • "DetachInstancesFromLoadBalancer"
        • "UpdateLoadBalancerAttribute"
        • "CreateLoadBalancerTlsCertificate"
        • "DeleteLoadBalancerTlsCertificate"
        • "AttachLoadBalancerTlsCertificate"
        • "CreateDisk"
        • "DeleteDisk"
        • "AttachDisk"
        • "DetachDisk"
        • "CreateDiskSnapshot"
        • "DeleteDiskSnapshot"
        • "CreateDiskFromSnapshot"
        • "CreateRelationalDatabase"
        • "UpdateRelationalDatabase"
        • "DeleteRelationalDatabase"
        • "CreateRelationalDatabaseFromSnapshot"
        • "CreateRelationalDatabaseSnapshot"
        • "DeleteRelationalDatabaseSnapshot"
        • "UpdateRelationalDatabaseParameters"
        • "StartRelationalDatabase"
        • "RebootRelationalDatabase"
        • "StopRelationalDatabase"
        • "EnableAddOn"
        • "DisableAddOn"
        • "PutAlarm"
        • "GetAlarms"
        • "DeleteAlarm"
        • "TestAlarm"
        • "CreateContactMethod"
        • "GetContactMethods"
        • "SendContactMethodVerification"
        • "DeleteContactMethod"
        • "CreateDistribution"
        • "UpdateDistribution"
        • "DeleteDistribution"
        • "ResetDistributionCache"
        • "AttachCertificateToDistribution"
        • "DetachCertificateFromDistribution"
        • "UpdateDistributionBundle"
        • "SetIpAddressType"
        • "CreateCertificate"
        • "DeleteCertificate"
        • "CreateContainerService"
        • "UpdateContainerService"
        • "DeleteContainerService"
        • "CreateContainerServiceDeployment"
        • "CreateContainerServiceRegistryLogin"
        • "RegisterContainerImage"
        • "DeleteContainerImage"
        • "CreateBucket"
        • "DeleteBucket"
        • "CreateBucketAccessKey"
        • "DeleteBucketAccessKey"
        • "UpdateBucketBundle"
        • "UpdateBucket"
        • "SetResourceAccessForBucket"
        • "UpdateInstanceMetadataOptions"
        • "StartGUISession"
        • "StopGUISession"
        • "SetupInstanceHttps"
      • status — (String)

        The status of the operation.

        Possible values include:
        • "NotStarted"
        • "Started"
        • "Failed"
        • "Completed"
        • "Succeeded"
      • statusChangedAt — (Date)

        The timestamp when the status was changed (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.

var params = {
  diskName: 'STRING_VALUE', /* required */
  diskPath: 'STRING_VALUE', /* required */
  instanceName: 'STRING_VALUE', /* required */
  autoMounting: true || false
};
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 (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 (/dev/xvdf).

  • autoMounting — (Boolean)

    A Boolean value used to determine the automatic mounting of a storage volume to a virtual computer. The default value is False.

    This value only applies to Lightsail for Research resources.

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:
        • "ContainerService"
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
        • "Distribution"
        • "Certificate"
        • "Bucket"
      • createdAt — (Date)

        The timestamp when the operation was initialized (1479816991.349).

      • location — (map)

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • isTerminal — (Boolean)

        A Boolean value indicating whether the operation is terminal.

      • operationDetails — (String)

        Details about the operation (Debian-1GB-Ohio-1).

      • operationType — (String)

        The type of operation.

        Possible values include:
        • "DeleteKnownHostKeys"
        • "DeleteInstance"
        • "CreateInstance"
        • "StopInstance"
        • "StartInstance"
        • "RebootInstance"
        • "OpenInstancePublicPorts"
        • "PutInstancePublicPorts"
        • "CloseInstancePublicPorts"
        • "AllocateStaticIp"
        • "ReleaseStaticIp"
        • "AttachStaticIp"
        • "DetachStaticIp"
        • "UpdateDomainEntry"
        • "DeleteDomainEntry"
        • "CreateDomain"
        • "DeleteDomain"
        • "CreateInstanceSnapshot"
        • "DeleteInstanceSnapshot"
        • "CreateInstancesFromSnapshot"
        • "CreateLoadBalancer"
        • "DeleteLoadBalancer"
        • "AttachInstancesToLoadBalancer"
        • "DetachInstancesFromLoadBalancer"
        • "UpdateLoadBalancerAttribute"
        • "CreateLoadBalancerTlsCertificate"
        • "DeleteLoadBalancerTlsCertificate"
        • "AttachLoadBalancerTlsCertificate"
        • "CreateDisk"
        • "DeleteDisk"
        • "AttachDisk"
        • "DetachDisk"
        • "CreateDiskSnapshot"
        • "DeleteDiskSnapshot"
        • "CreateDiskFromSnapshot"
        • "CreateRelationalDatabase"
        • "UpdateRelationalDatabase"
        • "DeleteRelationalDatabase"
        • "CreateRelationalDatabaseFromSnapshot"
        • "CreateRelationalDatabaseSnapshot"
        • "DeleteRelationalDatabaseSnapshot"
        • "UpdateRelationalDatabaseParameters"
        • "StartRelationalDatabase"
        • "RebootRelationalDatabase"
        • "StopRelationalDatabase"
        • "EnableAddOn"
        • "DisableAddOn"
        • "PutAlarm"
        • "GetAlarms"
        • "DeleteAlarm"
        • "TestAlarm"
        • "CreateContactMethod"
        • "GetContactMethods"
        • "SendContactMethodVerification"
        • "DeleteContactMethod"
        • "CreateDistribution"
        • "UpdateDistribution"
        • "DeleteDistribution"
        • "ResetDistributionCache"
        • "AttachCertificateToDistribution"
        • "DetachCertificateFromDistribution"
        • "UpdateDistributionBundle"
        • "SetIpAddressType"
        • "CreateCertificate"
        • "DeleteCertificate"
        • "CreateContainerService"
        • "UpdateContainerService"
        • "DeleteContainerService"
        • "CreateContainerServiceDeployment"
        • "CreateContainerServiceRegistryLogin"
        • "RegisterContainerImage"
        • "DeleteContainerImage"
        • "CreateBucket"
        • "DeleteBucket"
        • "CreateBucketAccessKey"
        • "DeleteBucketAccessKey"
        • "UpdateBucketBundle"
        • "UpdateBucket"
        • "SetResourceAccessForBucket"
        • "UpdateInstanceMetadataOptions"
        • "StartGUISession"
        • "StopGUISession"
        • "SetupInstanceHttps"
      • status — (String)

        The status of the operation.

        Possible values include:
        • "NotStarted"
        • "Started"
        • "Failed"
        • "Completed"
        • "Succeeded"
      • statusChangedAt — (Date)

        The timestamp when the status was changed (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.

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:
        • "ContainerService"
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
        • "Distribution"
        • "Certificate"
        • "Bucket"
      • createdAt — (Date)

        The timestamp when the operation was initialized (1479816991.349).

      • location — (map)

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • isTerminal — (Boolean)

        A Boolean value indicating whether the operation is terminal.

      • operationDetails — (String)

        Details about the operation (Debian-1GB-Ohio-1).

      • operationType — (String)

        The type of operation.

        Possible values include:
        • "DeleteKnownHostKeys"
        • "DeleteInstance"
        • "CreateInstance"
        • "StopInstance"
        • "StartInstance"
        • "RebootInstance"
        • "OpenInstancePublicPorts"
        • "PutInstancePublicPorts"
        • "CloseInstancePublicPorts"
        • "AllocateStaticIp"
        • "ReleaseStaticIp"
        • "AttachStaticIp"
        • "DetachStaticIp"
        • "UpdateDomainEntry"
        • "DeleteDomainEntry"
        • "CreateDomain"
        • "DeleteDomain"
        • "CreateInstanceSnapshot"
        • "DeleteInstanceSnapshot"
        • "CreateInstancesFromSnapshot"
        • "CreateLoadBalancer"
        • "DeleteLoadBalancer"
        • "AttachInstancesToLoadBalancer"
        • "DetachInstancesFromLoadBalancer"
        • "UpdateLoadBalancerAttribute"
        • "CreateLoadBalancerTlsCertificate"
        • "DeleteLoadBalancerTlsCertificate"
        • "AttachLoadBalancerTlsCertificate"
        • "CreateDisk"
        • "DeleteDisk"
        • "AttachDisk"
        • "DetachDisk"
        • "CreateDiskSnapshot"
        • "DeleteDiskSnapshot"
        • "CreateDiskFromSnapshot"
        • "CreateRelationalDatabase"
        • "UpdateRelationalDatabase"
        • "DeleteRelationalDatabase"
        • "CreateRelationalDatabaseFromSnapshot"
        • "CreateRelationalDatabaseSnapshot"
        • "DeleteRelationalDatabaseSnapshot"
        • "UpdateRelationalDatabaseParameters"
        • "StartRelationalDatabase"
        • "RebootRelationalDatabase"
        • "StopRelationalDatabase"
        • "EnableAddOn"
        • "DisableAddOn"
        • "PutAlarm"
        • "GetAlarms"
        • "DeleteAlarm"
        • "TestAlarm"
        • "CreateContactMethod"
        • "GetContactMethods"
        • "SendContactMethodVerification"
        • "DeleteContactMethod"
        • "CreateDistribution"
        • "UpdateDistribution"
        • "DeleteDistribution"
        • "ResetDistributionCache"
        • "AttachCertificateToDistribution"
        • "DetachCertificateFromDistribution"
        • "UpdateDistributionBundle"
        • "SetIpAddressType"
        • "CreateCertificate"
        • "DeleteCertificate"
        • "CreateContainerService"
        • "UpdateContainerService"
        • "DeleteContainerService"
        • "CreateContainerServiceDeployment"
        • "CreateContainerServiceRegistryLogin"
        • "RegisterContainerImage"
        • "DeleteContainerImage"
        • "CreateBucket"
        • "DeleteBucket"
        • "CreateBucketAccessKey"
        • "DeleteBucketAccessKey"
        • "UpdateBucketBundle"
        • "UpdateBucket"
        • "SetResourceAccessForBucket"
        • "UpdateInstanceMetadataOptions"
        • "StartGUISession"
        • "StopGUISession"
        • "SetupInstanceHttps"
      • status — (String)

        The status of the operation.

        Possible values include:
        • "NotStarted"
        • "Started"
        • "Failed"
        • "Completed"
        • "Succeeded"
      • statusChangedAt — (Date)

        The timestamp when the status was changed (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.

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:
        • "ContainerService"
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
        • "Distribution"
        • "Certificate"
        • "Bucket"
      • createdAt — (Date)

        The timestamp when the operation was initialized (1479816991.349).

      • location — (map)

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • isTerminal — (Boolean)

        A Boolean value indicating whether the operation is terminal.

      • operationDetails — (String)

        Details about the operation (Debian-1GB-Ohio-1).

      • operationType — (String)

        The type of operation.

        Possible values include:
        • "DeleteKnownHostKeys"
        • "DeleteInstance"
        • "CreateInstance"
        • "StopInstance"
        • "StartInstance"
        • "RebootInstance"
        • "OpenInstancePublicPorts"
        • "PutInstancePublicPorts"
        • "CloseInstancePublicPorts"
        • "AllocateStaticIp"
        • "ReleaseStaticIp"
        • "AttachStaticIp"
        • "DetachStaticIp"
        • "UpdateDomainEntry"
        • "DeleteDomainEntry"
        • "CreateDomain"
        • "DeleteDomain"
        • "CreateInstanceSnapshot"
        • "DeleteInstanceSnapshot"
        • "CreateInstancesFromSnapshot"
        • "CreateLoadBalancer"
        • "DeleteLoadBalancer"
        • "AttachInstancesToLoadBalancer"
        • "DetachInstancesFromLoadBalancer"
        • "UpdateLoadBalancerAttribute"
        • "CreateLoadBalancerTlsCertificate"
        • "DeleteLoadBalancerTlsCertificate"
        • "AttachLoadBalancerTlsCertificate"
        • "CreateDisk"
        • "DeleteDisk"
        • "AttachDisk"
        • "DetachDisk"
        • "CreateDiskSnapshot"
        • "DeleteDiskSnapshot"
        • "CreateDiskFromSnapshot"
        • "CreateRelationalDatabase"
        • "UpdateRelationalDatabase"
        • "DeleteRelationalDatabase"
        • "CreateRelationalDatabaseFromSnapshot"
        • "CreateRelationalDatabaseSnapshot"
        • "DeleteRelationalDatabaseSnapshot"
        • "UpdateRelationalDatabaseParameters"
        • "StartRelationalDatabase"
        • "RebootRelationalDatabase"
        • "StopRelationalDatabase"
        • "EnableAddOn"
        • "DisableAddOn"
        • "PutAlarm"
        • "GetAlarms"
        • "DeleteAlarm"
        • "TestAlarm"
        • "CreateContactMethod"
        • "GetContactMethods"
        • "SendContactMethodVerification"
        • "DeleteContactMethod"
        • "CreateDistribution"
        • "UpdateDistribution"
        • "DeleteDistribution"
        • "ResetDistributionCache"
        • "AttachCertificateToDistribution"
        • "DetachCertificateFromDistribution"
        • "UpdateDistributionBundle"
        • "SetIpAddressType"
        • "CreateCertificate"
        • "DeleteCertificate"
        • "CreateContainerService"
        • "UpdateContainerService"
        • "DeleteContainerService"
        • "CreateContainerServiceDeployment"
        • "CreateContainerServiceRegistryLogin"
        • "RegisterContainerImage"
        • "DeleteContainerImage"
        • "CreateBucket"
        • "DeleteBucket"
        • "CreateBucketAccessKey"
        • "DeleteBucketAccessKey"
        • "UpdateBucketBundle"
        • "UpdateBucket"
        • "SetResourceAccessForBucket"
        • "UpdateInstanceMetadataOptions"
        • "StartGUISession"
        • "StopGUISession"
        • "SetupInstanceHttps"
      • status — (String)

        The status of the operation.

        Possible values include:
        • "NotStarted"
        • "Started"
        • "Failed"
        • "Completed"
        • "Succeeded"
      • statusChangedAt — (Date)

        The timestamp when the status was changed (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.

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:
        • "ContainerService"
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
        • "Distribution"
        • "Certificate"
        • "Bucket"
      • createdAt — (Date)

        The timestamp when the operation was initialized (1479816991.349).

      • location — (map)

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • isTerminal — (Boolean)

        A Boolean value indicating whether the operation is terminal.

      • operationDetails — (String)

        Details about the operation (Debian-1GB-Ohio-1).

      • operationType — (String)

        The type of operation.

        Possible values include:
        • "DeleteKnownHostKeys"
        • "DeleteInstance"
        • "CreateInstance"
        • "StopInstance"
        • "StartInstance"
        • "RebootInstance"
        • "OpenInstancePublicPorts"
        • "PutInstancePublicPorts"
        • "CloseInstancePublicPorts"
        • "AllocateStaticIp"
        • "ReleaseStaticIp"
        • "AttachStaticIp"
        • "DetachStaticIp"
        • "UpdateDomainEntry"
        • "DeleteDomainEntry"
        • "CreateDomain"
        • "DeleteDomain"
        • "CreateInstanceSnapshot"
        • "DeleteInstanceSnapshot"
        • "CreateInstancesFromSnapshot"
        • "CreateLoadBalancer"
        • "DeleteLoadBalancer"
        • "AttachInstancesToLoadBalancer"
        • "DetachInstancesFromLoadBalancer"
        • "UpdateLoadBalancerAttribute"
        • "CreateLoadBalancerTlsCertificate"
        • "DeleteLoadBalancerTlsCertificate"
        • "AttachLoadBalancerTlsCertificate"
        • "CreateDisk"
        • "DeleteDisk"
        • "AttachDisk"
        • "DetachDisk"
        • "CreateDiskSnapshot"
        • "DeleteDiskSnapshot"
        • "CreateDiskFromSnapshot"
        • "CreateRelationalDatabase"
        • "UpdateRelationalDatabase"
        • "DeleteRelationalDatabase"
        • "CreateRelationalDatabaseFromSnapshot"
        • "CreateRelationalDatabaseSnapshot"
        • "DeleteRelationalDatabaseSnapshot"
        • "UpdateRelationalDatabaseParameters"
        • "StartRelationalDatabase"
        • "RebootRelationalDatabase"
        • "StopRelationalDatabase"
        • "EnableAddOn"
        • "DisableAddOn"
        • "PutAlarm"
        • "GetAlarms"
        • "DeleteAlarm"
        • "TestAlarm"
        • "CreateContactMethod"
        • "GetContactMethods"
        • "SendContactMethodVerification"
        • "DeleteContactMethod"
        • "CreateDistribution"
        • "UpdateDistribution"
        • "DeleteDistribution"
        • "ResetDistributionCache"
        • "AttachCertificateToDistribution"
        • "DetachCertificateFromDistribution"
        • "UpdateDistributionBundle"
        • "SetIpAddressType"
        • "CreateCertificate"
        • "DeleteCertificate"
        • "CreateContainerService"
        • "UpdateContainerService"
        • "DeleteContainerService"
        • "CreateContainerServiceDeployment"
        • "CreateContainerServiceRegistryLogin"
        • "RegisterContainerImage"
        • "DeleteContainerImage"
        • "CreateBucket"
        • "DeleteBucket"
        • "CreateBucketAccessKey"
        • "DeleteBucketAccessKey"
        • "UpdateBucketBundle"
        • "UpdateBucket"
        • "SetResourceAccessForBucket"
        • "UpdateInstanceMetadataOptions"
        • "StartGUISession"
        • "StopGUISession"
        • "SetupInstanceHttps"
      • status — (String)

        The status of the operation.

        Possible values include:
        • "NotStarted"
        • "Started"
        • "Failed"
        • "Completed"
        • "Succeeded"
      • statusChangedAt — (Date)

        The timestamp when the status was changed (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.

var params = {
  instanceName: 'STRING_VALUE', /* required */
  portInfo: { /* required */
    cidrListAliases: [
      'STRING_VALUE',
      /* more items */
    ],
    cidrs: [
      'STRING_VALUE',
      /* more items */
    ],
    fromPort: 'NUMBER_VALUE',
    ipv6Cidrs: [
      'STRING_VALUE',
      /* more items */
    ],
    protocol: tcp | all | udp | icmp | icmpv6,
    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 - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

      • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

    • toPort — (Integer)

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

      Allowed ports:

      • TCP and UDP - 0 to 65535

      • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

      • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

    • protocol — (String)

      The IP protocol name.

      The name can be one of the following:

      • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.

      • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.

      • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.

      • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

      • icmp6 - Internet Control Message Protocol (ICMP) for IPv6. When you specify icmp6 as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

      Possible values include:
      • "tcp"
      • "all"
      • "udp"
      • "icmp"
      • "icmpv6"
    • cidrs — (Array<String>)

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

      Note: The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

      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.

    • ipv6Cidrs — (Array<String>)

      The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

      Note: The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

      For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

    • cidrListAliases — (Array<String>)

      An alias that defines access for a preconfigured range of IP addresses.

      The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

  • instanceName — (String)

    The name of the instance for which to close ports.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. 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:
        • "ContainerService"
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
        • "Distribution"
        • "Certificate"
        • "Bucket"
      • createdAt — (Date)

        The timestamp when the operation was initialized (1479816991.349).

      • location — (map)

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • isTerminal — (Boolean)

        A Boolean value indicating whether the operation is terminal.

      • operationDetails — (String)

        Details about the operation (Debian-1GB-Ohio-1).

      • operationType — (String)

        The type of operation.

        Possible values include:
        • "DeleteKnownHostKeys"
        • "DeleteInstance"
        • "CreateInstance"
        • "StopInstance"
        • "StartInstance"
        • "RebootInstance"
        • "OpenInstancePublicPorts"
        • "PutInstancePublicPorts"
        • "CloseInstancePublicPorts"
        • "AllocateStaticIp"
        • "ReleaseStaticIp"
        • "AttachStaticIp"
        • "DetachStaticIp"
        • "UpdateDomainEntry"
        • "DeleteDomainEntry"
        • "CreateDomain"
        • "DeleteDomain"
        • "CreateInstanceSnapshot"
        • "DeleteInstanceSnapshot"
        • "CreateInstancesFromSnapshot"
        • "CreateLoadBalancer"
        • "DeleteLoadBalancer"
        • "AttachInstancesToLoadBalancer"
        • "DetachInstancesFromLoadBalancer"
        • "UpdateLoadBalancerAttribute"
        • "CreateLoadBalancerTlsCertificate"
        • "DeleteLoadBalancerTlsCertificate"
        • "AttachLoadBalancerTlsCertificate"
        • "CreateDisk"
        • "DeleteDisk"
        • "AttachDisk"
        • "DetachDisk"
        • "CreateDiskSnapshot"
        • "DeleteDiskSnapshot"
        • "CreateDiskFromSnapshot"
        • "CreateRelationalDatabase"
        • "UpdateRelationalDatabase"
        • "DeleteRelationalDatabase"
        • "CreateRelationalDatabaseFromSnapshot"
        • "CreateRelationalDatabaseSnapshot"
        • "DeleteRelationalDatabaseSnapshot"
        • "UpdateRelationalDatabaseParameters"
        • "StartRelationalDatabase"
        • "RebootRelationalDatabase"
        • "StopRelationalDatabase"
        • "EnableAddOn"
        • "DisableAddOn"
        • "PutAlarm"
        • "GetAlarms"
        • "DeleteAlarm"
        • "TestAlarm"
        • "CreateContactMethod"
        • "GetContactMethods"
        • "SendContactMethodVerification"
        • "DeleteContactMethod"
        • "CreateDistribution"
        • "UpdateDistribution"
        • "DeleteDistribution"
        • "ResetDistributionCache"
        • "AttachCertificateToDistribution"
        • "DetachCertificateFromDistribution"
        • "UpdateDistributionBundle"
        • "SetIpAddressType"
        • "CreateCertificate"
        • "DeleteCertificate"
        • "CreateContainerService"
        • "UpdateContainerService"
        • "DeleteContainerService"
        • "CreateContainerServiceDeployment"
        • "CreateContainerServiceRegistryLogin"
        • "RegisterContainerImage"
        • "DeleteContainerImage"
        • "CreateBucket"
        • "DeleteBucket"
        • "CreateBucketAccessKey"
        • "DeleteBucketAccessKey"
        • "UpdateBucketBundle"
        • "UpdateBucket"
        • "SetResourceAccessForBucket"
        • "UpdateInstanceMetadataOptions"
        • "StartGUISession"
        • "StopGUISession"
        • "SetupInstanceHttps"
      • status — (String)

        The status of the operation.

        Possible values include:
        • "NotStarted"
        • "Started"
        • "Failed"
        • "Completed"
        • "Succeeded"
      • statusChangedAt — (Date)

        The timestamp when the status was changed (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.

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 | eu-north-1, /* 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 Amazon Lightsail Developer 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 Amazon Lightsail Developer 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 Amazon Lightsail Developer Guide.

  • targetSnapshotName — (String)

    The name of the new manual snapshot to be created as a copy.

  • sourceRegion — (String)

    The Amazon Web Services 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"
    • "eu-north-1"

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:
        • "ContainerService"
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
        • "Distribution"
        • "Certificate"
        • "Bucket"
      • createdAt — (Date)

        The timestamp when the operation was initialized (1479816991.349).

      • location — (map)

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • isTerminal — (Boolean)

        A Boolean value indicating whether the operation is terminal.

      • operationDetails — (String)

        Details about the operation (Debian-1GB-Ohio-1).

      • operationType — (String)

        The type of operation.

        Possible values include:
        • "DeleteKnownHostKeys"
        • "DeleteInstance"
        • "CreateInstance"
        • "StopInstance"
        • "StartInstance"
        • "RebootInstance"
        • "OpenInstancePublicPorts"
        • "PutInstancePublicPorts"
        • "CloseInstancePublicPorts"
        • "AllocateStaticIp"
        • "ReleaseStaticIp"
        • "AttachStaticIp"
        • "DetachStaticIp"
        • "UpdateDomainEntry"
        • "DeleteDomainEntry"
        • "CreateDomain"
        • "DeleteDomain"
        • "CreateInstanceSnapshot"
        • "DeleteInstanceSnapshot"
        • "CreateInstancesFromSnapshot"
        • "CreateLoadBalancer"
        • "DeleteLoadBalancer"
        • "AttachInstancesToLoadBalancer"
        • "DetachInstancesFromLoadBalancer"
        • "UpdateLoadBalancerAttribute"
        • "CreateLoadBalancerTlsCertificate"
        • "DeleteLoadBalancerTlsCertificate"
        • "AttachLoadBalancerTlsCertificate"
        • "CreateDisk"
        • "DeleteDisk"
        • "AttachDisk"
        • "DetachDisk"
        • "CreateDiskSnapshot"
        • "DeleteDiskSnapshot"
        • "CreateDiskFromSnapshot"
        • "CreateRelationalDatabase"
        • "UpdateRelationalDatabase"
        • "DeleteRelationalDatabase"
        • "CreateRelationalDatabaseFromSnapshot"
        • "CreateRelationalDatabaseSnapshot"
        • "DeleteRelationalDatabaseSnapshot"
        • "UpdateRelationalDatabaseParameters"
        • "StartRelationalDatabase"
        • "RebootRelationalDatabase"
        • "StopRelationalDatabase"
        • "EnableAddOn"
        • "DisableAddOn"
        • "PutAlarm"
        • "GetAlarms"
        • "DeleteAlarm"
        • "TestAlarm"
        • "CreateContactMethod"
        • "GetContactMethods"
        • "SendContactMethodVerification"
        • "DeleteContactMethod"
        • "CreateDistribution"
        • "UpdateDistribution"
        • "DeleteDistribution"
        • "ResetDistributionCache"
        • "AttachCertificateToDistribution"
        • "DetachCertificateFromDistribution"
        • "UpdateDistributionBundle"
        • "SetIpAddressType"
        • "CreateCertificate"
        • "DeleteCertificate"
        • "CreateContainerService"
        • "UpdateContainerService"
        • "DeleteContainerService"
        • "CreateContainerServiceDeployment"
        • "CreateContainerServiceRegistryLogin"
        • "RegisterContainerImage"
        • "DeleteContainerImage"
        • "CreateBucket"
        • "DeleteBucket"
        • "CreateBucketAccessKey"
        • "DeleteBucketAccessKey"
        • "UpdateBucketBundle"
        • "UpdateBucket"
        • "SetResourceAccessForBucket"
        • "UpdateInstanceMetadataOptions"
        • "StartGUISession"
        • "StopGUISession"
        • "SetupInstanceHttps"
      • status — (String)

        The status of the operation.

        Possible values include:
        • "NotStarted"
        • "Started"
        • "Failed"
        • "Completed"
        • "Succeeded"
      • statusChangedAt — (Date)

        The timestamp when the status was changed (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.

var params = {
  bucketName: 'STRING_VALUE', /* required */
  bundleId: 'STRING_VALUE', /* required */
  enableObjectVersioning: true || false,
  tags: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
lightsail.createBucket(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: {}) —
  • bucketName — (String)

    The name for the bucket.

    For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.

  • bundleId — (String)

    The ID of the bundle to use for the bucket.

    A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

    Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

    Use the UpdateBucketBundle action to change the bundle after the bucket is created.

  • tags — (Array<map>)

    The tag keys and optional values to add to the bucket during creation.

    Use the TagResource action to tag the bucket after it's created.

    • key — (String)

      The key of the tag.

      Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

    • value — (String)

      The value of the tag.

      Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

  • enableObjectVersioning — (Boolean)

    A Boolean value that indicates whether to enable versioning of objects in the bucket.

    For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer 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:

    • bucket — (map)

      An object that describes the bucket that is created.

      • resourceType — (String)

        The Lightsail resource type of the bucket.

      • accessRules — (map)

        An object that describes the access rules of the bucket.

        • getObject — (String)

          Specifies the anonymous access to all objects in a bucket.

          The following options can be specified:

          • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

            If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

          • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

            If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

          Possible values include:
          • "public"
          • "private"
        • allowPublicOverrides — (Boolean)

          A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.

          When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.

      • arn — (String)

        The Amazon Resource Name (ARN) of the bucket.

      • bundleId — (String)

        The ID of the bundle currently applied to the bucket.

        A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

        Use the UpdateBucketBundle action to change the bundle of a bucket.

      • createdAt — (Date)

        The timestamp when the distribution was created.

      • url — (String)

        The URL of the bucket.

      • location — (map)

        An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • name — (String)

        The name of the bucket.

      • supportCode — (String)

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

      • tags — (Array<map>)

        The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer 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: + - = . _ : / @

      • objectVersioning — (String)

        Indicates whether object versioning is enabled for the bucket.

        The following options can be configured:

        • Enabled - Object versioning is enabled.

        • Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.

        • NeverEnabled - Object versioning has never been enabled.

      • ableToUpdateBundle — (Boolean)

        Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

        You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.

        Use the UpdateBucketBundle action to change a bucket's bundle.

      • readonlyAccessAccounts — (Array<String>)

        An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

      • resourcesReceivingAccess — (Array<map>)

        An array of objects that describe Lightsail instances that have access to the bucket.

        Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

        • name — (String)

          The name of the Lightsail instance.

        • resourceType — (String)

          The Lightsail resource type (for example, Instance).

      • state — (map)

        An object that describes the state of the bucket.

        • code — (String)

          The state code of the bucket.

          The following codes are possible:

          • OK - The bucket is in a running state.

          • Unknown - Creation of the bucket might have timed-out. You might want to delete the bucket and create a new one.

        • message — (String)

          A message that describes the state of the bucket.

      • accessLogConfig — (map)

        An object that describes the access log configuration for the bucket.

        • enabled — required — (Boolean)

          A Boolean value that indicates whether bucket access logging is enabled for the bucket.

        • destination — (String)

          The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.

          Note: This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.
        • prefix — (String)

          The optional object prefix for the bucket access log.

          The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a logs/ prefix, then each log object will begin with the logs/ prefix in its key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).

          Note: This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.
    • operations — (Array<map>)

      An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

      • id — (String)

        The ID of the operation.

      • resourceName — (String)

        The resource name.

      • resourceType — (String)

        The resource type.

        Possible values include:
        • "ContainerService"
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
        • "Distribution"
        • "Certificate"
        • "Bucket"
      • createdAt — (Date)

        The timestamp when the operation was initialized (1479816991.349).

      • location — (map)

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • isTerminal — (Boolean)

        A Boolean value indicating whether the operation is terminal.

      • operationDetails — (String)

        Details about the operation (Debian-1GB-Ohio-1).

      • operationType — (String)

        The type of operation.

        Possible values include:
        • "DeleteKnownHostKeys"
        • "DeleteInstance"
        • "CreateInstance"
        • "StopInstance"
        • "StartInstance"
        • "RebootInstance"
        • "OpenInstancePublicPorts"
        • "PutInstancePublicPorts"
        • "CloseInstancePublicPorts"
        • "AllocateStaticIp"
        • "ReleaseStaticIp"
        • "AttachStaticIp"
        • "DetachStaticIp"
        • "UpdateDomainEntry"
        • "DeleteDomainEntry"
        • "CreateDomain"
        • "DeleteDomain"
        • "CreateInstanceSnapshot"
        • "DeleteInstanceSnapshot"
        • "CreateInstancesFromSnapshot"
        • "CreateLoadBalancer"
        • "DeleteLoadBalancer"
        • "AttachInstancesToLoadBalancer"
        • "DetachInstancesFromLoadBalancer"
        • "UpdateLoadBalancerAttribute"
        • "CreateLoadBalancerTlsCertificate"
        • "DeleteLoadBalancerTlsCertificate"
        • "AttachLoadBalancerTlsCertificate"
        • "CreateDisk"
        • "DeleteDisk"
        • "AttachDisk"
        • "DetachDisk"
        • "CreateDiskSnapshot"
        • "DeleteDiskSnapshot"
        • "CreateDiskFromSnapshot"
        • "CreateRelationalDatabase"
        • "UpdateRelationalDatabase"
        • "DeleteRelationalDatabase"
        • "CreateRelationalDatabaseFromSnapshot"
        • "CreateRelationalDatabaseSnapshot"
        • "DeleteRelationalDatabaseSnapshot"
        • "UpdateRelationalDatabaseParameters"
        • "StartRelationalDatabase"
        • "RebootRelationalDatabase"
        • "StopRelationalDatabase"
        • "EnableAddOn"
        • "DisableAddOn"
        • "PutAlarm"
        • "GetAlarms"
        • "DeleteAlarm"
        • "TestAlarm"
        • "CreateContactMethod"
        • "GetContactMethods"
        • "SendContactMethodVerification"
        • "DeleteContactMethod"
        • "CreateDistribution"
        • "UpdateDistribution"
        • "DeleteDistribution"
        • "ResetDistributionCache"
        • "AttachCertificateToDistribution"
        • "DetachCertificateFromDistribution"
        • "UpdateDistributionBundle"
        • "SetIpAddressType"
        • "CreateCertificate"
        • "DeleteCertificate"
        • "CreateContainerService"
        • "UpdateContainerService"
        • "DeleteContainerService"
        • "CreateContainerServiceDeployment"
        • "CreateContainerServiceRegistryLogin"
        • "RegisterContainerImage"
        • "DeleteContainerImage"
        • "CreateBucket"
        • "DeleteBucket"
        • "CreateBucketAccessKey"
        • "DeleteBucketAccessKey"
        • "UpdateBucketBundle"
        • "UpdateBucket"
        • "SetResourceAccessForBucket"
        • "UpdateInstanceMetadataOptions"
        • "StartGUISession"
        • "StopGUISession"
        • "SetupInstanceHttps"
      • status — (String)

        The status of the operation.

        Possible values include:
        • "NotStarted"
        • "Started"
        • "Failed"
        • "Completed"
        • "Succeeded"
      • statusChangedAt — (Date)

        The timestamp when the status was changed (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.

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

    The name of the bucket that the new access key will belong to, and grant access 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:

    • accessKey — (map)

      An object that describes the access key that is created.

      • accessKeyId — (String)

        The ID of the access key.

      • secretAccessKey — (String)

        The secret access key used to sign requests.

        You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

      • status — (String)

        The status of the access key.

        A status of Active means that the key is valid, while Inactive means it is not.

        Possible values include:
        • "Active"
        • "Inactive"
      • createdAt — (Date)

        The timestamp when the access key was created.

      • lastUsed — (map)

        An object that describes the last time the access key was used.

        Note: This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.
        • lastUsedDate — (Date)

          The date and time when the access key was most recently used.

          This value is null if the access key has not been used.

        • region — (String)

          The Amazon Web Services Region where this access key was most recently used.

          This value is N/A if the access key has not been used.

        • serviceName — (String)

          The name of the Amazon Web Services service with which this access key was most recently used.

          This value is N/A if the access key has not been used.

    • operations — (Array<map>)

      An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

      • id — (String)

        The ID of the operation.

      • resourceName — (String)

        The resource name.

      • resourceType — (String)

        The resource type.

        Possible values include:
        • "ContainerService"
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
        • "Distribution"
        • "Certificate"
        • "Bucket"
      • createdAt — (Date)

        The timestamp when the operation was initialized (1479816991.349).

      • location — (map)

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • isTerminal — (Boolean)

        A Boolean value indicating whether the operation is terminal.

      • operationDetails — (String)

        Details about the operation (Debian-1GB-Ohio-1).

      • operationType — (String)

        The type of operation.

        Possible values include:
        • "DeleteKnownHostKeys"
        • "DeleteInstance"
        • "CreateInstance"
        • "StopInstance"
        • "StartInstance"
        • "RebootInstance"
        • "OpenInstancePublicPorts"
        • "PutInstancePublicPorts"
        • "CloseInstancePublicPorts"
        • "AllocateStaticIp"
        • "ReleaseStaticIp"
        • "AttachStaticIp"
        • "DetachStaticIp"
        • "UpdateDomainEntry"
        • "DeleteDomainEntry"
        • "CreateDomain"
        • "DeleteDomain"
        • "CreateInstanceSnapshot"
        • "DeleteInstanceSnapshot"
        • "CreateInstancesFromSnapshot"
        • "CreateLoadBalancer"
        • "DeleteLoadBalancer"
        • "AttachInstancesToLoadBalancer"
        • "DetachInstancesFromLoadBalancer"
        • "UpdateLoadBalancerAttribute"
        • "CreateLoadBalancerTlsCertificate"
        • "DeleteLoadBalancerTlsCertificate"
        • "AttachLoadBalancerTlsCertificate"
        • "CreateDisk"
        • "DeleteDisk"
        • "AttachDisk"
        • "DetachDisk"
        • "CreateDiskSnapshot"
        • "DeleteDiskSnapshot"
        • "CreateDiskFromSnapshot"
        • "CreateRelationalDatabase"
        • "UpdateRelationalDatabase"
        • "DeleteRelationalDatabase"
        • "CreateRelationalDatabaseFromSnapshot"
        • "CreateRelationalDatabaseSnapshot"
        • "DeleteRelationalDatabaseSnapshot"
        • "UpdateRelationalDatabaseParameters"
        • "StartRelationalDatabase"
        • "RebootRelationalDatabase"
        • "StopRelationalDatabase"
        • "EnableAddOn"
        • "DisableAddOn"
        • "PutAlarm"
        • "GetAlarms"
        • "DeleteAlarm"
        • "TestAlarm"
        • "CreateContactMethod"
        • "GetContactMethods"
        • "SendContactMethodVerification"
        • "DeleteContactMethod"
        • "CreateDistribution"
        • "UpdateDistribution"
        • "DeleteDistribution"
        • "ResetDistributionCache"
        • "AttachCertificateToDistribution"
        • "DetachCertificateFromDistribution"
        • "UpdateDistributionBundle"
        • "SetIpAddressType"
        • "CreateCertificate"
        • "DeleteCertificate"
        • "CreateContainerService"
        • "UpdateContainerService"
        • "DeleteContainerService"
        • "CreateContainerServiceDeployment"
        • "CreateContainerServiceRegistryLogin"
        • "RegisterContainerImage"
        • "DeleteContainerImage"
        • "CreateBucket"
        • "DeleteBucket"
        • "CreateBucketAccessKey"
        • "DeleteBucketAccessKey"
        • "UpdateBucketBundle"
        • "UpdateBucket"
        • "SetResourceAccessForBucket"
        • "UpdateInstanceMetadataOptions"
        • "StartGUISession"
        • "StopGUISession"
        • "SetupInstanceHttps"
      • status — (String)

        The status of the operation.

        Possible values include:
        • "NotStarted"
        • "Started"
        • "Failed"
        • "Completed"
        • "Succeeded"
      • statusChangedAt — (Date)

        The timestamp when the status was changed (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.

var params = {
  certificateName: 'STRING_VALUE', /* required */
  domainName: 'STRING_VALUE', /* required */
  subjectAlternativeNames: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
lightsail.createCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • certificateName — (String)

    The name for the certificate.

  • domainName — (String)

    The domain name (example.com) for the certificate.

  • subjectAlternativeNames — (Array<String>)

    An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) for the certificate.

    You can specify a maximum of nine alternate domains (in addition to the primary domain name).

    Wildcard domain entries (*.example.com) are not supported.

  • tags — (Array<map>)

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

    Use the TagResource action to tag a resource after it's created.

    • key — (String)

      The key of the tag.

      Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

    • value — (String)

      The value of the tag.

      Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • certificate — (map)

      An object that describes the certificate created.

      • certificateArn — (String)

        The Amazon Resource Name (ARN) of the certificate.

      • certificateName — (String)

        The name of the certificate.

      • domainName — (String)

        The domain name of the certificate.

      • certificateDetail — (map)

        An object that describes a certificate in detail.

        • arn — (String)

          The Amazon Resource Name (ARN) of the certificate.

        • name — (String)

          The name of the certificate (my-certificate).

        • domainName — (String)

          The domain name of the certificate.

        • status — (String)

          The validation status of the certificate.

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

          The serial number of the certificate.

        • subjectAlternativeNames — (Array<String>)

          An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) of the certificate.

        • domainValidationRecords — (Array<map>)

          An array of objects that describe the domain validation records of the certificate.

          • domainName — (String)

            The domain name of the certificate validation record. For example, example.com or www.example.com.

          • resourceRecord — (map)

            An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.

            • name — (String)

              The name of the record.

            • type — (String)

              The DNS record type.

            • value — (String)

              The value for the DNS record.

          • dnsRecordCreationState — (map)

            An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.

            • code — (String)

              The status code for the automated DNS record creation.

              Following are the possible values:

              • SUCCEEDED - The validation records were successfully added to the domain.

              • STARTED - The automatic DNS record creation has started.

              • FAILED - The validation records failed to be added to the domain.

              Possible values include:
              • "SUCCEEDED"
              • "STARTED"
              • "FAILED"
            • message — (String)

              The message that describes the reason for the status code.

          • validationStatus — (String)

            The validation status of the record.

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

          The validation failure reason, if any, of the certificate.

          The following failure reasons are possible:

          • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

          • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the Amazon Web Services Support Center to contact Amazon Web Services Support.

            Note: You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

          • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

            If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

            If you see this error and your domain is not included in the VirusTotal list, visit the Amazon Web Services Support Center and create a case.

          • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

          • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

        • inUseResourceCount — (Integer)

          The number of Lightsail resources that the certificate is attached to.

        • keyAlgorithm — (String)

          The algorithm used to generate the key pair (the public and private key) of the certificate.

        • createdAt — (Date)

          The timestamp when the certificate was created.

        • issuedAt — (Date)

          The timestamp when the certificate was issued.

        • issuerCA — (String)

          The certificate authority that issued the certificate.

        • notBefore — (Date)

          The timestamp when the certificate is first valid.

        • notAfter — (Date)

          The timestamp when the certificate expires.

        • eligibleToRenew — (String)

          The renewal eligibility of the certificate.

        • renewalSummary — (map)

          An object that describes the status of the certificate renewal managed by Lightsail.

          • domainValidationRecords — (Array<map>)

            An array of objects that describe the domain validation records of the certificate.

            • domainName — (String)

              The domain name of the certificate validation record. For example, example.com or www.example.com.

            • resourceRecord — (map)

              An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.

              • name — (String)

                The name of the record.

              • type — (String)

                The DNS record type.

              • value — (String)

                The value for the DNS record.

            • dnsRecordCreationState — (map)

              An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.

              • code — (String)

                The status code for the automated DNS record creation.

                Following are the possible values:

                • SUCCEEDED - The validation records were successfully added to the domain.

                • STARTED - The automatic DNS record creation has started.

                • FAILED - The validation records failed to be added to the domain.

                Possible values include:
                • "SUCCEEDED"
                • "STARTED"
                • "FAILED"
              • message — (String)

                The message that describes the reason for the status code.

            • validationStatus — (String)

              The validation status of the record.

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

            The renewal status of the certificate.

            The following renewal status are possible:

            • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.

            • PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.

            • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

            • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

            Possible values include:
            • "PendingAutoRenewal"
            • "PendingValidation"
            • "Success"
            • "Failed"
          • renewalStatusReason — (String)

            The reason for the renewal status of the certificate.

          • updatedAt — (Date)

            The timestamp when the certificate was last updated.

        • revokedAt — (Date)

          The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

        • revocationReason — (String)

          The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

        • tags — (Array<map>)

          The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

          • key — (String)

            The key of the tag.

            Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

          • value — (String)

            The value of the tag.

            Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

        • supportCode — (String)

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

      • tags — (Array<map>)

        The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

        • key — (String)

          The key of the tag.

          Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

        • value — (String)

          The value of the tag.

          Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

    • operations — (Array<map>)

      An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

      • id — (String)

        The ID of the operation.

      • resourceName — (String)

        The resource name.

      • resourceType — (String)

        The resource type.

        Possible values include:
        • "ContainerService"
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
        • "Distribution"
        • "Certificate"
        • "Bucket"
      • createdAt — (Date)

        The timestamp when the operation was initialized (1479816991.349).

      • location — (map)

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • isTerminal — (Boolean)

        A Boolean value indicating whether the operation is terminal.

      • operationDetails — (String)

        Details about the operation (Debian-1GB-Ohio-1).

      • operationType — (String)

        The type of operation.

        Possible values include:
        • "DeleteKnownHostKeys"
        • "DeleteInstance"
        • "CreateInstance"
        • "StopInstance"
        • "StartInstance"
        • "RebootInstance"
        • "OpenInstancePublicPorts"
        • "PutInstancePublicPorts"
        • "CloseInstancePublicPorts"
        • "AllocateStaticIp"
        • "ReleaseStaticIp"
        • "AttachStaticIp"
        • "DetachStaticIp"
        • "UpdateDomainEntry"
        • "DeleteDomainEntry"
        • "CreateDomain"
        • "DeleteDomain"
        • "CreateInstanceSnapshot"
        • "DeleteInstanceSnapshot"
        • "CreateInstancesFromSnapshot"
        • "CreateLoadBalancer"
        • "DeleteLoadBalancer"
        • "AttachInstancesToLoadBalancer"
        • "DetachInstancesFromLoadBalancer"
        • "UpdateLoadBalancerAttribute"
        • "CreateLoadBalancerTlsCertificate"
        • "DeleteLoadBalancerTlsCertificate"
        • "AttachLoadBalancerTlsCertificate"
        • "CreateDisk"
        • "DeleteDisk"
        • "AttachDisk"
        • "DetachDisk"
        • "CreateDiskSnapshot"
        • "DeleteDiskSnapshot"
        • "CreateDiskFromSnapshot"
        • "CreateRelationalDatabase"
        • "UpdateRelationalDatabase"
        • "DeleteRelationalDatabase"
        • "CreateRelationalDatabaseFromSnapshot"
        • "CreateRelationalDatabaseSnapshot"
        • "DeleteRelationalDatabaseSnapshot"
        • "UpdateRelationalDatabaseParameters"
        • "StartRelationalDatabase"
        • "RebootRelationalDatabase"
        • "StopRelationalDatabase"
        • "EnableAddOn"
        • "DisableAddOn"
        • "PutAlarm"
        • "GetAlarms"
        • "DeleteAlarm"
        • "TestAlarm"
        • "CreateContactMethod"
        • "GetContactMethods"
        • "SendContactMethodVerification"
        • "DeleteContactMethod"
        • "CreateDistribution"
        • "UpdateDistribution"
        • "DeleteDistribution"
        • "ResetDistributionCache"
        • "AttachCertificateToDistribution"
        • "DetachCertificateFromDistribution"
        • "UpdateDistributionBundle"
        • "SetIpAddressType"
        • "CreateCertificate"
        • "DeleteCertificate"
        • "CreateContainerService"
        • "UpdateContainerService"
        • "DeleteContainerService"
        • "CreateContainerServiceDeployment"
        • "CreateContainerServiceRegistryLogin"
        • "RegisterContainerImage"
        • "DeleteContainerImage"
        • "CreateBucket"
        • "DeleteBucket"
        • "CreateBucketAccessKey"
        • "DeleteBucketAccessKey"
        • "UpdateBucketBundle"
        • "UpdateBucket"
        • "SetResourceAccessForBucket"
        • "UpdateInstanceMetadataOptions"
        • "StartGUISession"
        • "StopGUISession"
        • "SetupInstanceHttps"
      • status — (String)

        The status of the operation.

        Possible values include:
        • "NotStarted"
        • "Started"
        • "Failed"
        • "Completed"
        • "Succeeded"
      • statusChangedAt — (Date)

        The timestamp when the status was changed (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.

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 (t2.micro) to use for the new Amazon EC2 instance.

    • portInfoSource — required — (String)

      The port configuration to use for the new Amazon EC2 instance.

      The following configuration options are available:

      • DEFAULT - Use the default firewall settings from the Lightsail instance blueprint. If this is specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2.

      • INSTANCE - Use the configured firewall settings from the source Lightsail instance. If this is specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

      • NONE - Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

      • CLOSED - All ports closed. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

      Note: If you 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:
        • "ContainerService"
        • "Instance"
        • "StaticIp"
        • "KeyPair"
        • "InstanceSnapshot"
        • "Domain"
        • "PeeredVpc"
        • "LoadBalancer"
        • "LoadBalancerTlsCertificate"
        • "Disk"
        • "DiskSnapshot"
        • "RelationalDatabase"
        • "RelationalDatabaseSnapshot"
        • "ExportSnapshotRecord"
        • "CloudFormationStackRecord"
        • "Alarm"
        • "ContactMethod"
        • "Distribution"
        • "Certificate"
        • "Bucket"
      • createdAt — (Date)

        The timestamp when the operation was initialized (1479816991.349).

      • location — (map)

        The Amazon Web Services Region and Availability Zone.

        • availabilityZone — (String)

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

        • regionName — (String)

          The Amazon Web Services 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"
          • "eu-north-1"
      • isTerminal — (Boolean)

        A Boolean value indicating whether the operation is terminal.

      • operationDetails — (String)

        Details about the operation (Debian-1GB-Ohio-1).

      • operationType — (String)

        The type of operation.

        Possible values include:
        • "DeleteKnownHostKeys"
        • "DeleteInstance"
        • "CreateInstance"
        • "StopInstance"
        • "StartInstance"
        • "RebootInstance"
        • "OpenInstancePublicPorts"
        • "PutInstancePublicPorts"
        • "CloseInstancePublicPorts"
        • "AllocateStaticIp"
        • "ReleaseStaticIp"
        • "AttachStaticIp"
        • "DetachStaticIp"
        • "UpdateDomainEntry"
        • "DeleteDomainEntry"
        • "CreateDomain"
        • "DeleteDomain"
        • "CreateInstanceSnapshot"
        • "DeleteInstanceSnapshot"
        • "CreateInstancesFromSnapshot"
        • "CreateLoadBalancer"
        • "DeleteLoadBalancer"
        • "AttachInstancesToLoadBalancer"
        • "DetachInstancesFromLoadBalancer"
        • "UpdateLoadBalancerAttribute"
        • "CreateLoadBalancerTlsCertificate"
        • "DeleteLoadBalancerTlsCertificate"
        • "AttachLoadBalancerTlsCertificate"
        • "CreateDisk"
        • "DeleteDisk"
        • "AttachDisk"
        • "DetachDisk"
        • "CreateDiskSnapshot"
        • "DeleteDiskSnapshot"
        • "CreateDiskFromSnapshot"
        • "CreateRelationalDatabase"
        • "UpdateRelationalDatabase"
        • "DeleteRelationalDatabase"
        • "CreateRelationalDatabaseFromSnapshot"
        • "CreateRelationalDatabaseSnapshot"
        • "DeleteRelationalDatabaseSnapshot"
        • "UpdateRelationalDatabaseParameters"
        • "StartRelationalDatabase"
        • "RebootRelationalDatabase"
        • "StopRelationalDatabase"
        • "EnableAddOn"
        • "DisableAddOn"
        • "PutAlarm"
        • "GetAlarms"
        • "DeleteAlarm"
        • "TestAlarm"
        • "CreateContactMethod"
        • "GetContactMethods"
        • "SendContactMethodVerification"
        • "DeleteContactMethod"
        • "CreateDistribution"
        • "UpdateDistribution"
        • "DeleteDistribution"
        • "ResetDistributionCache"
        • "AttachCertificateToDistribution"
        • "DetachCertificateFromDistribution"
        • "UpdateDistributionBundle"
        • "SetIpAddressType"
        • "CreateCertificate"
        • "DeleteCertificate"
        • "CreateContainerService"
        • "UpdateContainerService"
        • "DeleteContainerService"
        • "CreateContainerServiceDeployment"
        • "CreateContainerServiceRegistryLogin"
        • "RegisterContainerImage"
        • "DeleteContainerImage"
        • "CreateBucket"
        • "DeleteBucket"
        • "CreateBucketAccessKey"
        • "DeleteBucketAccessKey"
        • "UpdateBucketBundle"
        • "UpdateBucket"
        • "SetResourceAccessForBucket"
        • "UpdateInstanceMetadataOptions"
        • "StartGUISession"
        • "StopGUISession"
        • "SetupInstanceHttps"
      • status — (String)

        The status of the operation.

        Possible values include:
        • "NotStarted"
        • "Started"
        • "Failed"
        • "Completed"
        • "Succeeded"
      • statusChangedAt — (Date)

        The timestamp when the status was changed (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.