String accessKeyId
The ID of the access key.
String secretAccessKey
The secret access key used to sign requests.
You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.
String status
The status of the access key.
A status of Active means that the key is valid, while Inactive means it is not.
Date createdAt
The timestamp when the access key was created.
AccessKeyLastUsed lastUsed
An object that describes the last time the access key was used.
This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and
serviceName values are N/A, and the lastUsedDate value is null.
Date lastUsedDate
The date and time when the access key was most recently used.
This value is null if the access key has not been used.
String region
The Amazon Web Services Region where this access key was most recently used.
This value is N/A if the access key has not been used.
String serviceName
The name of the Amazon Web Services service with which this access key was most recently used.
This value is N/A if the access key has not been used.
String getObject
Specifies the anonymous access to all objects in a bucket.
The following options can be specified:
public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the
world.
If the getObject value is set to public, then all objects in the bucket default to
public regardless of the allowPublicOverrides value.
private - Sets all objects in the bucket to private, making them readable only by you or anyone you
give access to.
If the getObject value is set to private, and the allowPublicOverrides
value is set to true, then all objects in the bucket default to private unless they are configured
with a public-read ACL. Individual objects with a public-read ACL are readable by
anyone in the world.
Boolean allowPublicOverrides
A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual
objects override the getObject option that is currently specified.
When this is true, you can use the PutObjectAcl Amazon S3 API
action to set individual objects to public (read-only) using the public-read ACL, or to private
using the private ACL.
String status
The status of the account-level BPA synchronization.
The following statuses are possible:
InSync - Account-level BPA is synchronized. The Amazon S3 account-level BPA configuration applies to
your Lightsail buckets.
NeverSynced - Synchronization has not yet happened. The Amazon S3 account-level BPA configuration
does not apply to your Lightsail buckets.
Failed - Synchronization failed. The Amazon S3 account-level BPA configuration does not apply to
your Lightsail buckets.
Defaulted - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to
active.
You might need to complete further actions if the status is Failed or Defaulted. The
message parameter provides more information for those statuses.
Date lastSyncedAt
The timestamp of when the account-level BPA configuration was last synchronized. This value is null when the account-level BPA configuration has not been synchronized.
String message
A message that provides a reason for a Failed or Defaulted synchronization status.
The following messages are possible:
SYNC_ON_HOLD - The synchronization has not yet happened. This status message occurs immediately
after you create your first Lightsail bucket. This status message should change after the first synchronization
happens, approximately 1 hour after the first bucket is created.
DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the required service-linked role is
missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is
defaulted to active until the synchronization can occur. This means that all your buckets are private and
not publicly accessible. For more information about how to create the required service-linked role to allow
synchronization, see Using
Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because the required service-linked
role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail
buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your
Lightsail buckets. For more information about how to create the required service-linked role to allow
synchronization, see Using
Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
Unknown - The reason that synchronization failed is unknown. Contact Amazon Web Services Support for
more information.
Boolean bpaImpactsLightsail
A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
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 threshold
The trigger threshold of the action.
This add-on only applies to Lightsail for Research resources.
String duration
The amount of idle time in minutes after which your virtual computer will automatically stop.
This add-on only applies to Lightsail for Research resources.
String addOnType
The add-on type.
AutoSnapshotAddOnRequest autoSnapshotAddOnRequest
An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
StopInstanceOnIdleRequest stopInstanceOnIdleRequest
An object that represents additional parameters when enabling or modifying the StopInstanceOnIdle
add-on.
This object only applies to Lightsail for Research resources.
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 of the 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 distributionName
The name of the distribution that the certificate will be attached to.
Use the GetDistributions action to get a list of distribution names that you can specify.
String certificateName
The name of the certificate to attach to a distribution.
Only certificates with a status of ISSUED can be attached to a distribution.
Use the GetCertificates action to get a list of certificate names that you can specify.
This is the name of the certificate resource type and is used only to reference the certificate in other API
actions. It can be different than the domain name of the certificate. For example, your certificate name might be
WordPress-Blog-Certificate and the domain name of the certificate might be example.com.
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 diskName
The unique Lightsail disk name (my-disk).
String instanceName
The name of the Lightsail instance where you want to utilize the storage disk.
String diskPath
The disk path to expose to the instance (/dev/xvdf).
Boolean autoMounting
A Boolean value used to determine the automatic mounting of a storage volume to a virtual computer. The default
value is False.
This value only applies to Lightsail for Research resources.
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 (app_wordpress_4_4 or app_lamp_7_0).
String name
The friendly name of the blueprint (Amazon Linux).
String group
The group name of the blueprint (amazon-linux).
String type
The type of the blueprint (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 ( 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.
String appCategory
Virtual computer blueprints that are supported by Lightsail for Research.
This parameter only applies to Lightsail for Research resources.
String resourceType
The Lightsail resource type of the bucket.
AccessRules accessRules
An object that describes the access rules of the bucket.
String arn
The Amazon Resource Name (ARN) of the bucket.
String bundleId
The ID of the bundle currently applied to the bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.
Use the UpdateBucketBundle action to change the bundle of a bucket.
Date createdAt
The timestamp when the distribution was created.
String url
The URL of the bucket.
ResourceLocation location
An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.
String name
The name of the bucket.
String supportCode
The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.
List<E> tags
The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.
String objectVersioning
Indicates whether object versioning is enabled for the bucket.
The following options can be configured:
Enabled - Object versioning is enabled.
Suspended - Object versioning was previously enabled but is currently suspended. Existing object
versions are retained.
NeverEnabled - Object versioning has never been enabled.
Boolean ableToUpdateBundle
Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.
You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.
Use the UpdateBucketBundle action to change a bucket's bundle.
List<E> readonlyAccessAccounts
An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.
List<E> resourcesReceivingAccess
An array of objects that describe Lightsail instances that have access to the bucket.
Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.
BucketState state
An object that describes the state of the bucket.
BucketAccessLogConfig accessLogConfig
An object that describes the access log configuration for the bucket.
Boolean enabled
A Boolean value that indicates whether bucket access logging is enabled for the bucket.
String destination
The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.
This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.
String prefix
The optional object prefix for the bucket access log.
The prefix is an optional addition to the object key that organizes your access log files in the destination
bucket. For example, if you specify a logs/ prefix, then each log object will begin with the
logs/ prefix in its key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).
This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.
String bundleId
The ID of the bundle.
String name
The name of the bundle.
Float price
The monthly price of the bundle, in US dollars.
Integer storagePerMonthInGb
The storage size of the bundle, in GB.
Integer transferPerMonthInGb
The monthly network transfer quota of the bundle.
Boolean isActive
Indicates whether the bundle is active. Use for a new or existing bucket.
String code
The state code of the bucket.
The following codes are possible:
OK - The bucket is in a running state.
Unknown - Creation of the bucket might have timed-out. You might want to delete the bucket and
create a new one.
String message
A message that describes the state of the bucket.
Float price
The price in US dollars (5.0) of the bundle.
Integer cpuCount
The number of vCPUs included in the bundle (2).
Integer diskSizeInGb
The size of the SSD (30).
String bundleId
The bundle ID (micro_1_0).
String instanceType
The Amazon EC2 instance type (t2.micro).
Boolean isActive
A Boolean value indicating whether the bundle is active.
String name
A friendly name for the bundle (Micro).
Integer power
A numeric value that represents the power of the bundle (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 (2.0).
Integer transferPerMonthInGb
The data transfer rate per month in GB (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.
List<E> supportedAppCategories
Virtual computer blueprints that are supported by a Lightsail for Research bundle.
This parameter only applies to Lightsail for Research resources.
Integer publicIpv4AddressCount
An integer that indicates the public ipv4 address count included in the bundle, the value is either 0 or 1.
String behavior
The cache behavior of the distribution.
The following cache behaviors can be specified:
cache - This option is best for static sites. When specified, your distribution caches and
serves your entire website as static content. This behavior is ideal for websites with static content that
doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to
personalize content.
dont-cache - This option is best for sites that serve a mix of static and dynamic content.
When specified, your distribution caches and serve only the content that is specified in the distribution's
CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use
cookies, headers, and query strings to personalize content for individual users.
String path
The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (
path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are
case-sensitive.
Examples:
Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.
var/www/html/
Specify the following file to cache only the index page in the document root of an Apache web server.
var/www/html/index.html
Specify the following to cache only the .html files in the document root of an Apache web server.
var/www/html/*.html
Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.
var/www/html/images/*.jpg
var/www/html/images/*.png
var/www/html/images/*.gif
Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.
var/www/html/images/
String behavior
The cache behavior for the specified path.
You can specify one of the following per-path cache behaviors:
cache - This behavior caches the specified path.
dont-cache - This behavior doesn't cache the specified path.
Long defaultTTL
The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.
The value specified applies only when the origin does not add HTTP headers such as
Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
Long minimumTTL
The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
A value of 0 must be specified for minimumTTL if the distribution is configured to
forward all headers to the origin.
Long maximumTTL
The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age,
Cache-Control s-maxage, and Expires to objects.
String allowedHTTPMethods
The HTTP methods that are processed and forwarded to the distribution's origin.
You can specify the following options:
GET,HEAD - The distribution forwards the GET and HEAD methods.
GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and
OPTIONS methods.
GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET,
HEAD, OPTIONS, PUT, PATCH, POST, and
DELETE methods.
If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
String cachedHTTPMethods
The HTTP method responses that are cached by your distribution.
You can specify the following options:
GET,HEAD - The distribution caches responses to the GET and HEAD methods.
GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and
OPTIONS methods.
CookieObject forwardedCookies
An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
HeaderObject forwardedHeaders
An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
QueryStringObject forwardedQueryStrings
An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
String arn
The Amazon Resource Name (ARN) of the certificate.
String name
The name of the certificate (my-certificate).
String domainName
The domain name of the certificate.
String status
The validation status of the certificate.
String serialNumber
The serial number of the certificate.
List<E> subjectAlternativeNames
An array of strings that specify the alternate domains (example2.com) and subdomains (
blog.example.com) of the certificate.
List<E> domainValidationRecords
An array of objects that describe the domain validation records of the certificate.
String requestFailureReason
The validation failure reason, if any, of the certificate.
The following failure reasons are possible:
NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available
for Lightsail certificates.
ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process
this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the
Alexa top 1000 websites. To provide the required information, use the Amazon Web Services Support Center to contact Amazon Web
Services Support.
You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was
reported as an unsafe domain by VirusTotal. To correct the
problem, search for your domain name on the VirusTotal
website. If your domain is reported as suspicious, see Google Help for Hacked Websites to
learn what you can do.
If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the Amazon Web Services Support Center and create a case.
INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not
valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a
certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all
domain names in the request are for valid top-level domains. For example, you cannot request a certificate for
example.invalidpublicdomain because invalidpublicdomain is not a valid top-level
domain.
OTHER - Typically, this failure occurs when there is a typographical error in one or more
of the domain names in the certificate request. Try to request a certificate again, correcting any spelling
errors or typos that were in the failed request.
Integer inUseResourceCount
The number of Lightsail resources that the certificate is attached to.
String keyAlgorithm
The algorithm used to generate the key pair (the public and private key) of the certificate.
Date createdAt
The timestamp when the certificate was created.
Date issuedAt
The timestamp when the certificate was issued.
String issuerCA
The certificate authority that issued the certificate.
Date notBefore
The timestamp when the certificate is first valid.
Date notAfter
The timestamp when the certificate expires.
String eligibleToRenew
The renewal eligibility of the certificate.
RenewalSummary renewalSummary
An object that describes the status of the certificate renewal managed by Lightsail.
Date revokedAt
The timestamp when the certificate was revoked. This value is present only when the certificate status is
REVOKED.
String revocationReason
The reason the certificate was revoked. This value is present only when the certificate status is
REVOKED.
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
String supportCode
The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.
String certificateArn
The Amazon Resource Name (ARN) of the certificate.
String certificateName
The name of the certificate.
String domainName
The domain name of the certificate.
Certificate certificateDetail
An object that describes a certificate in detail.
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
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 Amazon Web Services Region of the CloudFormation stack record.
String resourceType
The Lightsail resource type (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
An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.
String resourceType
The Lightsail resource type of the contact method.
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 image
The name of the image used for the container.
Container images sourced from your Lightsail container service, that are registered and stored on your service,
start with a colon (:). For example, if your container service name is
container-service-1, the container image label is mystaticsite, and you want to use the
third (3) version of the registered container image, then you should specify
:container-service-1.mystaticsite.3. To use the latest version of a container image, specify
latest instead of a version number (for example,
:container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered
version of the registered container image.
Container images sourced from a public registry like Docker Hub don't start with a colon. For example,
nginx:latest or nginx.
List<E> command
The launch command for the container.
Map<K,V> environment
The environment variables of the container.
Map<K,V> ports
The open firewall ports of the container.
String containerServiceName
The name of the container service.
String arn
The Amazon Resource Name (ARN) of the container service.
Date createdAt
The timestamp when the container service was created.
ResourceLocation location
An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.
String resourceType
The Lightsail resource type of the container service.
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
String power
The power specification of the container service.
The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.
String powerId
The ID of the power of the container service.
String state
The current state of the container service.
The following container service states are possible:
PENDING - The container service is being created.
READY - The container service is running but it does not have an active container deployment.
DEPLOYING - The container service is launching a container deployment.
RUNNING - The container service is running and it has an active container deployment.
UPDATING - The container service capacity or its custom domains are being updated.
DELETING - The container service is being deleted.
DISABLED - The container service is disabled, and its active deployment and containers, if any, are
shut down.
ContainerServiceStateDetail stateDetail
An object that describes the current state of the container service.
The state detail is populated only when a container service is in a PENDING, DEPLOYING,
or UPDATING state.
Integer scale
The scale specification of the container service.
The scale specifies the allocated compute nodes of the container service.
ContainerServiceDeployment currentDeployment
An object that describes the current container deployment of the container service.
ContainerServiceDeployment nextDeployment
An object that describes the next deployment of the container service.
This value is null when there is no deployment in a pending state.
Boolean isDisabled
A Boolean value indicating whether the container service is disabled.
String principalArn
The principal ARN of the container service.
The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your service permission to access resources in your standard Amazon Web Services account.
String privateDomainName
The private domain name of the container service.
The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.
Map<K,V> publicDomainNames
The public domain name of the container service, such as example.com and
www.example.com.
You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.
If you don't specify public domain names, then you can use the default domain of the container service.
You must create and validate an SSL/TLS certificate before you can use public domain names with your container
service. Use the CreateCertificate action to create a certificate for the public domain names you
want to use with your container service.
See CreateContainerService or UpdateContainerService for information about how to
specify public domain names for your Lightsail container service.
String url
The publicly accessible URL of the container service.
If no public endpoint is specified in the currentDeployment, this URL returns a 404 response.
PrivateRegistryAccess privateRegistryAccess
An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.
Integer version
The version number of the deployment.
String state
The state of the deployment.
A deployment can be in one of the following states:
ACTIVATING - The deployment is being created.
ACTIVE - The deployment was successfully created, and it's currently running on the container
service. The container service can have only one deployment in an active state at a time.
INACTIVE - The deployment was previously successfully created, but it is not currently running on
the container service.
FAILED - The deployment failed. Use the GetContainerLog action to view the log events
for the containers in the deployment to try to determine the reason for the failure.
Map<K,V> containers
An object that describes the configuration for the containers of the deployment.
ContainerServiceEndpoint publicEndpoint
An object that describes the endpoint of the deployment.
Date createdAt
The timestamp when the deployment was created.
Map<K,V> containers
An object that describes the configuration for the containers of the deployment.
EndpointRequest publicEndpoint
An object that describes the endpoint of the deployment.
Boolean isActive
A Boolean value that indicates whether to activate the role.
String containerName
The name of the container entry of the deployment that the endpoint configuration applies to.
Integer containerPort
The port of the specified container to which traffic is forwarded to.
ContainerServiceHealthCheckConfig healthCheck
An object that describes the health check configuration of the container.
Integer healthyThreshold
The number of consecutive health checks successes required before moving the container to the
Healthy state. The default value is 2.
Integer unhealthyThreshold
The number of consecutive health check failures required before moving the container to the
Unhealthy state. The default value is 2.
Integer timeoutSeconds
The amount of time, in seconds, during which no response means a failed health check. You can specify between 2
and 60 seconds. The default value is 2.
Integer intervalSeconds
The approximate interval, in seconds, between health checks of an individual container. You can specify between 5
and 300 seconds. The default value is 5.
String path
The path on the container on which to perform the health check. The default value is /.
String successCodes
The HTTP codes to use when checking for a successful response from a container. You can specify values between
200 and 499. You can specify multiple values (for example, 200,202) or a
range of values (for example, 200-299).
String powerId
The ID of the power (nano-1).
Float price
The monthly price of the power in USD.
Float cpuCount
The number of vCPUs included in the power.
Float ramSizeInGb
The amount of RAM (in GB) of the power.
String name
The friendly name of the power (nano).
Boolean isActive
A Boolean value indicating whether the power is active and can be specified for container services.
String username
The container service registry username to use to push container images to the container image registry of a Lightsail account.
String password
The container service registry password to use to push container images to the container image registry of a Lightsail account
Date expiresAt
The timestamp of when the container image registry sign-in credentials expire.
The log in credentials expire 12 hours after they are created, at which point you will need to create a new set
of log in credentials using the CreateContainerServiceRegistryLogin action.
String registry
The address to use to push container images to the container image registry of a Lightsail account.
String code
The state code of the container service.
The following state codes are possible:
The following state codes are possible if your container service is in a DEPLOYING or
UPDATING state:
CREATING_SYSTEM_RESOURCES - The system resources for your container service are being created.
CREATING_NETWORK_INFRASTRUCTURE - The network infrastructure for your container service are being
created.
PROVISIONING_CERTIFICATE - The SSL/TLS certificate for your container service is being created.
PROVISIONING_SERVICE - Your container service is being provisioned.
CREATING_DEPLOYMENT - Your deployment is being created on your container service.
EVALUATING_HEALTH_CHECK - The health of your deployment is being evaluated.
ACTIVATING_DEPLOYMENT - Your deployment is being activated.
The following state codes are possible if your container service is in a PENDING state:
CERTIFICATE_LIMIT_EXCEEDED - The SSL/TLS certificate required for your container service exceeds the
maximum number of certificates allowed for your account.
UNKNOWN_ERROR - An error was experienced when your container service was being created.
String message
A message that provides more information for the state code.
The state detail is populated only when a container service is in a PENDING, DEPLOYING,
or UPDATING state.
String option
Specifies which cookies to forward to the distribution's origin for a cache behavior: all,
none, or allow-list to forward only the cookies specified in the
cookiesAllowList parameter.
List<E> cookiesAllowList
The specific cookies to forward to your distribution's origin.
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 Amazon Lightsail Developer 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 Amazon Lightsail Developer 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 Amazon Lightsail Developer Guide.
String targetSnapshotName
The name of the new manual snapshot to be created as a copy.
String sourceRegion
The Amazon Web Services Region where the source manual or automatic snapshot is located.
String bucketName
The name of the bucket that the new access key will belong to, and grant access to.
String bucketName
The name for the bucket.
For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.
String bundleId
The ID of the bundle to use for the bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.
Use the GetBucketBundles action to get a list of bundle IDs that you can specify.
Use the UpdateBucketBundle action to change the bundle after the bucket is created.
List<E> tags
The tag keys and optional values to add to the bucket during creation.
Use the TagResource action to tag the bucket after it's created.
Boolean enableObjectVersioning
A Boolean value that indicates whether to enable versioning of objects in the bucket.
For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
String certificateName
The name for the certificate.
String domainName
The domain name (example.com) for the certificate.
List<E> subjectAlternativeNames
An array of strings that specify the alternate domains (example2.com) and subdomains (
blog.example.com) for the certificate.
You can specify a maximum of nine alternate domains (in addition to the primary domain name).
Wildcard domain entries (*.example.com) are not supported.
List<E> tags
The tag keys and optional values to add to the certificate during create.
Use the TagResource action to tag a resource after it's created.
CertificateSummary certificate
An object that describes the certificate created.
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 protocol
The protocol of the contact method, such as Email or SMS (text messaging).
The SMS protocol is supported only in the following Amazon Web Services 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 Amazon Web Services 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 serviceName
The name of the container service for which to create the deployment.
Map<K,V> containers
An object that describes the settings of the containers that will be launched on the container service.
EndpointRequest publicEndpoint
An object that describes the settings of the public endpoint for the container service.
ContainerService containerService
An object that describes a container service.
ContainerServiceRegistryLogin registryLogin
An object that describes the log in information for the container service registry of your Lightsail account.
String serviceName
The name for the container service.
The name that you specify for your container service will make up part of its default domain. The default domain
of a container service is typically
https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name
of your container service is container-service-1, and it's located in the US East (Ohio) Amazon Web
Services Region (us-east-2), then the domain for your container service will be like the following
example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com
The following are the requirements for container service names:
Must be unique within each Amazon Web Services Region in your Lightsail account.
Must contain 1 to 63 characters.
Must contain only alphanumeric characters and hyphens.
A hyphen (-) can separate words but cannot be at the start or end of the name.
String power
The power specification for the container service.
The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The
power and scale of a container service makes up its configured capacity. To determine
the monthly price of your container service, multiply the base price of the power with the
scale (the number of nodes) of the service.
Use the GetContainerServicePowers action to get a list of power options that you can specify using
this parameter, and their base monthly cost.
Integer scale
The scale specification for the container service.
The scale specifies the allocated compute nodes of the container service. The power and
scale of a container service makes up its configured capacity. To determine the monthly price of
your container service, multiply the base price of the power with the scale (the number
of nodes) of the service.
List<E> tags
The tag keys and optional values to add to the container service during create.
Use the TagResource action to tag a resource after it's created.
For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
Map<K,V> publicDomainNames
The public domain names to use with the container service, such as example.com and
www.example.com.
You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.
If you don't specify public domain names, then you can use the default domain of the container service.
You must create and validate an SSL/TLS certificate before you can use public domain names with your container
service. Use the CreateCertificate action to create a certificate for the public domain names you
want to use with your container service.
You can specify public domain names using a string to array map as shown in the example later on this page.
ContainerServiceDeploymentRequest deployment
An object that describes a deployment for the container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
PrivateRegistryAccessRequest privateRegistryAccess
An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.
ContainerService containerService
An object that describes a container service.
String diskName
The unique Lightsail disk name (my-disk).
String diskSnapshotName
The name of the disk snapshot (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 (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 (32).
List<E> tags
The tag keys and optional values to add to the resource during create.
Use the TagResource action to tag a resource after it's created.
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 Amazon Lightsail Developer 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 Amazon Lightsail Developer 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 Amazon Lightsail Developer Guide.
String diskName
The unique Lightsail disk name (my-disk).
String availabilityZone
The Availability Zone where you want to create the disk (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 (32).
List<E> tags
The tag keys and optional values to add to the resource during create.
Use the TagResource action to tag a resource after it's created.
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 (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 (my-disk-snapshot) based on the source disk.
String instanceName
The unique name of the source instance (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.
Use the TagResource action to tag a resource after it's created.
String distributionName
The name for the distribution.
InputOrigin origin
An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.
The distribution pulls, caches, and serves content from the origin.
CacheBehavior defaultCacheBehavior
An object that describes the default cache behavior for the distribution.
CacheSettings cacheBehaviorSettings
An object that describes the cache behavior settings for the distribution.
List<E> cacheBehaviors
An array of objects that describe the per-path cache behavior for the distribution.
String bundleId
The bundle ID to use for the distribution.
A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.
Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.
String ipAddressType
The IP address type for the distribution.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
The default value is dualstack.
List<E> tags
The tag keys and optional values to add to the distribution during create.
Use the TagResource action to tag a resource after it's created.
String certificateName
The name of the SSL/TLS certificate that you want to attach to the distribution.
Use the GetCertificates action to get a list of certificate names that you can specify.
String viewerMinimumTlsProtocolVersion
The minimum TLS protocol version for the SSL/TLS certificate.
LightsailDistribution distribution
An object that describes the distribution created.
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 (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.
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 resource name.
String resourceName
The resource name.
String status
The status of the operation.
Integer percentageComplete
The percentage of completion for the operation.
String failureReason
The reason the operation failed.
List<E> sessions
Returns information about the specified NICE DCV GUI session.
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 (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 Amazon Lightsail Developer 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.
Use the TagResource action to tag a resource after it's created.
List<E> addOns
An array of objects representing the add-ons to enable for the new instance.
String ipAddressType
The IP address type for the instance.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
The default value is dualstack.
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 Amazon Lightsail Developer 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 Amazon Lightsail Developer 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 Amazon Lightsail Developer 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.
Use the TagResource action to tag a resource after it's created.
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
(Discontinued) The name for your custom image.
In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.
String blueprintId
The ID for a virtual private server image (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 (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 Amazon Lightsail Developer 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.
Use the TagResource action to tag a resource after it's created.
List<E> addOns
An array of objects representing the add-ons to enable for the new instance.
String ipAddressType
The IP address type for the instance.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
The default value is dualstack.
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 ("/").
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 (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 (
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.
Use the TagResource action to tag a resource after it's created.
String ipAddressType
The IP address type for the load balancer.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
The default value is dualstack.
String tlsPolicyName
The name of the TLS policy to apply to the load balancer.
Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.
For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
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 (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 (*.example.com).
List<E> tags
The tag keys and optional values to add to the resource during create.
Use the TagResource action to tag a resource after it's created.
String relationalDatabaseName
The name to use for your new Lightsail database resource.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
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.
Use the TagResource action to tag a resource after it's created.
String relationalDatabaseName
The name to use for your new Lightsail database resource.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
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 meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).
Can't be a word reserved by the specified database engine.
For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.
PostgreSQL
The name of the database to create when the Lightsail database resource is created. If this parameter isn't
specified, a database named postgres is created in the database resource.
Constraints:
Must contain 1 to 63 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).
Can't be a word reserved by the specified database engine.
For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.
String masterUsername
The name for the master user.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers. Can contain underscores.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers. Can contain underscores.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.
String masterUserPassword
The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
MySQL
Constraints: Must contain from 8 to 41 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 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 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.
Use the TagResource action to tag a resource after it's created.
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.
Use the TagResource action to tag a resource after it's created.
String alarmName
The name of the alarm to delete.
String bucketName
The name of the bucket that the access key belongs to.
String accessKeyId
The ID of the access key to delete.
Use the GetBucketAccessKeys action to get a list of access key IDs that you can specify.
String bucketName
The name of the bucket to delete.
Use the GetBuckets action to get a list of bucket names that you can specify.
Boolean forceDelete
A Boolean value that indicates whether to force delete the bucket.
You must force delete the bucket if it has one of the following conditions:
The bucket is the origin of a distribution.
The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.
The bucket has objects.
The bucket has access keys.
Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.
String certificateName
The name of the certificate to delete.
Use the GetCertificates action to get a list of certificate names that you can specify.
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 serviceName
The name of the container service for which to delete a registered container image.
String image
The name of the container image to delete from the container service.
Use the GetContainerImages action to get the name of the container images that are registered to a
container service.
Container images sourced from your Lightsail container service, that are registered and stored on your service,
start with a colon (:). For example, :container-service-1.mystaticwebsite.1. Container
images sourced from a public registry like Docker Hub don't start with a colon. For example,
nginx:latest or nginx.
String serviceName
The name of the container service to delete.
String diskSnapshotName
The name of the disk snapshot you want to delete (my-disk-snapshot).
String distributionName
The name of the distribution to delete.
Use the GetDistributions action to get a list of distribution names that you can specify.
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 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.
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 distributionName
The name of the distribution from which to detach the certificate.
Use the GetDistributions action to get a list of distribution names that you can specify.
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 diskName
The unique name of the disk you want to detach from your instance (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 (Disk).
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer 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
(Discontinued) 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 discontinued, but still included in the response. Use isAttached instead.
Integer gbInUse
(Discontinued) 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 discontinued.
String autoMountStatus
The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
String name
The name of the disk snapshot (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 (DiskSnapshot).
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer 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 snapshot.
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 (32).
String bundleId
The ID of the bundle.
String name
The name of the distribution bundle.
Float price
The monthly price, in US dollars, of the bundle.
Integer transferPerMonthInGb
The monthly network transfer quota of the bundle.
Boolean isActive
Indicates whether the bundle is active, and can be specified for a new or existing distribution.
String code
The status code for the automated DNS record creation.
Following are the possible values:
SUCCEEDED - The validation records were successfully added to the domain.
STARTED - The automatic DNS record creation has started.
FAILED - The validation records failed to be added to the domain.
String message
The message that describes the reason for the status code.
String name
The name of the domain.
String arn
The Amazon Resource Name (ARN) of the domain recordset (
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 Amazon Lightsail Developer Guide.
List<E> domainEntries
An array of key-value pairs containing information about the domain entries.
RegisteredDomainDelegationInfo registeredDomainDelegationInfo
An object that describes the state of the Route 53 domain delegation to a Lightsail DNS zone.
String id
The ID of the domain recordset entry.
String name
The name of the domain.
String target
The target IP address (192.0.2.0), or AWS name server (ns-111.awsdns-22.com.).
For Lightsail load balancers, the value looks like
ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For Lightsail distributions,
the value looks like exampled1182ne.cloudfront.net. For Lightsail container services, the value
looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also set
isAlias to true when setting up an A record for a Lightsail load balancer,
distribution, or container service.
Boolean isAlias
When true, specifies whether the domain entry is an alias used by the Lightsail load balancer,
Lightsail container service, Lightsail content delivery network (CDN) distribution, or another Amazon Web
Services resource. You can include an alias (A type) record in your request, which points to the DNS name of a
load balancer, container service, CDN distribution, or other Amazon Web Services resource and routes traffic to
that resource.
String type
The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), 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
AAAA
CNAME
MX
NS
SOA
SRV
TXT
Map<K,V> options
(Discontinued) 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 discontinued.
String domainName
The domain name of the certificate validation record. For example, example.com or
www.example.com.
ResourceRecord resourceRecord
An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.
DnsRecordCreationState dnsRecordCreationState
An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.
String validationStatus
The validation status of the record.
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 containerName
The name of the container for the endpoint.
Integer containerPort
The port of the container to which traffic is forwarded to.
ContainerServiceHealthCheckConfig healthCheck
An object that describes the health check configuration of the container.
Double usageCost
The amount of cost or usage that's measured for the cost estimate.
String pricingUnit
The unit of measurement that's used for the cost estimate.
Double unit
The number of pricing units used to calculate the total number of hours. For example, 1 unit equals 1 hour.
String currency
The currency of the estimate in USD.
TimePeriod timePeriod
The period of time, in days, that an estimate covers. The period has a start date and an end date. The start date must come before the end date.
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 (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 (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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetActiveNames request and specify the next page
token using 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetAlarms request and specify the next page token
using 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 of the automatic snapshot. The possible values are Instance, and 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 that indicates whether to include inactive (unavailable) blueprints in the response of 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.
String appCategory
Returns a list of blueprints that are specific to Lightsail for Research.
You must use this parameter to view Lightsail for Research blueprints.
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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetBlueprints request and specify the next page
token using the pageToken parameter.
String bucketName
The name of the bucket for which to return access keys.
Boolean includeInactive
A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.
String bucketName
The name of the bucket for which to get metric data.
String metricName
The metric for which you want to return information.
Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
These bucket metrics are reported once per day.
BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated
by summing the size of all objects in the bucket (including object versions), including the size of all parts for
all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Maximum.
Unit: The published unit is Bytes.
NumberOfObjects - The total number of objects stored in a bucket. This value is calculated
by counting all objects in the bucket (including object versions) and the total number of parts for all
incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Average.
Unit: The published unit is Count.
Date startTime
The timestamp indicating the earliest data to be returned.
Date endTime
The timestamp indicating the latest data to be returned.
Integer period
The granularity, in seconds, of the returned data points.
Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.
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 - The sum of all values submitted for the matching metric. 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 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.
String bucketName
The name of the bucket for which to return information.
When omitted, the response includes all of your buckets in the Amazon Web Services Region where the request is made.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetBuckets 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.
Boolean includeConnectedResources
A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.
List<E> buckets
An array of objects that describe buckets.
String nextPageToken
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetBuckets request and specify the next page token
using the pageToken parameter.
AccountLevelBpaSync accountLevelBpaSync
An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.
For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.
Boolean includeInactive
A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of 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.
String appCategory
Returns a list of bundles that are specific to Lightsail for Research.
You must use this parameter to view Lightsail for Research bundles.
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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetBundles request and specify the next page token
using the pageToken parameter.
List<E> certificateStatuses
The status of the certificates for which to return information.
For example, specify ISSUED to return only certificates with an ISSUED status.
When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.
Boolean includeCertificateDetails
Indicates whether to include detailed information about the certificates in the response.
When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.
String certificateName
The name for the certificate for which to return information.
When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetCertificates 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> certificates
An object that describes certificates.
String nextPageToken
If NextPageToken is returned there are more results available. The value of
NextPageToken is a unique pagination token for each page. Make the call again using the returned
token to retrieve the next page. Keep all other arguments unchanged.
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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetCloudFormationStackRecords request and specify
the next page token using the pageToken parameter.
String serviceName
The name of the container service for which to return registered container images.
String serviceName
The name of the container service for which to get a container log.
String containerName
The name of the container that is either running or previously ran on the container service for which to return a log.
Date startTime
The start of the time interval for which to get log data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as
the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
Date endTime
The end of the time interval for which to get log data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as
the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
String filterPattern
The pattern to use to filter the returned log events to a specific term.
The following are a few examples of filter patterns that you can specify:
To return all log events, specify a filter pattern of "".
To exclude log events that contain the ERROR term, and return all other log events, specify a filter
pattern of "-ERROR".
To return log events that contain the ERROR term, specify a filter pattern of "ERROR".
To return log events that contain both the ERROR and Exception terms, specify a filter
pattern of "ERROR Exception".
To return log events that contain the ERROR or the Exception term, specify a
filter pattern of "?ERROR ?Exception".
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetContainerLog request. If your results are paginated, the
response will return a next page token that you can specify as the page token in a subsequent request.
List<E> logEvents
An array of objects that describe the log events of a container.
String nextPageToken
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetContainerLog request and specify the next page
token using the pageToken parameter.
String serviceName
The name of the container service for which to return deployments.
String serviceName
The name of the container service for which to get metric data.
String metricName
The metric for which you want to return information.
Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
CPUUtilization - The average percentage of compute units that are currently in use across all nodes
of the container service. This metric identifies the processing power required to run containers on each node of
the container service.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
MemoryUtilization - The average percentage of available memory that is currently in use across all
nodes of the container service. This metric identifies the memory required to run containers on each node of the
container service.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
Date startTime
The start time of the time period.
Date endTime
The end time of the time period.
Integer period
The granularity, in seconds, of the returned data points.
All container service metric data is available in 5-minute (300 seconds) granularity.
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 serviceName
The name of the container service for which to return information.
When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.
String resourceName
The resource name.
Date startTime
The cost estimate start time.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you want to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as
the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
Date endTime
The cost estimate end time.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you want to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as
the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
String diskName
The name of the disk (my-disk).
Disk disk
An object containing information about the disk.
String diskSnapshotName
The name of the disk snapshot (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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetDiskSnapshots request and specify the next page
token using 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetDisks request and specify the next page token
using the pageToken parameter.
String distributionName
The name of the distribution for which to return the timestamp of the last cache reset.
Use the GetDistributions action to get a list of distribution names that you can specify.
When omitted, the response includes the latest cache reset timestamp of all your distributions.
String distributionName
The name of the distribution for which to get metric data.
Use the GetDistributions action to get a list of distribution names that you can specify.
String metricName
The metric for which you want to return information.
Valid distribution metric names are listed below, along with the most useful statistics to include
in your request, and the published unit value.
Requests - The total number of viewer requests received by your Lightsail distribution, for
all HTTP methods, and for both HTTP and HTTPS requests.
Statistics: The most useful statistic is Sum.
Unit: The published unit is None.
BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS
requests.
Statistics: The most useful statistic is Sum.
Unit: The published unit is None.
BytesUploaded - The number of bytes uploaded to your origin by your Lightsail
distribution, using POST and PUT requests.
Statistics: The most useful statistic is Sum.
Unit: The published unit is None.
TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status
code was 4xx or 5xx.
Statistics: The most useful statistic is Average.
Unit: The published unit is Percent.
4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of
404 (Not Found) means that the client requested an object that could not be found.
Statistics: The most useful statistic is Average.
Unit: The published unit is Percent.
5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503
(Service Unavailable) means that the origin server is currently unavailable.
Statistics: The most useful statistic is Average.
Unit: The published unit is Percent.
Date startTime
The start of the time interval for which to get metric data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as
the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
Date endTime
The end of the time interval for which to get metric data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as
the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
Integer period
The granularity, in seconds, for the metric data points that will be returned.
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 distributionName
The name of the distribution for which to return information.
When omitted, the response includes all of your distributions in the Amazon Web Services Region where the request is made.
String pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetDistributions 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> distributions
An array of objects that describe your distributions.
String nextPageToken
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetDistributions 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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.
MetadataNoToken - Reports the number of times that the instance metadata service was
successfully accessed without a token. This metric determines if there are any processes accessing instance
metadata by using Instance Metadata Service Version 1, which doesn't use a token. If all requests use
token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.
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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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.
Boolean includeDefaultKeyPair
A Boolean value that indicates whether to include the default key pair in the response of your 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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 pageToken
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetLoadBalancerTlsPolicies 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> tlsPolicies
An array of objects that describe the TLS security policies that are available.
String nextPageToken
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetLoadBalancerTlsPolicies request and specify the
next page token using the pageToken parameter.
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
(Discontinued) 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 discontinued,
and the API returns the next page token parameter instead.
String nextPageToken
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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: 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 (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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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.
Boolean includeInactive
A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetRelationalDatabases request and specify the next
page token using the pageToken parameter.
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 GetSetupHistory 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> setupHistory
The historical information that's returned.
String nextPageToken
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetSetupHistory 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 results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetStaticIps request and specify the next page
token using the pageToken parameter.
String option
The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
all - Forward all headers to your origin.
none - Forward only the default headers.
allow-list - Forward only the headers you specify using the headersAllowList
parameter.
List<E> headersAllowList
The specific headers to forward to your distribution's origin.
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 of the origin resource.
String regionName
The AWS Region name of the origin resource.
String protocolPolicy
The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
Integer responseTimeout
The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
String name
The name the user gave the instance (Amazon_Linux-1GB-Ohio-1).
String arn
The Amazon Resource Name (ARN) of the instance (
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 (1479734909.17) in Unix time format.
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 Amazon Lightsail Developer Guide.
String blueprintId
The blueprint ID (os_amlinux_2016_03).
String blueprintName
The friendly name of the blueprint (Amazon Linux).
String bundleId
The bundle for the instance (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.
List<E> ipv6Addresses
The IPv6 addresses of the instance.
String ipAddressType
The IP address type of the instance.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
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 (running) for the instance.
String username
The user name for connecting to the instance (ec2-user).
String sshKeyName
The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).
InstanceMetadataOptions metadataOptions
The metadata options for the Amazon Lightsail instance.
String certKey
For SSH access, the public key to use when accessing your instance For OpenSSH clients (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.
List<E> ipv6Addresses
The IPv6 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 (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 (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. If this is
specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2.
INSTANCE - Use the configured firewall settings from the source Lightsail instance. If this is
specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the
source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then
IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is
configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2.
NONE - Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be
configured for the new instance that is created in Amazon EC2.
CLOSED - All ports closed. If this is specified, then only IPv4 will be configured for the new
instance that is created in Amazon EC2.
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.
String state
The state of the metadata option changes.
The following states are possible:
pending - The metadata options are being updated. The instance is not yet ready to process metadata
traffic with the new selection.
applied - The metadata options have been successfully applied to the instance.
String httpTokens
The state of token usage for your instance metadata requests.
If the state is optional, you can choose whether to retrieve instance metadata with a signed token
header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0
role credentials are returned.
If the state is required, you must send a signed token header with all instance metadata retrieval
requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The
version 1.0 credentials are not available.
Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken
instance metric to track the number of calls to the instance metadata service that are using version 1.0
credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.
String httpEndpoint
Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
If the value is disabled, you cannot access your instance metadata.
Integer httpPutResponseHopLimit
The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.
String httpProtocolIpv6
Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
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 IPv4 addresses. For example, specify 8 as the fromPort (ICMP
type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see
Control Messages
on Wikipedia.
ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort
(ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol
for IPv6.
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 IPv4 addresses. For example, specify 8 as the fromPort (ICMP
type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see
Control Messages
on Wikipedia.
ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort
(ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol
for IPv6.
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 IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.
The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
List<E> ipv6Cidrs
The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.
The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
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 IPv4 addresses. For example, specify 8 as the fromPort (ICMP
type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see
Control Messages
on Wikipedia.
ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort
(ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol
for IPv6.
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 IPv4 addresses. For example, specify 8 as the fromPort (ICMP
type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see
Control Messages
on Wikipedia.
ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort
(ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol
for IPv6.
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 IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.
The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
List<E> ipv6Cidrs
The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.
The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
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 (
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 (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 Amazon Lightsail Developer Guide.
String state
The state the snapshot is in.
String progress
The progress of the snapshot.
This is populated only for disk snapshots, and is null for instance snapshots.
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 (
arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
String fromBlueprintId
The blueprint ID from which you created the snapshot (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 (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 (micro_1_0).
String fromBlueprintId
The blueprint ID from which the source instance (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 (
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 (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 Amazon Lightsail Developer Guide.
String fingerprint
The RSA fingerprint of the key pair.
String name
The name of the distribution.
String arn
The Amazon Resource Name (ARN) of the distribution.
String supportCode
The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The timestamp when the distribution was created.
ResourceLocation location
An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.
Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and
distribute its content globally. However, all distributions are located in the us-east-1 Region.
String resourceType
The Lightsail resource type (Distribution).
List<E> alternativeDomainNames
The alternate domain names of the distribution.
String status
The status of the distribution.
Boolean isEnabled
Indicates whether the distribution is enabled.
String domainName
The domain name of the distribution.
String bundleId
The ID of the bundle currently applied to the distribution.
String certificateName
The name of the SSL/TLS certificate attached to the distribution, if any.
Origin origin
An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
The distribution pulls, caches, and serves content from the origin.
String originPublicDNS
The public DNS of the origin.
CacheBehavior defaultCacheBehavior
An object that describes the default cache behavior of the distribution.
CacheSettings cacheBehaviorSettings
An object that describes the cache behavior settings of the distribution.
List<E> cacheBehaviors
An array of objects that describe the per-path cache behavior of the distribution.
Boolean ableToUpdateBundle
Indicates whether the bundle that is currently applied to your distribution, specified using the
distributionName parameter, can be changed to another bundle.
Use the UpdateDistributionBundle action to change your distribution's bundle.
String ipAddressType
The IP address type of the distribution.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
String viewerMinimumTlsProtocolVersion
The minimum TLS protocol version that the distribution can use to communicate with viewers.
String name
The name of the load balancer (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 (us-east-2a). Lightsail automatically creates
your load balancer across Availability Zones.
String resourceType
The resource type (LoadBalancer.
List<E> tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer 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 ipAddressType
The IP address type of the load balancer.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
Boolean httpsRedirectionEnabled
A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
String tlsPolicyName
The name of the TLS security policy for the load balancer.
String name
The name of the SSL/TLS certificate (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 Amazon Web Services Region and Availability Zone where you created your certificate.
String resourceType
The resource type (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 Amazon Lightsail Developer 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 validation failure reason, if any, of the certificate.
The following failure reasons are possible:
NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available
for Lightsail certificates.
ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process
this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the
Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.
You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was
reported as an unsafe domain by VirusTotal. To correct the
problem, search for your domain name on the VirusTotal
website. If your domain is reported as suspicious, see Google Help for Hacked Websites to
learn what you can do.
If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not
valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a
certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all
domain names in the request are for valid top-level domains. For example, you cannot request a certificate for
example.invalidpublicdomain because invalidpublicdomain is not a valid top-level
domain.
OTHER - Typically, this failure occurs when there is a typographical error in one or more
of the domain names in the certificate request. Try to request a certificate again, correcting any spelling
errors or typos that were in the failed request.
Date issuedAt
The time when the SSL/TLS certificate was issued.
String issuer
The issuer of the certificate.
String keyAlgorithm
The algorithm 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 that describes the status of the certificate renewal managed by Lightsail.
String revocationReason
The reason the certificate was revoked. This value is present only when the certificate status is
REVOKED.
Date revokedAt
The timestamp when the certificate was revoked. This value is present only when the certificate status is
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
An array of strings that specify the alternate domains (example2.com) and subdomains (
blog.example.com) for the certificate.
String code
The status code for the automated DNS record creation.
Following are the possible values:
SUCCEEDED - The validation records were successfully added.
STARTED - The automatic DNS record creation has started.
FAILED - The validation record addition failed.
String message
The message that describes the reason for the status code.
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.
LoadBalancerTlsCertificateDnsRecordCreationState dnsRecordCreationState
An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of a domain to validate domain ownership.
String renewalStatus
The renewal status of the certificate.
The following renewal status are possible:
PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of
the certificate. No further action is required.
PendingValidation - Lightsail couldn't automatically validate one or more domain names of
the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check
to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate
remains in use.
Success - All domain names in the certificate are validated, and Lightsail renewed the
certificate. No further action is required.
Failed - One or more domain names were not validated before the certificate expired, and
Lightsail did not renew the certificate. You can request a new certificate using the
CreateCertificate action.
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 name
The name of the TLS security policy.
Boolean isDefault
A Boolean value that indicates whether the TLS security policy is the default.
String description
The description of the TLS security policy.
List<E> protocols
The protocols used in a given TLS security policy.
List<E> ciphers
The ciphers used by the TLS security policy.
The ciphers are listed in order of preference.
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).
String code
The status code for the name servers update.
Following are the possible values:
SUCCEEDED - The name server records were successfully updated.
PENDING - The name server record update is in progress.
FAILED - The name server record update failed.
STARTED - The automatic name server record update started.
String message
The message that describes the reason for the status code.
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 (1479816991.349).
ResourceLocation location
The Amazon Web Services Region and Availability Zone.
Boolean isTerminal
A Boolean value indicating whether the operation is terminal.
String operationDetails
Details about the operation (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 (1479816991.349).
String errorCode
The error code.
String errorDetails
The error details.
String name
The name of the origin resource.
String resourceType
The resource type of the origin resource (Instance).
String regionName
The AWS Region name of the origin resource.
String protocolPolicy
The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
Integer responseTimeout
The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
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 IPv4 addresses. For example, specify 8 as the fromPort (ICMP
type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see
Control Messages
on Wikipedia.
ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort
(ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol
for IPv6.
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 IPv4 addresses. For example, specify 8 as the fromPort (ICMP
type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see
Control Messages
on Wikipedia.
ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort
(ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol
for IPv6.
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 IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.
The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.
Examples:
To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.
To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
List<E> ipv6Cidrs
The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.
The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
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.
ContainerServiceECRImagePullerRole ecrImagePullerRole
An object that describes the activation status of the role that you can use to grant a Lightsail container service access to Amazon ECR private repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also listed.
ContainerServiceECRImagePullerRoleRequest ecrImagePullerRole
An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.
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 Amazon Web Services 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 Amazon Web Services 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.
Boolean option
Indicates whether the distribution forwards and caches based on query strings.
List<E> queryStringsAllowList
The specific query strings that the distribution forwards to the origin.
Your distribution will cache content based on the specified query strings.
If the option parameter is true, then your distribution forwards all query strings, regardless of
what you specify using the queryStringsAllowList parameter.
String code
The status code for the deletion state.
Following are the possible values:
SUCCEEDED - The hosted zone was successfully deleted.
PENDING - The hosted zone deletion is in progress.
FAILED - The hosted zone deletion failed.
STARTED - The hosted zone deletion started.
String message
The message that describes the reason for the status code.
String instanceName
The name of the instance to reboot.
String relationalDatabaseName
The name of your database to reboot.
String continentCode
The continent code (NA, meaning North America).
String description
The description of the Amazon Web Services Region (
This region is recommended to serve users in the eastern United States and eastern Canada).
String displayName
The display name (Ohio).
String name
The region name (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 serviceName
The name of the container service for which to register a container image.
String label
The label for the container image when it's registered to the container service.
Use a descriptive label that you can use to track the different versions of your registered container images.
Use the GetContainerImages action to return the container images registered to a Lightsail container
service. The label is the <imagelabel> portion of the following image name example:
:container-service-1.<imagelabel>.1
If the name of your container service is mycontainerservice, and the label that you specify is
mystaticwebsite, then the name of the registered container image will be
:mycontainerservice.mystaticwebsite.1.
The number at the end of these image name examples represents the version of the registered container image. If
you push and register another container image to the same Lightsail container service, with the same label, then
the version number for the new registered container image will be 2. If you push and register
another container image, the version number will be 3, and so on.
String digest
The digest of the container image to be registered.
ContainerImage containerImage
An object that describes a container image that is registered to a Lightsail container service
NameServersUpdateState nameServersUpdateState
An object that describes the state of the name server records that are automatically added to the Route 53 domain by Lightsail.
R53HostedZoneDeletionState r53HostedZoneDeletionState
Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone.
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 Amazon Lightsail Developer 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 Amazon Lightsail Developer 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.
List<E> domainValidationRecords
An array of objects that describe the domain validation records of the certificate.
String renewalStatus
The renewal status of the certificate.
The following renewal status are possible:
PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of
the certificate. No further action is required.
PendingValidation - Lightsail couldn't automatically validate one or more domain names of
the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check
to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate
remains in use.
Success - All domain names in the certificate are validated, and Lightsail renewed the
certificate. No further action is required.
Failed - One or more domain names were not validated before the certificate expired, and
Lightsail did not renew the certificate. You can request a new certificate using the
CreateCertificate action.
String renewalStatusReason
The reason for the renewal status of the certificate.
Date updatedAt
The timestamp when the certificate was last updated.
String distributionName
The name of the distribution for which to reset cache.
Use the GetDistributions action to get a list of distribution names that you can specify.
String status
The status of the reset cache request.
Date createTime
The timestamp of the reset cache request (1479734909.17) in Unix time format.
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 resource name.
String resourceType
The type of resource the budget will track.
List<E> costEstimates
The cost estimate for the specified budget.
Date startTime
The estimate start time.
Date endTime
The estimate end time.
String protocol
The protocol to verify, such as Email or SMS (text messaging).
String resourceType
The resource type.
The resource values are Distribution, Instance, and LoadBalancer.
Distribution-related APIs are available only in the N. Virginia (us-east-1) Amazon Web Services
Region. Set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit
distributions.
String resourceName
The name of the resource for which to set the IP address type.
String ipAddressType
The IP address type to set for the specified resource.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
String resourceName
The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state.
String bucketName
The name of the bucket for which to set access to another Lightsail resource.
String access
The access setting.
The following access settings are available:
allow - Allows access to the bucket and its objects.
deny - Denies access to the bucket and its objects. Use this setting to remove access for a resource
previously set to allow.
String command
The command that was executed.
Date dateTime
The timestamp for when the request was run.
String name
The name of the target resource.
String status
The status of the SetupInstanceHttps request.
String standardError
The text written by the command to stderr.
String standardOutput
The text written by the command to stdout.
String version
The current version of the script..
String operationId
A GUID that's used to identify the operation.
SetupRequest request
Information about the specified request.
SetupHistoryResource resource
The target resource name for the request.
List<E> executionDetails
Describes the full details of the request.
String status
The status of the request.
String name
The name of the Lightsail resource.
String arn
The Amazon Resource Name (ARN) of the Lightsail resource.
Date createdAt
The timestamp for when the resource was created.
ResourceLocation location
String resourceType
The Lightsail resource type. For example, Instance.
String instanceName
The name of the Lightsail instance.
String emailAddress
The contact method for SSL/TLS certificate renewal alerts. You can enter one email address.
List<E> domainNames
The name of the domain and subdomains that were specified for the SSL/TLS certificate.
String certificateProvider
The certificate authority that issues the SSL/TLS certificate.
String resourceName
The resource name.
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 (StaticIP-Ohio-EXAMPLE).
String arn
The Amazon Resource Name (ARN) of the static IP (
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 (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 (Amazon_Linux-1GB-Ohio-1).
Boolean isAttached
A Boolean value indicating whether the static IP is attached.
String resourceName
The resource name.
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.
Date start
The beginning of the time period. The start date is inclusive. For example, if start is
2017-01-01, Lightsail for Research retrieves cost and usage data starting at 2017-01-01
up to the end date. The start date must be equal to or no later than the current date to avoid a validation
error.
Date end
The end of the time period. The end date is exclusive. For example, if end is
2017-05-01, Lightsail for Research retrieves cost and usage data from the start date up to, but not
including, 2017-05-01.
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 bucketName
The name of the bucket for which to update the bundle.
String bundleId
The ID of the new bundle to apply to the bucket.
Use the GetBucketBundles action to get a list of bundle IDs that you can specify.
String bucketName
The name of the bucket to update.
AccessRules accessRules
An object that sets the public accessibility of objects in the specified bucket.
String versioning
Specifies whether to enable or suspend versioning of objects in the bucket.
The following options can be specified:
Enabled - Enables versioning of objects in the specified bucket.
Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are
retained.
List<E> readonlyAccessAccounts
An array of strings to specify the Amazon Web Services account IDs that can access the bucket.
You can give a maximum of 10 Amazon Web Services accounts access to a bucket.
BucketAccessLogConfig accessLogConfig
An object that describes the access log configuration for the bucket.
String serviceName
The name of the container service to update.
String power
The power for the container service.
The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The
power and scale of a container service makes up its configured capacity. To determine
the monthly price of your container service, multiply the base price of the power with the
scale (the number of nodes) of the service.
Use the GetContainerServicePowers action to view the specifications of each power option.
Integer scale
The scale for the container service.
The scale specifies the allocated compute nodes of the container service. The power and
scale of a container service makes up its configured capacity. To determine the monthly price of
your container service, multiply the base price of the power with the scale (the number
of nodes) of the service.
Boolean isDisabled
A Boolean value to indicate whether the container service is disabled.
Map<K,V> publicDomainNames
The public domain names to use with the container service, such as example.com and
www.example.com.
You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.
If you don't specify public domain names, then you can use the default domain of the container service.
You must create and validate an SSL/TLS certificate before you can use public domain names with your container
service. Use the CreateCertificate action to create a certificate for the public domain names you
want to use with your container service.
You can specify public domain names using a string to array map as shown in the example later on this page.
PrivateRegistryAccessRequest privateRegistryAccess
An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.
ContainerService containerService
An object that describes a container service.
String distributionName
The name of the distribution for which to update the bundle.
Use the GetDistributions action to get a list of distribution names that you can specify.
String bundleId
The bundle ID of the new bundle to apply to your distribution.
Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.
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 distributionName
The name of the distribution to update.
Use the GetDistributions action to get a list of distribution names that you can specify.
InputOrigin origin
An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.
The distribution pulls, caches, and serves content from the origin.
CacheBehavior defaultCacheBehavior
An object that describes the default cache behavior for the distribution.
CacheSettings cacheBehaviorSettings
An object that describes the cache behavior settings for the distribution.
The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your
distribution's existing settings.
List<E> cacheBehaviors
An array of objects that describe the per-path cache behavior for the distribution.
Boolean isEnabled
Indicates whether to enable the distribution.
String viewerMinimumTlsProtocolVersion
Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.
String certificateName
The name of the SSL/TLS certificate that you want to attach to the distribution.
Only certificates with a status of ISSUED can be attached to a distribution.
Use the GetCertificates action to get a list of certificate names that you can specify.
Boolean useDefaultCertificate
Indicates whether the default SSL/TLS certificate is attached to the distribution. The default value is
true. When true, the distribution uses the default domain name such as
d111111abcdef8.cloudfront.net.
Set this value to false to attach a new certificate to the distribution.
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 instanceName
The name of the instance for which to update metadata parameters.
String httpTokens
The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
the default state is optional.
If the state is optional, you can choose whether to retrieve instance metadata with a signed token
header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0
role credentials are returned.
If the state is required, you must send a signed token header with all instance metadata retrieval
requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The
version 1.0 credentials are not available.
String httpEndpoint
Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
If you specify a value of disabled, you cannot access your instance metadata.
Integer httpPutResponseHopLimit
The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.
String httpProtocolIpv6
Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.
This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (
eu-north-1).
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 the load balancer that you want to modify (my-load-balancer.
String attributeName
The name of the attribute you want to update.
String attributeValue
The value that you want to specify for the attribute name.
The following values are supported depending on what you specify for the attributeName request
parameter:
If you specify HealthCheckPath for the attributeName request parameter, then the
attributeValue request parameter must be the path to ping on the target (for example,
/weather/us/wa/seattle).
If you specify SessionStickinessEnabled for the attributeName request parameter, then
the attributeValue request parameter must be true to activate session stickiness or
false to deactivate session stickiness.
If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName request
parameter, then the attributeValue request parameter must be an interger that represents the cookie
duration in seconds.
If you specify HttpsRedirectionEnabled for the attributeName request parameter, then
the attributeValue request parameter must be true to activate HTTP to HTTPS redirection
or false to deactivate HTTP to HTTPS redirection.
If you specify TlsPolicyName for the attributeName request parameter, then the
attributeValue request parameter must be the name of the TLS policy.
Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.
String relationalDatabaseName
The name of your Lightsail database resource to update.
String masterUserPassword
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
MySQL
Constraints: Must contain from 8 to 41 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 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 Amazon Web Services 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.
String relationalDatabaseBlueprintId
This parameter is used to update the major version of the database. Enter the blueprintId for the
major version that you want to update to.
Use the GetRelationalDatabaseBlueprints action to get a list of available blueprint IDs.
Copyright © 2024. All rights reserved.