String name
The name of the add-on.
String status
The status of the add-on.
String snapshotTimeOfDay
The daily time when an automatic snapshot is created.
The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
The snapshot is automatically created between the time shown and up to 45 minutes after.
String nextSnapshotTimeOfDay
The next daily time an automatic snapshot will be created.
The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
The snapshot is automatically created between the time shown and up to 45 minutes after.
String addOnType
The add-on type.
AutoSnapshotAddOnRequest autoSnapshotAddOnRequest
An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
String name
The name of the alarm.
String arn
The Amazon Resource Name (ARN) of the alarm.
Date createdAt
The timestamp when the alarm was created.
ResourceLocation location
An object that lists information about the location of the alarm.
String resourceType
The Lightsail resource type (e.g., Alarm).
String supportCode
The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
MonitoredResourceInfo monitoredResourceInfo
An object that lists information about the resource monitored by the alarm.
String comparisonOperator
The arithmetic operation used when comparing the specified statistic and threshold.
Integer evaluationPeriods
The number of periods over which data is compared to the specified threshold.
Integer period
The period, in seconds, over which the statistic is applied.
Double threshold
The value against which the specified statistic is compared.
Integer datapointsToAlarm
The number of data points that must not within the specified threshold to trigger the alarm.
String treatMissingData
Specifies how the alarm handles missing data points.
An alarm can treat missing data in the following ways:
breaching - Assume the missing data is not within the threshold. Missing data counts towards the
number of times the metric is not within the threshold.
notBreaching - Assume the missing data is within the threshold. Missing data does not count towards
the number of times the metric is not within the threshold.
ignore - Ignore the missing data. Maintains the current alarm state.
missing - Missing data is treated as missing.
String statistic
The statistic for the metric associated with the alarm.
The following statistics are available:
Minimum - The lowest value observed during the specified period. Use this value to determine low
volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high
volumes of activity for your application.
Sum - All values submitted for the matching metric added together. You can use this statistic to
determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic
with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use
is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your
resources.
SampleCount - The count, or number, of data points used for the statistical calculation.
String metricName
The name of the metric associated with the alarm.
String state
The current state of the alarm.
An alarm has the following possible states:
ALARM - The metric is outside of the defined threshold.
INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is
available for the metric to determine the alarm state.
OK - The metric is within the defined threshold.
String unit
The unit of the metric associated with the alarm.
List<E> contactProtocols
The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
List<E> notificationTriggers
The alarm states that trigger a notification.
Boolean notificationEnabled
Indicates whether the alarm is enabled.
String staticIpName
The name of the static IP address.
String loadBalancerName
The name of the load balancer.
List<E> instanceNames
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).
List<E> operations
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.
String snapshotTimeOfDay
The daily time when an automatic snapshot will be created.
Constraints:
Must be in HH:00 format, and in an hourly increment.
Specified in Coordinated Universal Time (UTC).
The snapshot will be automatically created between the time specified and up to 45 minutes after.
String date
The date of the automatic snapshot in YYYY-MM-DD format.
Date createdAt
The timestamp when the automatic snapshot was created.
String status
The status of the automatic snapshot.
List<E> fromAttachedDisks
An array of objects that describe the block storage disks attached to the instance when the automatic snapshot was created.
String blueprintId
The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
String name
The friendly name of the blueprint (e.g., Amazon Linux).
String group
The group name of the blueprint (e.g., amazon-linux).
String type
The type of the blueprint (e.g., os or app).
String description
The description of the blueprint.
Boolean isActive
A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
Integer minPower
The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500
or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates
that the blueprint runs on all instance sizes.
String version
The version number of the operating system, application, or stack (e.g., 2016.03.0).
String versionCode
The version code.
String productUrl
The product URL to learn more about the image or blueprint.
String licenseUrl
The end-user license agreement URL for the image or blueprint.
String platform
The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
Float price
The price in US dollars (e.g., 5.0) of the bundle.
Integer cpuCount
The number of vCPUs included in the bundle (e.g., 2).
Integer diskSizeInGb
The size of the SSD (e.g., 30).
String bundleId
The bundle ID (e.g., micro_1_0).
String instanceType
The Amazon EC2 instance type (e.g., t2.micro).
Boolean isActive
A Boolean value indicating whether the bundle is active.
String name
A friendly name for the bundle (e.g., Micro).
Integer power
A numeric value that represents the power of the bundle (e.g., 500). You can use the bundle's power
value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the
bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a
blueprint with a minimum power value of 500.
Float ramSizeInGb
The amount of RAM in GB (e.g., 2.0).
Integer transferPerMonthInGb
The data transfer rate per month in GB (e.g., 2000).
List<E> supportedPlatforms
The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only
launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform.
LINUX_UNIX blueprints require a LINUX_UNIX bundle.
Operation operation
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.
String name
The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a
GUID.
String arn
The Amazon Resource Name (ARN) of the CloudFormation stack record.
Date createdAt
The date when the CloudFormation stack record was created.
ResourceLocation location
A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record.
String resourceType
The Lightsail resource type (e.g., CloudFormationStackRecord).
String state
The current state of the CloudFormation stack record.
List<E> sourceInfo
A list of objects describing the source of the CloudFormation stack record.
DestinationInfo destinationInfo
A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.
String contactEndpoint
The destination of the contact method, such as an email address or a mobile phone number.
String status
The current status of the contact method.
A contact method has the following possible status:
PendingVerification - The contact method has not yet been verified, and the verification has not yet
expired.
Valid - The contact method has been verified.
InValid - An attempt was made to verify the contact method, but the verification has expired.
String protocol
The protocol of the contact method, such as email or SMS (text messaging).
String name
The name of the contact method.
String arn
The Amazon Resource Name (ARN) of the contact method.
Date createdAt
The timestamp when the contact method was created.
ResourceLocation location
String resourceType
The Lightsail resource type (e.g., ContactMethod).
String supportCode
The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.
String sourceSnapshotName
The name of the source manual snapshot to copy.
Constraint:
Define this parameter only when copying a manual snapshot as another manual snapshot.
String sourceResourceName
The name of the source instance or disk from which the source automatic snapshot was created.
Constraint:
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.
String restoreDate
The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify
the dates of the available automatic snapshots.
Constraints:
Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter.
The restore date and use latest restorable auto snapshot parameters are mutually
exclusive.
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.
Boolean useLatestRestorableAutoSnapshot
A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.
Constraints:
This parameter cannot be defined together with the restore date parameter. The
use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.
String targetSnapshotName
The name of the new manual snapshot to be created as a copy.
String sourceRegion
The AWS Region where the source manual or automatic snapshot is located.
String protocol
The protocol of the contact method, such as Email or SMS (text messaging).
The SMS protocol is supported only in the following AWS Regions.
US East (N. Virginia) (us-east-1)
US West (Oregon) (us-west-2)
Europe (Ireland) (eu-west-1)
Asia Pacific (Tokyo) (ap-northeast-1)
Asia Pacific (Singapore) (ap-southeast-1)
Asia Pacific (Sydney) (ap-southeast-2)
For a list of countries/regions where SMS text messages can be sent, and the latest AWS Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.
For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.
String contactEndpoint
The destination of the contact method, such as an email address or a mobile phone number.
Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia.
String diskName
The unique Lightsail disk name (e.g., my-disk).
String diskSnapshotName
The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk.
Constraint:
This parameter cannot be defined together with the source disk name parameter. The
disk snapshot name and source disk name parameters are mutually exclusive.
String availabilityZone
The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same
Availability Zone as the Lightsail instance where you want to create the disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
Integer sizeInGb
The size of the disk in GB (e.g., 32).
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
List<E> addOns
An array of objects that represent the add-ons to enable for the new disk.
String sourceDiskName
The name of the source disk from which the source automatic snapshot was created.
Constraints:
This parameter cannot be defined together with the disk snapshot name parameter. The
source disk name and disk snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.
String restoreDate
The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to
identify the dates of the available automatic snapshots.
Constraints:
Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter.
The restore date and use latest restorable auto snapshot parameters are mutually
exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.
Boolean useLatestRestorableAutoSnapshot
A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
This parameter cannot be defined together with the restore date parameter. The
use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.
String diskName
The unique Lightsail disk name (e.g., my-disk).
String availabilityZone
The Availability Zone where you want to create the disk (e.g., us-east-2a). Use the same
Availability Zone as the Lightsail instance to which you want to attach the disk.
Use the get regions operation to list the Availability Zones where Lightsail is currently available.
Integer sizeInGb
The size of the disk in GB (e.g., 32).
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
List<E> addOns
An array of objects that represent the add-ons to enable for the new disk.
String diskName
The unique name of the source disk (e.g., Disk-Virginia-1).
This parameter cannot be defined together with the instance name parameter. The
disk name and instance name parameters are mutually exclusive.
String diskSnapshotName
The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk.
String instanceName
The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined,
a snapshot of the instance's system volume is created.
This parameter cannot be defined together with the disk name parameter. The
instance name and disk name parameters are mutually exclusive.
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
String domainName
The domain name (e.g., example.com) for which you want to create the domain entry.
DomainEntry domainEntry
An array of key-value pairs containing information about the domain entry request.
Operation operation
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.
String domainName
The domain name to manage (e.g., example.com).
You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
Operation operation
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.
List<E> instanceNames
The names for your new instances.
Map<K,V> attachedDiskMapping
An object containing information about one or more disk mappings.
String availabilityZone
The Availability Zone where you want to create your instances. Use the following formatting:
us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions
operation. Be sure to add the include Availability Zones parameter to your request.
String instanceSnapshotName
The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.
Constraint:
This parameter cannot be defined together with the source instance name parameter. The
instance snapshot name and source instance name parameters are mutually exclusive.
String bundleId
The bundle of specification information for your virtual private server (or instance), including the
pricing plan (e.g., micro_1_0).
String userData
You can create a launch script that configures a server with additional user data. For example,
apt-get -y update.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and
CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a
complete list, see the Dev Guide.
String keyPairName
The name for your key pair.
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
List<E> addOns
An array of objects representing the add-ons to enable for the new instance.
String sourceInstanceName
The name of the source instance from which the source automatic snapshot was created.
Constraints:
This parameter cannot be defined together with the instance snapshot name parameter. The
source instance name and instance snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
String restoreDate
The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation
to identify the dates of the available automatic snapshots.
Constraints:
Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter.
The restore date and use latest restorable auto snapshot parameters are mutually
exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
Boolean useLatestRestorableAutoSnapshot
A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
This parameter cannot be defined together with the restore date parameter. The
use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
String instanceSnapshotName
The name for your new snapshot.
String instanceName
The Lightsail instance on which to base your snapshot.
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
List<E> instanceNames
The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for
example: ["MyFirstInstance","MySecondInstance"]
String availabilityZone
The Availability Zone in which to create your instance. Use the following format: us-east-2a (case
sensitive). You can get a list of Availability Zones by using the get regions
operation. Be sure to add the include Availability Zones parameter to your request.
String customImageName
(Deprecated) The name for your custom image.
In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.
String blueprintId
The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
Use the get blueprints operation to return a list of available images (or blueprints).
Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
String bundleId
The bundle of specification information for your virtual private server (or instance), including the
pricing plan (e.g., micro_1_0).
String userData
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.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and
CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a
complete list, see the Dev Guide.
String keyPairName
The name of your key pair.
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
List<E> addOns
An array of objects representing the add-ons to enable for the new instance.
KeyPair keyPair
An array of key-value pairs containing information about the new key pair you just created.
String publicKeyBase64
A base64-encoded public key of the ssh-rsa type.
String privateKeyBase64
A base64-encoded RSA private key.
Operation operation
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.
String loadBalancerName
The name of your load balancer.
Integer instancePort
The instance port where you're creating your load balancer.
String healthCheckPath
The path you provided to perform the load balancer health check. If you didn't specify a health check path,
Lightsail uses the root path of your website (e.g., "/").
You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.
String certificateName
The name of the SSL/TLS certificate.
If you specify certificateName, then certificateDomainName is required (and
vice-versa).
String certificateDomainName
The domain name with which your certificate is associated (e.g., example.com).
If you specify certificateDomainName, then certificateName is required (and
vice-versa).
List<E> certificateAlternativeNames
The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g.,
www.example.com, example.com, m.example.com, blog.example.com
).
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
String loadBalancerName
The load balancer name where you want to create the SSL/TLS certificate.
String certificateName
The SSL/TLS certificate name.
You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.
String certificateDomainName
The domain name (e.g., example.com) for your SSL/TLS certificate.
List<E> certificateAlternativeNames
An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will
de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain).
We do not support wildcards (e.g., *.example.com).
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
String relationalDatabaseName
The name to use for your new database.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
String availabilityZone
The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive
format.
You can get a list of Availability Zones by using the get regions operation. Be sure to add the
include relational database Availability Zones parameter to your request.
Boolean publiclyAccessible
Specifies the accessibility options for your new database. A value of true specifies a database that
is available to resources outside of your Lightsail account. A value of false specifies a database
that is available only to your Lightsail resources in the same region as your database.
String relationalDatabaseSnapshotName
The name of the database snapshot from which to create your new database.
String relationalDatabaseBundleId
The bundle ID for your new database. A bundle describes the performance specifications for your database.
You can get a list of database bundle IDs by using the get relational database bundles operation.
When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.
String sourceRelationalDatabaseName
The name of the source database.
Date restoreTime
The date and time to restore your database from.
Constraints:
Must be before the latest restorable time for the database.
Cannot be specified if the use latest restorable time parameter is true.
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input
1538424000 as the restore time.
Boolean useLatestRestorableTime
Specifies whether your database is restored from the latest backup time. A value of true restores
from the latest backup time.
Default: false
Constraints: Cannot be specified if the restore time parameter is provided.
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
String relationalDatabaseName
The name to use for your new database.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
String availabilityZone
The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive
format.
You can get a list of Availability Zones by using the get regions operation. Be sure to add the
include relational database Availability Zones parameter to your request.
String relationalDatabaseBlueprintId
The blueprint ID for your new database. A blueprint describes the major engine version of a database.
You can get a list of database blueprints IDs by using the get relational database blueprints
operation.
String relationalDatabaseBundleId
The bundle ID for your new database. A bundle describes the performance specifications for your database.
You can get a list of database bundle IDs by using the get relational database bundles operation.
String masterDatabaseName
The name of the master database created when the Lightsail database resource is created.
Constraints:
Must contain from 1 to 64 alphanumeric characters.
Cannot be a word reserved by the specified database engine
String masterUsername
The master user name for your new database.
Constraints:
Master user name is required.
Must contain from 1 to 16 alphanumeric characters.
The first character must be a letter.
Cannot be a reserved word for the database engine you choose.
For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6 or MySQL 5.7 respectively.
String masterUserPassword
The password for the master user of your new database. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain 8 to 41 characters.
String preferredBackupWindow
The daily time range during which automated backups are created for your new database if automated backups are enabled.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.
Constraints:
Must be in the hh24:mi-hh24:mi format.
Example: 16:00-16:30
Specified in Coordinated Universal Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur on your new database.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints:
Must be in the ddd:hh24:mi-ddd:hh24:mi format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Coordinated Universal Time (UTC).
Example: Tue:17:00-Tue:17:30
Boolean publiclyAccessible
Specifies the accessibility options for your new database. A value of true specifies a database that
is available to resources outside of your Lightsail account. A value of false specifies a database
that is available only to your Lightsail resources in the same region as your database.
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
String relationalDatabaseName
The name of the database on which to base your new snapshot.
String relationalDatabaseSnapshotName
The name for your new database snapshot.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
List<E> tags
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource operation.
String alarmName
The name of the alarm to delete.
String protocol
The protocol that will be deleted, such as Email or SMS (text messaging).
To delete an Email and an SMS contact method if you added both, you must run separate
DeleteContactMethod actions to delete each protocol.
String diskSnapshotName
The name of the disk snapshot you want to delete (e.g., my-disk-snapshot).
String domainName
The name of the domain entry to delete.
DomainEntry domainEntry
An array of key-value pairs containing information about your domain entries.
Operation operation
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.
String domainName
The specific domain name to delete.
Operation operation
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.
String instanceSnapshotName
The name of the snapshot to delete.
String keyPairName
The name of the key pair to delete.
Operation operation
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.
String instanceName
The name of the instance for which you want to reset the host key or certificate.
String loadBalancerName
The name of the load balancer you want to delete.
String loadBalancerName
The load balancer name.
String certificateName
The SSL/TLS certificate name.
Boolean force
When true, forces the deletion of an SSL/TLS certificate.
There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The
force parameter is required when the primary SSL/TLS certificate is in use by an instance attached
to the load balancer.
String relationalDatabaseName
The name of the database that you are deleting.
Boolean skipFinalSnapshot
Determines whether a final database snapshot is created before your database is deleted. If true is
specified, no database snapshot is created. If false is specified, a database snapshot is created
before your database is deleted.
You must specify the final relational database snapshot name parameter if the
skip final snapshot parameter is false.
Default: false
String finalRelationalDatabaseSnapshotName
The name of the database snapshot created if skip final snapshot is false, which is the
default value for that parameter.
Specifying this parameter and also specifying the skip final snapshot parameter to true
results in an error.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
String relationalDatabaseSnapshotName
The name of the database snapshot that you are deleting.
String diskName
The unique name of the disk you want to detach from your instance (e.g., my-disk).
String staticIpName
The name of the static IP to detach from the instance.
String name
The unique name of the disk.
String arn
The Amazon Resource Name (ARN) of the disk.
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The date when the disk was created.
ResourceLocation location
The AWS Region and Availability Zone where the disk is located.
String resourceType
The Lightsail resource type (e.g., Disk).
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
List<E> addOns
An array of objects representing the add-ons enabled on the disk.
Integer sizeInGb
The size of the disk in GB.
Boolean isSystemDisk
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
Integer iops
The input/output operations per second (IOPS) of the disk.
String path
The disk path.
String state
Describes the status of the disk.
String attachedTo
The resources to which the disk is attached.
Boolean isAttached
A Boolean value indicating whether the disk is attached.
String attachmentState
(Deprecated) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned attached for system disks in the API
response. It is now deprecated, but still included in the response. Use isAttached instead.
Integer gbInUse
(Deprecated) The number of GB in use by the disk.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
String name
The name of the disk snapshot (e.g., my-disk-snapshot).
String arn
The Amazon Resource Name (ARN) of the disk snapshot.
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The date when the disk snapshot was created.
ResourceLocation location
The AWS Region and Availability Zone where the disk snapshot was created.
String resourceType
The Lightsail resource type (e.g., DiskSnapshot).
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
Integer sizeInGb
The size of the disk in GB.
String state
The status of the disk snapshot operation.
String progress
The progress of the disk snapshot operation.
String fromDiskName
The unique name of the source disk from which the disk snapshot was created.
String fromDiskArn
The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
String fromInstanceName
The unique name of the source instance from which the disk (system volume) snapshot was created.
String fromInstanceArn
The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
Boolean isFromAutoSnapshot
A Boolean value indicating whether the snapshot was created from an automatic snapshot.
Integer sizeInGb
The size of the disk in GB (e.g., 32).
String name
The name of the domain.
String arn
The Amazon Resource Name (ARN) of the domain recordset (e.g.,
arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The date when the domain recordset was created.
ResourceLocation location
The AWS Region and Availability Zones where the domain recordset was created.
String resourceType
The resource type.
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
List<E> domainEntries
An array of key-value pairs containing information about the domain entries.
String id
The ID of the domain recordset entry.
String name
The name of the domain.
String target
The target AWS name server (e.g., ns-111.awsdns-22.com.).
For Lightsail load balancers, the value looks like
ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure to also set
isAlias to true when setting up an A record for a load balancer.
Boolean isAlias
When true, specifies whether the domain entry is an alias used by the Lightsail load balancer. You
can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic
to your load balancer
String type
The type of domain entry, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The following domain entry types can be used:
A
CNAME
MX
NS
SOA
SRV
TXT
Map<K,V> options
(Deprecated) The options for the domain entry.
In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
String resourceName
The name of the source resource for which to enable or modify the add-on.
AddOnRequest addOnRequest
An array of strings representing the add-on to enable or modify.
String name
The export snapshot record name.
String arn
The Amazon Resource Name (ARN) of the export snapshot record.
Date createdAt
The date when the export snapshot record was created.
ResourceLocation location
The AWS Region and Availability Zone where the export snapshot record is located.
String resourceType
The Lightsail resource type (e.g., ExportSnapshotRecord).
String state
The state of the export snapshot record.
ExportSnapshotRecordSourceInfo sourceInfo
A list of objects describing the source of the export snapshot record.
DestinationInfo destinationInfo
A list of objects describing the destination of the export snapshot record.
String resourceType
The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot).
Date createdAt
The date when the source instance or disk snapshot was created.
String name
The name of the source instance or disk snapshot.
String arn
The Amazon Resource Name (ARN) of the source instance or disk snapshot.
String fromResourceName
The name of the snapshot's source instance or disk.
String fromResourceArn
The Amazon Resource Name (ARN) of the snapshot's source instance or disk.
InstanceSnapshotInfo instanceSnapshotInfo
A list of objects describing an instance snapshot.
DiskSnapshotInfo diskSnapshotInfo
A list of objects describing a disk snapshot.
String sourceSnapshotName
The name of the instance or disk snapshot to be exported to Amazon EC2.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetActiveNames request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> activeNames
The list of active names returned by the get active names request.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetActiveNames request and specify the next page
token using the pageToken parameter.
String alarmName
The name of the alarm.
Specify an alarm name to return information about a specific alarm.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetAlarms request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
String monitoredResourceName
The name of the Lightsail resource being monitored by the alarm.
Specify a monitored resource name to return information about all alarms for a specific resource.
List<E> alarms
An array of objects that describe the alarms.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetAlarms request and specify the next page token
using the pageToken parameter.
String resourceName
The name of the source instance or disk from which to get automatic snapshot information.
String resourceName
The name of the source instance or disk for the automatic snapshots.
String resourceType
The resource type (e.g., Instance or Disk).
List<E> autoSnapshots
An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.
Boolean includeInactive
A Boolean value indicating whether to include inactive results in your request.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetBlueprints request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> blueprints
An array of key-value pairs that contains information about the available blueprints.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetBlueprints request and specify the next page
token using the pageToken parameter.
Boolean includeInactive
A Boolean value that indicates whether to include inactive bundle results in your request.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetBundles request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> bundles
An array of key-value pairs that contains information about the available bundles.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetBundles request and specify the next page token
using the pageToken parameter.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetClouFormationStackRecords request. If your results are
paginated, the response will return a next page token that you can specify as the page token in a subsequent
request.
List<E> cloudFormationStackRecords
A list of objects describing the CloudFormation stack records.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetCloudFormationStackRecords request and specify
the next page token using the pageToken parameter.
String diskName
The name of the disk (e.g., my-disk).
Disk disk
An object containing information about the disk.
String diskSnapshotName
The name of the disk snapshot (e.g., my-disk-snapshot).
DiskSnapshot diskSnapshot
An object containing information about the disk snapshot.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetDiskSnapshots request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> diskSnapshots
An array of objects containing information about all block storage disk snapshots.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetDiskSnapshots request and specify the next page
token using the pageToken parameter.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetDisks request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> disks
An array of objects containing information about all block storage disks.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetDisks request and specify the next page token
using the pageToken parameter.
String domainName
The domain name for which your want to return information about.
Domain domain
An array of key-value pairs containing information about your get domain request.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetDomains request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> domains
An array of key-value pairs containing information about each of the domain entries in the user's account.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetDomains request and specify the next page token
using the pageToken parameter.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetExportSnapshotRecords request. If your results are
paginated, the response will return a next page token that you can specify as the page token in a subsequent
request.
List<E> exportSnapshotRecords
A list of objects describing the export snapshot records.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetExportSnapshotRecords request and specify the
next page token using the pageToken parameter.
InstanceAccessDetails accessDetails
An array of key-value pairs containing information about a get instance access request.
String instanceName
The name of the instance for which you want to get metrics data.
String metricName
The metric for which you want to return information.
Valid instance metric names are listed below, along with the most useful statistics to include in
your request, and the published unit value.
BurstCapacityPercentage - The percentage of CPU performance available for your instance to
burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops
accruing when your instance's BurstCapacityPercentage reaches 100%. For more information, see
Viewing instance burst capacity in Amazon Lightsail.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU
utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing
when your instance's BurstCapacityPercentage metric reaches 100%.
Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Seconds.
CPUUtilization - The percentage of allocated compute units that are currently in use on the
instance. This metric identifies the processing power to run the applications on the instance. Tools in your
operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor
core.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
NetworkIn - The number of bytes received on all network interfaces by the instance. This
metric identifies the volume of incoming network traffic to the instance. The number reported is the number of
bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported
number by 300 to find Bytes/second.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Bytes.
NetworkOut - The number of bytes sent out on all network interfaces by the instance. This
metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of
bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number
by 300 to find Bytes/second.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Bytes.
StatusCheckFailed - Reports whether the instance passed or failed both the instance status
check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is
available in 1-minute (60 seconds) granularity.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance
status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60
seconds) granularity.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
StatusCheckFailed_System - Reports whether the instance passed or failed the system status
check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)
granularity.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
Integer period
The granularity, in seconds, of the returned data points.
The StatusCheckFailed, StatusCheckFailed_Instance, and
StatusCheckFailed_System instance metric data is available in 1-minute (60 seconds) granularity. All
other instance metric data is available in 5-minute (300 seconds) granularity.
Date startTime
The start time of the time period.
Date endTime
The end time of the time period.
String unit
The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units
to specify with each available metric, see the metricName parameter.
List<E> statistics
The statistic for the metric.
The following statistics are available:
Minimum - The lowest value observed during the specified period. Use this value to determine low
volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high
volumes of activity for your application.
Sum - All values submitted for the matching metric added together. You can use this statistic to
determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic
with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use
is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your
resources.
SampleCount - The count, or number, of data points used for the statistical calculation.
String instanceName
The name of the instance for which to return firewall port states.
String instanceName
The name of the instance.
Instance instance
An array of key-value pairs containing information about the specified instance.
String instanceSnapshotName
The name of the snapshot for which you are requesting information.
InstanceSnapshot instanceSnapshot
An array of key-value pairs containing information about the results of your get instance snapshot request.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetInstanceSnapshots request. If your results are paginated,
the response will return a next page token that you can specify as the page token in a subsequent request.
List<E> instanceSnapshots
An array of key-value pairs containing information about the results of your get instance snapshots request.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetInstanceSnapshots request and specify the next
page token using the pageToken parameter.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetInstances request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> instances
An array of key-value pairs containing information about your instances.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetInstances request and specify the next page
token using the pageToken parameter.
String instanceName
The name of the instance to get state information about.
InstanceState state
The state of the instance.
String keyPairName
The name of the key pair for which you are requesting information.
KeyPair keyPair
An array of key-value pairs containing information about the key pair.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> keyPairs
An array of key-value pairs containing information about the key pairs.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetKeyPairs request and specify the next page token
using the pageToken parameter.
String loadBalancerName
The name of the load balancer.
String metricName
The metric for which you want to return information.
Valid load balancer metric names are listed below, along with the most useful statistics to include
in your request, and the published unit value.
ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that
did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible
causes include a mismatch of ciphers or protocols.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
HealthyHostCount - The number of target instances that are considered healthy.
Statistics: The most useful statistic are Average, Minimum, and
Maximum.
Unit: The published unit is Count.
HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target
instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum,
Maximum, and Average all return 1.
Unit: The published unit is Count.
HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target
instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum,
Maximum, and Average all return 1.
Unit: The published unit is Count.
HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target
instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum,
Maximum, and Average all return 1.
Unit: The published unit is Count.
HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target
instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum,
Maximum, and Average all return 1.
Unit: The published unit is Count.
HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the
load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not
received by the target instance. This count does not include response codes generated by the target instances.
Statistics: The most useful statistic is Sum. Note that Minimum,
Maximum, and Average all return 1.
Unit: The published unit is Count.
HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the
load balancer. This does not include any response codes generated by the target instance. This metric is reported
if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of
the instances (spillover) or the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum,
Maximum, and Average all return 1.
Unit: The published unit is Count.
InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load
balancer until a response from the target instance is received.
Statistics: The most useful statistic is Average.
Unit: The published unit is Seconds.
RejectedConnectionCount - The number of connections that were rejected because the load
balancer had reached its maximum number of connections.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
RequestCount - The number of requests processed over IPv4. This count includes only the
requests with a response generated by a target instance of the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum,
Maximum, and Average all return 1.
Unit: The published unit is Count.
UnhealthyHostCount - The number of target instances that are considered unhealthy.
Statistics: The most useful statistic are Average, Minimum, and
Maximum.
Unit: The published unit is Count.
Integer period
The granularity, in seconds, of the returned data points.
Date startTime
The start time of the period.
Date endTime
The end time of the period.
String unit
The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units
with each available metric, see the metricName parameter.
List<E> statistics
The statistic for the metric.
The following statistics are available:
Minimum - The lowest value observed during the specified period. Use this value to determine low
volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high
volumes of activity for your application.
Sum - All values submitted for the matching metric added together. You can use this statistic to
determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic
with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use
is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your
resources.
SampleCount - The count, or number, of data points used for the statistical calculation.
String loadBalancerName
The name of the load balancer.
LoadBalancer loadBalancer
An object containing information about your load balancer.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetLoadBalancers request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> loadBalancers
An array of LoadBalancer objects describing your load balancers.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetLoadBalancers request and specify the next page
token using the pageToken parameter.
String loadBalancerName
The name of the load balancer you associated with your SSL/TLS certificate.
String operationId
A GUID used to identify the operation.
Operation operation
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.
String resourceName
The name of the resource for which you are requesting information.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetOperationsForResource request. If your results are
paginated, the response will return a next page token that you can specify as the page token in a subsequent
request.
List<E> operations
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.
String nextPageCount
(Deprecated) Returns the number of pages of results that remain.
In releases prior to June 12, 2017, this parameter returned null by the API. It is now deprecated,
and the API returns the next page token parameter instead.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetOperationsForResource request and specify the
next page token using the pageToken parameter.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetOperations request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> operations
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.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetOperations request and specify the next page
token using the pageToken parameter.
Boolean includeAvailabilityZones
A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability
Zones are indicated with a letter: e.g., us-east-2a.
Boolean includeRelationalDatabaseAvailabilityZones
>A Boolean value indicating whether to also include Availability Zones for databases in your get regions
request. Availability Zones are indicated with a letter (e.g., us-east-2a).
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetRelationalDatabaseBlueprints request. If your results are
paginated, the response will return a next page token that you can specify as the page token in a subsequent
request.
List<E> blueprints
An object describing the result of your get relational database blueprints request.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetRelationalDatabaseBlueprints request and specify
the next page token using the pageToken parameter.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetRelationalDatabaseBundles request. If your results are
paginated, the response will return a next page token that you can specify as the page token in a subsequent
request.
List<E> bundles
An object describing the result of your get relational database bundles request.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetRelationalDatabaseBundles request and specify
the next page token using the pageToken parameter.
String relationalDatabaseName
The name of the database from which to get events.
Integer durationInMinutes
The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.
Default: 60
The minimum is 1 and the maximum is 14 days (20160 minutes).
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetRelationalDatabaseEvents request. If your results are
paginated, the response will return a next page token that you can specify as the page token in a subsequent
request.
List<E> relationalDatabaseEvents
An object describing the result of your get relational database events request.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetRelationalDatabaseEvents request and specify the
next page token using the pageToken parameter.
String relationalDatabaseName
The name of your database for which to get log events.
String logStreamName
The name of the log stream.
Use the get relational database log streams operation to get a list of available log streams.
Date startTime
The start of the time interval from which to get log events.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input
1538424000 as the start time.
Date endTime
The end of the time interval from which to get log events.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input
1538424000 as the end time.
Boolean startFromHead
Parameter to specify if the log should start from head or tail. If true is specified, the log event
starts from the head of the log. If false is specified, the log event starts from the tail of the
log.
For PostgreSQL, the default value of false is the only option available.
String pageToken
The token to advance to the next or previous page of results from your request.
To get a page token, perform an initial GetRelationalDatabaseLogEvents request. If your results are
paginated, the response will return a next forward token and/or next backward token that you can specify as the
page token in a subsequent request.
List<E> resourceLogEvents
An object describing the result of your get relational database log events request.
String nextBackwardToken
A token used for advancing to the previous page of results from your get relational database log events request.
String nextForwardToken
A token used for advancing to the next page of results from your get relational database log events request.
String relationalDatabaseName
The name of your database for which to get log streams.
String relationalDatabaseName
The name of your database for which to get the master user password.
String passwordVersion
The password version to return.
Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively.
Specifying PENDING returns the newest version of the password that will rotate to
CURRENT. After the PENDING password rotates to CURRENT, the
PENDING password is no longer available.
Default: CURRENT
String relationalDatabaseName
The name of your database from which to get metric data.
String metricName
The metric for which you want to return information.
Valid relational database metric names are listed below, along with the most useful statistics to
include in your request, and the published unit value. All relational database metric data is
available in 1-minute (60 seconds) granularity.
CPUUtilization - The percentage of CPU utilization currently in use on the database.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
DatabaseConnections - The number of database connections in use.
Statistics: The most useful statistics are Maximum and Sum.
Unit: The published unit is Count.
DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to
access the disk.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
FreeStorageSpace - The amount of available storage space.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Bytes.
NetworkReceiveThroughput - The incoming (Receive) network traffic on the database,
including both customer database traffic and AWS traffic used for monitoring and replication.
Statistics: The most useful statistic is Average.
Unit: The published unit is Bytes/Second.
NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database,
including both customer database traffic and AWS traffic used for monitoring and replication.
Statistics: The most useful statistic is Average.
Unit: The published unit is Bytes/Second.
Integer period
The granularity, in seconds, of the returned data points.
All relational database metric data is available in 1-minute (60 seconds) granularity.
Date startTime
The start of the time interval from which to get metric data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input
1538424000 as the start time.
Date endTime
The end of the time interval from which to get metric data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input
1538424000 as the end time.
String unit
The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units
with each available metric, see the metricName parameter.
List<E> statistics
The statistic for the metric.
The following statistics are available:
Minimum - The lowest value observed during the specified period. Use this value to determine low
volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high
volumes of activity for your application.
Sum - All values submitted for the matching metric added together. You can use this statistic to
determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic
with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use
is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your
resources.
SampleCount - The count, or number, of data points used for the statistical calculation.
String relationalDatabaseName
The name of your database for which to get parameters.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetRelationalDatabaseParameters request. If your results are
paginated, the response will return a next page token that you can specify as the page token in a subsequent
request.
List<E> parameters
An object describing the result of your get relational database parameters request.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetRelationalDatabaseParameters request and specify
the next page token using the pageToken parameter.
String relationalDatabaseName
The name of the database that you are looking up.
RelationalDatabase relationalDatabase
An object describing the specified database.
String relationalDatabaseSnapshotName
The name of the database snapshot for which to get information.
RelationalDatabaseSnapshot relationalDatabaseSnapshot
An object describing the specified database snapshot.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetRelationalDatabaseSnapshots request. If your results are
paginated, the response will return a next page token that you can specify as the page token in a subsequent
request.
List<E> relationalDatabaseSnapshots
An object describing the result of your get relational database snapshots request.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetRelationalDatabaseSnapshots request and specify
the next page token using the pageToken parameter.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetRelationalDatabases request. If your results are
paginated, the response will return a next page token that you can specify as the page token in a subsequent
request.
List<E> relationalDatabases
An object describing the result of your get relational databases request.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetRelationalDatabases request and specify the next
page token using the pageToken parameter.
String staticIpName
The name of the static IP in Lightsail.
StaticIp staticIp
An array of key-value pairs containing information about the requested static IP.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetStaticIps request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> staticIps
An array of key-value pairs containing information about your get static IPs request.
String nextPageToken
The token to advance to the next page of resutls from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetStaticIps request and specify the next page
token using the pageToken parameter.
String algorithm
The SSH host key algorithm or the RDP certificate format.
For SSH host keys, the algorithm may be ssh-rsa, ecdsa-sha2-nistp256,
ssh-ed25519, etc. For RDP certificates, the algorithm is always x509-cert.
String publicKey
The public SSH host key or the RDP certificate.
Date witnessedAt
The time that the SSH host key or RDP certificate was recorded by Lightsail.
String fingerprintSHA1
The SHA-1 fingerprint of the returned SSH host key or RDP certificate.
Example of an SHA-1 SSH fingerprint:
SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0
Example of an SHA-1 RDP fingerprint:
af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45
String fingerprintSHA256
The SHA-256 fingerprint of the returned SSH host key or RDP certificate.
Example of an SHA-256 SSH fingerprint:
SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o
Example of an SHA-256 RDP fingerprint:
03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68
Date notValidBefore
The returned RDP certificate is valid after this point in time.
This value is listed only for RDP certificates.
Date notValidAfter
The returned RDP certificate is not valid after this point in time.
This value is listed only for RDP certificates.
Operation operation
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.
String name
The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).
String arn
The Amazon Resource Name (ARN) of the instance (e.g.,
arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The timestamp when the instance was created (e.g., 1479734909.17).
ResourceLocation location
The region name and Availability Zone where the instance is located.
String resourceType
The type of resource (usually Instance).
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
String blueprintId
The blueprint ID (e.g., os_amlinux_2016_03).
String blueprintName
The friendly name of the blueprint (e.g., Amazon Linux).
String bundleId
The bundle for the instance (e.g., micro_1_0).
List<E> addOns
An array of objects representing the add-ons enabled on the instance.
Boolean isStaticIp
A Boolean value indicating whether this instance has a static IP assigned to it.
String privateIpAddress
The private IP address of the instance.
String publicIpAddress
The public IP address of the instance.
String ipv6Address
The IPv6 address of the instance.
InstanceHardware hardware
The size of the vCPU and the amount of RAM for the instance.
InstanceNetworking networking
Information about the public ports and monthly data transfer rates for the instance.
InstanceState state
The status code and the state (e.g., running) for the instance.
String username
The user name for connecting to the instance (e.g., ec2-user).
String sshKeyName
The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).
String certKey
For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH),
you should save this value to tempkey-cert.pub.
Date expiresAt
For SSH access, the date on which the temporary keys expire.
String ipAddress
The public IP address of the Amazon Lightsail instance.
String password
For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.
If you create an instance using any key pair other than the default (LightsailDefaultKeyPair),
password will always be an empty string.
If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
PasswordData passwordData
For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only
needed if password is empty and the instance is not new (and therefore the password is not ready
yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.
String privateKey
For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this
value to tempkey).
String protocol
The protocol for these Amazon Lightsail instance access details.
String instanceName
The name of this Amazon Lightsail instance.
String username
The user name to use when logging in to the Amazon Lightsail instance.
List<E> hostKeys
Describes the public SSH host keys or the RDP certificate.
String sourceName
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.
String instanceType
The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.
String portInfoSource
The port configuration to use for the new Amazon EC2 instance.
The following configuration options are available:
DEFAULT - Use the default firewall settings from the Lightsail instance blueprint.
INSTANCE - Use the configured firewall settings from the source Lightsail instance.
NONE - Use the default Amazon EC2 security group.
CLOSED - All ports closed.
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.
String userData
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.
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.
String availabilityZone
The Availability Zone for the new Amazon EC2 instance.
String instanceName
The name of the Lightsail instance for which you are requesting health check data.
String instanceHealth
Describes the overall instance health. Valid values are below.
String instanceHealthReason
More information about the instance health. If the instanceHealth is healthy, then an
instanceHealthReason value is not provided.
If instanceHealth is initial, the instanceHealthReason
value can be one of the following:
Lb.RegistrationInProgress - The target instance is in the process of being registered with
the load balancer.
Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance
the minimum number of health checks required to determine its health status.
If instanceHealth is unhealthy, the instanceHealthReason
value can be one of the following:
Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
Instance.Timeout - The health check requests timed out.
Instance.FailedHealthChecks - The health checks failed because the connection to the target
instance timed out, the target instance response was malformed, or the target instance failed the health check
for an unknown reason.
Lb.InternalError - The health checks failed due to an internal error.
If instanceHealth is unused, the instanceHealthReason
value can be one of the following:
Instance.NotRegistered - The target instance is not registered with the target group.
Instance.NotInUse - The target group is not used by any load balancer, or the target
instance is in an Availability Zone that is not enabled for its load balancer.
Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load
balancer.
Instance.InvalidState - The target is in the stopped or terminated state.
If instanceHealth is draining, the instanceHealthReason
value can be one of the following:
Instance.DeregistrationInProgress - The target instance is in the process of being
deregistered and the deregistration delay period has not expired.
MonthlyTransfer monthlyTransfer
The amount of data in GB allocated for monthly data transfers.
List<E> ports
An array of key-value pairs containing information about the ports on the instance.
Integer fromPort
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 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.
Integer toPort
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 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.
String protocol
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.
String accessFrom
The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or Custom
if a specific IP address or range of IP addresses is allowed.
String accessType
The type of access (Public or Private).
String commonName
The common name of the port information.
String accessDirection
The access direction (inbound or outbound).
Lightsail currently supports only inbound access direction.
List<E> cidrs
The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
List<E> cidrListAliases
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.
Integer fromPort
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 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.
Integer toPort
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 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.
String protocol
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.
String state
Specifies whether the instance port is open or closed.
The port state for Lightsail instances is always open.
List<E> cidrs
The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
List<E> cidrListAliases
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.
String name
The name of the snapshot.
String arn
The Amazon Resource Name (ARN) of the snapshot (e.g.,
arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The timestamp when the snapshot was created (e.g., 1479907467.024).
ResourceLocation location
The region name and Availability Zone where you created the snapshot.
String resourceType
The type of resource (usually InstanceSnapshot).
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
String state
The state the snapshot is in.
String progress
The progress of the snapshot.
List<E> fromAttachedDisks
An array of disk objects containing information about all block storage disks.
String fromInstanceName
The instance from which the snapshot was created.
String fromInstanceArn
The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g.,
arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
String fromBlueprintId
The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual
private server (or instance) image used to create instances quickly.
String fromBundleId
The bundle ID from which you created the snapshot (e.g., micro_1_0).
Boolean isFromAutoSnapshot
A Boolean value indicating whether the snapshot was created from an automatic snapshot.
Integer sizeInGb
The size in GB of the SSD.
String fromBundleId
The bundle ID from which the source instance was created (e.g., micro_1_0).
String fromBlueprintId
The blueprint ID from which the source instance (e.g., os_debian_8_3).
List<E> fromDiskInfo
A list of objects describing the disks that were attached to the source instance.
Boolean isPeered
Returns true if the Lightsail VPC is peered; otherwise, false.
String name
The friendly name of the SSH key pair.
String arn
The Amazon Resource Name (ARN) of the key pair (e.g.,
arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The timestamp when the key pair was created (e.g., 1479816991.349).
ResourceLocation location
The region name and Availability Zone where the key pair was created.
String resourceType
The resource type (usually KeyPair).
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
String fingerprint
The RSA fingerprint of the key pair.
String name
The name of the load balancer (e.g., my-load-balancer).
String arn
The Amazon Resource Name (ARN) of the load balancer.
String supportCode
The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The date when your load balancer was created.
ResourceLocation location
The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically
creates your load balancer across Availability Zones.
String resourceType
The resource type (e.g., LoadBalancer.
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
String dnsName
The DNS name of your Lightsail load balancer.
String state
The status of your load balancer. Valid values are below.
String protocol
The protocol you have enabled for your load balancer. Valid values are below.
You can't just have HTTP_HTTPS, but you can have just HTTP.
List<E> publicPorts
An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
String healthCheckPath
The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.
Integer instancePort
The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.
List<E> instanceHealthSummary
An array of InstanceHealthSummary objects describing the health of the load balancer.
List<E> tlsCertificateSummaries
An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS
certificates. For example, if true, the certificate is attached to the load balancer.
Map<K,V> configurationOptions
A string to string map of the configuration options for your load balancer. Valid values are listed below.
String name
The name of the SSL/TLS certificate (e.g., my-certificate).
String arn
The Amazon Resource Name (ARN) of the SSL/TLS certificate.
String supportCode
The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The time when you created your SSL/TLS certificate.
ResourceLocation location
The AWS Region and Availability Zone where you created your certificate.
String resourceType
The resource type (e.g., LoadBalancerTlsCertificate).
Instance - A Lightsail instance (a virtual private server)
StaticIp - A static IP address
KeyPair - The key pair used to connect to a Lightsail instance
InstanceSnapshot - A Lightsail instance snapshot
Domain - A DNS zone
PeeredVpc - A peered VPC
LoadBalancer - A Lightsail load balancer
LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load
balancer
Disk - A Lightsail block storage disk
DiskSnapshot - A block storage disk snapshot
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
String loadBalancerName
The load balancer name where your SSL/TLS certificate is attached.
Boolean isAttached
When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
String status
The validation status of the SSL/TLS certificate. Valid values are below.
String domainName
The domain name for your SSL/TLS certificate.
List<E> domainValidationRecords
An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
String failureReason
The reason for the SSL/TLS certificate validation failure.
Date issuedAt
The time when the SSL/TLS certificate was issued.
String issuer
The issuer of the certificate.
String keyAlgorithm
The algorithm that was used to generate the key pair (the public and private key).
Date notAfter
The timestamp when the SSL/TLS certificate expires.
Date notBefore
The timestamp when the SSL/TLS certificate is first valid.
LoadBalancerTlsCertificateRenewalSummary renewalSummary
An object containing information about the status of Lightsail's managed renewal for the certificate.
String revocationReason
The reason the certificate was revoked. Valid values are below.
Date revokedAt
The timestamp when the SSL/TLS certificate was revoked.
String serial
The serial number of the certificate.
String signatureAlgorithm
The algorithm that was used to sign the certificate.
String subject
The name of the entity that is associated with the public key contained in the certificate.
List<E> subjectAlternativeNames
One or more domains or subdomains included in the certificate. This list contains the domain names that are bound
to the public key that is contained in the certificate. The subject alternative names include the canonical
domain name (CNAME) of the certificate and additional domain names that can be used to connect to the website,
such as example.com, www.example.com, or m.example.com.
String name
A fully qualified domain name in the certificate. For example, example.com.
String type
The type of validation record. For example, CNAME for domain validation.
String value
The value for that type.
String validationStatus
The validation status. Valid values are listed below.
String domainName
The domain name against which your SSL/TLS certificate was validated.
String renewalStatus
The status of Lightsail's managed renewal of the certificate. Valid values are listed below.
List<E> domainValidationOptions
Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.
String arn
The Amazon Resource Name (ARN) of the resource being monitored.
String name
The name of the Lightsail resource being monitored.
String resourceType
The Lightsail resource type of the resource being monitored.
Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.
Integer gbPerMonthAllocated
The amount allocated per month (in GB).
Operation operation
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.
String id
The ID of the operation.
String resourceName
The resource name.
String resourceType
The resource type.
Date createdAt
The timestamp when the operation was initialized (e.g., 1479816991.349).
ResourceLocation location
The AWS Region and Availability Zone.
Boolean isTerminal
A Boolean value indicating whether the operation is terminal.
String operationDetails
Details about the operation (e.g., Debian-1GB-Ohio-1).
String operationType
The type of operation.
String status
The status of the operation.
Date statusChangedAt
The timestamp when the status was changed (e.g., 1479816991.349).
String errorCode
The error code.
String errorDetails
The error details.
String ciphertext
The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.
If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available
in the password field.
If you are using a custom key pair, you need to use your own means of decryption.
If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
String keyPairName
The name of the key pair that you used when creating your instance. If no key pair name was specified when
creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair).
If you are using a custom key pair, you need to use your own means of decrypting your password using the
ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of
this key pair.
Operation operation
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.
Integer fromPort
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 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.
Integer toPort
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 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.
String protocol
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.
List<E> cidrs
The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.
Examples:
To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.
To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
List<E> cidrListAliases
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.
String alarmName
The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
String metricName
The name of the metric to associate with the alarm.
You can configure up to two alarms per metric.
The following metrics are available for each resource type:
Instances: BurstCapacityPercentage, BurstCapacityTime,
CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed,
StatusCheckFailed_Instance, and StatusCheckFailed_System.
Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount,
UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count,
HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count,
HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count,
InstanceResponseTime, RejectedConnectionCount, and RequestCount.
Relational databases: CPUUtilization, DatabaseConnections,
DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and
NetworkTransmitThroughput.
For more information about these metrics, see Metrics available in Lightsail.
String monitoredResourceName
The name of the Lightsail resource that will be monitored.
Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.
String comparisonOperator
The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
Double threshold
The value against which the specified statistic is compared.
Integer evaluationPeriods
The number of most recent periods over which data is compared to the specified threshold. If you are setting an
"M out of N" alarm, this value (evaluationPeriods) is the N.
If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.
Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.
You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).
Integer datapointsToAlarm
The number of data points that must be not within the specified threshold to trigger the alarm. If you are
setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
String treatMissingData
Sets how this alarm will handle missing data points.
An alarm can treat missing data in the following ways:
breaching - Assume the missing data is not within the threshold. Missing data counts towards the
number of times the metric is not within the threshold.
notBreaching - Assume the missing data is within the threshold. Missing data does not count towards
the number of times the metric is not within the threshold.
ignore - Ignore the missing data. Maintains the current alarm state.
missing - Missing data is treated as missing.
If treatMissingData is not specified, the default behavior of missing is used.
List<E> contactProtocols
The contact protocols to use for the alarm, such as Email, SMS (text messaging), or
both.
A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.
A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not
configured in the AWS Region, or if notifications are not enabled for the alarm using the
notificationEnabled paramater.
Use the CreateContactMethod action to configure a contact protocol in an AWS Region.
List<E> notificationTriggers
The alarm states that trigger a notification.
An alarm has the following possible states:
ALARM - The metric is outside of the defined threshold.
INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is
available for the metric to determine the alarm state.
OK - The metric is within the defined threshold.
When you specify a notification trigger, the ALARM state must be specified. The
INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM
state.
If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an
ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought
of as an all clear alarm notification.
If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm
switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.
The notification trigger defaults to ALARM if you don't specify this parameter.
Boolean notificationEnabled
Indicates whether the alarm is enabled.
Notifications are enabled by default if you don't specify this parameter.
Operation operation
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.
String instanceName
The name of the instance to reboot.
String relationalDatabaseName
The name of your database to reboot.
String continentCode
The continent code (e.g., NA, meaning North America).
String description
The description of the AWS Region (e.g.,
This region is recommended to serve users in the eastern United States and eastern Canada).
String displayName
The display name (e.g., Ohio).
String name
The region name (e.g., us-east-2).
List<E> availabilityZones
The Availability Zones. Follows the format us-east-2a (case-sensitive).
List<E> relationalDatabaseAvailabilityZones
The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).
String name
The unique name of the database resource in Lightsail.
String arn
The Amazon Resource Name (ARN) of the database.
String supportCode
The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The timestamp when the database was created. Formatted in Unix time.
ResourceLocation location
The Region name and Availability Zone where the database is located.
String resourceType
The Lightsail resource type for the database (for example, RelationalDatabase).
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
String relationalDatabaseBlueprintId
The blueprint ID for the database. A blueprint describes the major engine version of a database.
String relationalDatabaseBundleId
The bundle ID for the database. A bundle describes the performance specifications for your database.
String masterDatabaseName
The name of the master database created when the Lightsail database resource is created.
RelationalDatabaseHardware hardware
Describes the hardware of the database.
String state
Describes the current state of the database.
String secondaryAvailabilityZone
Describes the secondary Availability Zone of a high availability database.
The secondary database is used for failover support of a high availability database.
Boolean backupRetentionEnabled
A Boolean value indicating whether automated backup retention is enabled for the database.
PendingModifiedRelationalDatabaseValues pendingModifiedValues
Describes pending database value modifications.
String engine
The database software (for example, MySQL).
String engineVersion
The database engine version (for example, 5.7.23).
Date latestRestorableTime
The latest point in time to which the database can be restored. Formatted in Unix time.
String masterUsername
The master user name of the database.
String parameterApplyStatus
The status of parameter updates for the database.
String preferredBackupWindow
The daily time range during which automated backups are created for the database (for example,
16:00-16:30).
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur on the database.
In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.
Boolean publiclyAccessible
A Boolean value indicating whether the database is publicly accessible.
RelationalDatabaseEndpoint masterEndpoint
The master endpoint for the database.
List<E> pendingMaintenanceActions
Describes the pending maintenance actions for the database.
String caCertificateIdentifier
The certificate associated with the database.
String blueprintId
The ID for the database blueprint.
String engine
The database software of the database blueprint (for example, MySQL).
String engineVersion
The database engine version for the database blueprint (for example, 5.7.23).
String engineDescription
The description of the database engine for the database blueprint.
String engineVersionDescription
The description of the database engine version for the database blueprint.
Boolean isEngineDefault
A Boolean value indicating whether the engine version is the default for the database blueprint.
String bundleId
The ID for the database bundle.
String name
The name for the database bundle.
Float price
The cost of the database bundle in US currency.
Float ramSizeInGb
The amount of RAM in GB (for example, 2.0) for the database bundle.
Integer diskSizeInGb
The size of the disk for the database bundle.
Integer transferPerMonthInGb
The data transfer rate per month in GB for the database bundle.
Integer cpuCount
The number of virtual CPUs (vCPUs) for the database bundle.
Boolean isEncrypted
A Boolean value indicating whether the database bundle is encrypted.
Boolean isActive
A Boolean value indicating whether the database bundle is active.
String allowedValues
Specifies the valid range of values for the parameter.
String applyMethod
Indicates when parameter updates are applied.
Can be immediate or pending-reboot.
String applyType
Specifies the engine-specific parameter type.
String dataType
Specifies the valid data type for the parameter.
String description
Provides a description of the parameter.
Boolean isModifiable
A Boolean value indicating whether the parameter can be modified.
String parameterName
Specifies the name of the parameter.
String parameterValue
Specifies the value of the parameter.
String name
The name of the database snapshot.
String arn
The Amazon Resource Name (ARN) of the database snapshot.
String supportCode
The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The timestamp when the database snapshot was created.
ResourceLocation location
The Region name and Availability Zone where the database snapshot is located.
String resourceType
The Lightsail resource type.
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
String engine
The software of the database snapshot (for example, MySQL)
String engineVersion
The database engine version for the database snapshot (for example, 5.7.23).
Integer sizeInGb
The size of the disk in GB (for example, 32) for the database snapshot.
String state
The state of the database snapshot.
String fromRelationalDatabaseName
The name of the source database from which the database snapshot was created.
String fromRelationalDatabaseArn
The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
String fromRelationalDatabaseBundleId
The bundle ID of the database from which the database snapshot was created.
String fromRelationalDatabaseBlueprintId
The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
String staticIpName
The name of the static IP to delete.
String protocol
The protocol to verify, such as Email or SMS (text messaging).
String instanceName
The name of the instance (a virtual private server) to start.
String relationalDatabaseName
The name of your database to start.
String name
The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).
String arn
The Amazon Resource Name (ARN) of the static IP (e.g.,
arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The timestamp when the static IP was created (e.g., 1479735304.222).
ResourceLocation location
The region and Availability Zone where the static IP was created.
String resourceType
The resource type (usually StaticIp).
String ipAddress
The static IP address.
String attachedTo
The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).
Boolean isAttached
A Boolean value indicating whether the static IP is attached.
String instanceName
The name of the instance (a virtual private server) to stop.
Boolean force
When set to True, forces a Lightsail instance that is stuck in a stopping state to
stop.
Only use the force parameter if your instance is stuck in the stopping state. In any
other state, your instance should stop normally without adding this parameter to your API request.
String key
The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
String value
The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
String alarmName
The name of the alarm to test.
String state
The alarm state to test.
An alarm has the following possible states that can be tested:
ALARM - The metric is outside of the defined threshold.
INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is
available for the metric to determine the alarm state.
OK - The metric is within the defined threshold.
Operation operation
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.
String domainName
The name of the domain recordset to update.
DomainEntry domainEntry
An array of key-value pairs containing information about the domain entry.
String loadBalancerName
The name of the load balancer that you want to modify (e.g., my-load-balancer.
String attributeName
The name of the attribute you want to update. Valid values are below.
String attributeValue
The value that you want to specify for the attribute name.
String relationalDatabaseName
The name of your database to update.
String masterUserPassword
The password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain 8 to 41 characters.
Boolean rotateMasterUserPassword
When true, the master user password is changed to a new strong password generated by Lightsail.
Use the get relational database master user password operation to get the new password.
String preferredBackupWindow
The daily time range during which automated backups are created for your database if automated backups are enabled.
Constraints:
Must be in the hh24:mi-hh24:mi format.
Example: 16:00-16:30
Specified in Coordinated Universal Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur on your database.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints:
Must be in the ddd:hh24:mi-ddd:hh24:mi format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Coordinated Universal Time (UTC).
Example: Tue:17:00-Tue:17:30
Boolean enableBackupRetention
When true, enables automated backup retention for your database.
Updates are applied during the next maintenance window because this can result in an outage.
Boolean disableBackupRetention
When true, disables automated backup retention for your database.
Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create
a snapshot of your database using the create relational database snapshot operation.
Updates are applied during the next maintenance window because this can result in an outage.
Boolean publiclyAccessible
Specifies the accessibility options for your database. A value of true specifies a database that is
available to resources outside of your Lightsail account. A value of false specifies a database that
is available only to your Lightsail resources in the same region as your database.
Boolean applyImmediately
When true, applies changes immediately. When false, applies changes during the
preferred maintenance window. Some changes may cause an outage.
Default: false
String caCertificateIdentifier
Indicates the certificate that needs to be associated with the database.
Copyright © 2020. All rights reserved.