Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).
For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.
To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.
", "operations": { "AllocateStaticIp": "Allocates a static IP address.
", "AttachDisk": "Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
", "AttachInstancesToLoadBalancer": "Attaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
", "AttachLoadBalancerTlsCertificate": "Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.
Attaches a static IP address to a specific Amazon Lightsail instance.
", "CloseInstancePublicPorts": "Closes the public ports on a specific Amazon Lightsail instance.
", "CreateDisk": "Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
", "CreateDomain": "Creates a domain resource for the specified domain (e.g., example.com).
", "CreateDomainEntry": "Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
", "CreateInstanceSnapshot": "Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
", "CreateInstances": "Creates one or more Amazon Lightsail virtual private servers, or instances. Create instances using active blueprints. 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. Use the get blueprints operation to return a list of available blueprints.
", "CreateInstancesFromSnapshot": "Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
", "CreateKeyPair": "Creates an SSH key pair.
", "CreateLoadBalancer": "Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.
Creates a Lightsail load balancer TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
", "CreateRelationalDatabase": "Creates a new database in Amazon Lightsail.
", "CreateRelationalDatabaseFromSnapshot": "Creates a new database from an existing database snapshot in Amazon Lightsail.
You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.
", "CreateRelationalDatabaseSnapshot": "Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.
", "DeleteDisk": "Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance).
The disk may remain in the deleting state for several minutes.
Deletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
", "DeleteDomain": "Deletes the specified domain recordset and all of its domain records.
", "DeleteDomainEntry": "Deletes a specific domain entry.
", "DeleteInstance": "Deletes a specific Amazon Lightsail virtual private server, or instance.
", "DeleteInstanceSnapshot": "Deletes a specific snapshot of a virtual private server (or instance).
", "DeleteKeyPair": "Deletes a specific SSH key pair.
", "DeleteLoadBalancer": "Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.
", "DeleteLoadBalancerTlsCertificate": "Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
", "DeleteRelationalDatabase": "Deletes a database in Amazon Lightsail.
", "DeleteRelationalDatabaseSnapshot": "Deletes a database snapshot in Amazon Lightsail.
", "DetachDisk": "Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
", "DetachInstancesFromLoadBalancer": "Detaches the specified instances from a Lightsail load balancer.
This operation waits until the instances are no longer needed before they are detached from the load balancer.
", "DetachStaticIp": "Detaches a static IP from the Amazon Lightsail instance to which it is attached.
", "DownloadDefaultKeyPair": "Downloads the default SSH key pair from the user's account.
", "GetActiveNames": "Returns the names of all active (not deleted) resources.
", "GetBlueprints": "Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
", "GetBundles": "Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
", "GetDisk": "Returns information about a specific block storage disk.
", "GetDiskSnapshot": "Returns information about a specific block storage disk snapshot.
", "GetDiskSnapshots": "Returns information about all block storage disk snapshots in your AWS account and region.
If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
", "GetDisks": "Returns information about all block storage disks in your AWS account and region.
If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
", "GetDomain": "Returns information about a specific domain recordset.
", "GetDomains": "Returns a list of all domains in the user's account.
", "GetInstance": "Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
", "GetInstanceAccessDetails": "Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
", "GetInstanceMetricData": "Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
", "GetInstancePortStates": "Returns the port states for a specific virtual private server, or instance.
", "GetInstanceSnapshot": "Returns information about a specific instance snapshot.
", "GetInstanceSnapshots": "Returns all instance snapshots for the user's account.
", "GetInstanceState": "Returns the state of a specific instance. Works on one instance at a time.
", "GetInstances": "Returns information about all Amazon Lightsail virtual private servers, or instances.
", "GetKeyPair": "Returns information about a specific key pair.
", "GetKeyPairs": "Returns information about all key pairs in the user's account.
", "GetLoadBalancer": "Returns information about the specified Lightsail load balancer.
", "GetLoadBalancerMetricData": "Returns information about health metrics for your Lightsail load balancer.
", "GetLoadBalancerTlsCertificates": "Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
", "GetLoadBalancers": "Returns information about all load balancers in an account.
If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
", "GetOperation": "Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
", "GetOperations": "Returns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.
Gets operations for a specific resource (e.g., an instance or a static IP).
", "GetRegions": "Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.
Returns information about a specific database in Amazon Lightsail.
", "GetRelationalDatabaseBlueprints": "Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
You can use a blueprint ID to create a new database that runs a specific database engine.
", "GetRelationalDatabaseBundles": "Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
You can use a bundle ID to create a new database with explicit performance specifications.
", "GetRelationalDatabaseEvents": "Returns a list of events for a specific database in Amazon Lightsail.
", "GetRelationalDatabaseLogEvents": "Returns a list of log events for a database in Amazon Lightsail.
", "GetRelationalDatabaseLogStreams": "Returns a list of available log streams for a specific database in Amazon Lightsail.
", "GetRelationalDatabaseMasterUserPassword": "Returns the current, previous, or pending versions of the master user password for a Lightsail database.
", "GetRelationalDatabaseMetricData": "Returns the data points of the specified metric for a database in Amazon Lightsail.
", "GetRelationalDatabaseParameters": "Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
", "GetRelationalDatabaseSnapshot": "Returns information about a specific database snapshot in Amazon Lightsail.
", "GetRelationalDatabaseSnapshots": "Returns information about all of your database snapshots in Amazon Lightsail.
", "GetRelationalDatabases": "Returns information about all of your databases in Amazon Lightsail.
", "GetStaticIp": "Returns information about a specific static IP.
", "GetStaticIps": "Returns information about all static IPs in the user's account.
", "ImportKeyPair": "Imports a public SSH key from a specific key pair.
", "IsVpcPeered": "Returns a Boolean value indicating whether your Lightsail VPC is peered.
", "OpenInstancePublicPorts": "Adds public ports to an Amazon Lightsail instance.
", "PeerVpc": "Tries to peer the Lightsail VPC with the user's default VPC.
", "PutInstancePublicPorts": "Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
", "RebootInstance": "Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.
", "RebootRelationalDatabase": "Restarts a specific database in Amazon Lightsail.
", "ReleaseStaticIp": "Deletes a specific static IP from your account.
", "StartInstance": "Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
", "StartRelationalDatabase": "Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.
Stops a specific Amazon Lightsail instance that is currently running.
", "StopRelationalDatabase": "Stops a specific database that is currently running in Amazon Lightsail.
", "UnpeerVpc": "Attempts to unpeer the Lightsail VPC from the user's default VPC.
", "UpdateDomainEntry": "Updates a domain recordset after it is created.
", "UpdateLoadBalancerAttribute": "Updates the specified attribute for a load balancer. You can only update one attribute at a time.
", "UpdateRelationalDatabase": "Allows the update of one or more attributes of a database in Amazon Lightsail.
Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.
", "UpdateRelationalDatabaseParameters": "Allows the update of one or more parameters of a database in Amazon Lightsail.
Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which paramater updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation.
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
", "refs": { } }, "AccessDirection": { "base": null, "refs": { "InstancePortInfo$accessDirection": "The access direction (inbound or outbound).
Lightsail throws this exception when an account is still in the setup in progress state.
", "refs": { } }, "AllocateStaticIpRequest": { "base": null, "refs": { } }, "AllocateStaticIpResult": { "base": null, "refs": { } }, "AttachDiskRequest": { "base": null, "refs": { } }, "AttachDiskResult": { "base": null, "refs": { } }, "AttachInstancesToLoadBalancerRequest": { "base": null, "refs": { } }, "AttachInstancesToLoadBalancerResult": { "base": null, "refs": { } }, "AttachLoadBalancerTlsCertificateRequest": { "base": null, "refs": { } }, "AttachLoadBalancerTlsCertificateResult": { "base": null, "refs": { } }, "AttachStaticIpRequest": { "base": null, "refs": { } }, "AttachStaticIpResult": { "base": null, "refs": { } }, "AttachedDiskMap": { "base": null, "refs": { "CreateInstancesFromSnapshotRequest$attachedDiskMapping": "An object containing information about one or more disk mappings.
" } }, "AvailabilityZone": { "base": "Describes an Availability Zone.
", "refs": { "AvailabilityZoneList$member": null } }, "AvailabilityZoneList": { "base": null, "refs": { "Region$availabilityZones": "The Availability Zones. Follows the format us-east-2a (case-sensitive).
The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).
A base64-encoded public key of the ssh-rsa type.
A base64-encoded RSA private key.
", "DownloadDefaultKeyPairResult$publicKeyBase64": "A base64-encoded public key of the ssh-rsa type.
A base64-encoded RSA private key.
", "ImportKeyPairRequest$publicKeyBase64": "A base64-encoded public key of the ssh-rsa type.
The RSA fingerprint of the key pair.
" } }, "Blueprint": { "base": "Describes a blueprint (a virtual private server image).
", "refs": { "BlueprintList$member": null } }, "BlueprintList": { "base": null, "refs": { "GetBlueprintsResult$blueprints": "An array of key-value pairs that contains information about the available blueprints.
" } }, "BlueprintType": { "base": null, "refs": { "Blueprint$type": "The type of the blueprint (e.g., os or app).
Describes a bundle, which is a set of specs describing your virtual private server (or instance).
", "refs": { "BundleList$member": null } }, "BundleList": { "base": null, "refs": { "GetBundlesResult$bundles": "An array of key-value pairs that contains information about the available bundles.
" } }, "CloseInstancePublicPortsRequest": { "base": null, "refs": { } }, "CloseInstancePublicPortsResult": { "base": null, "refs": { } }, "CreateDiskFromSnapshotRequest": { "base": null, "refs": { } }, "CreateDiskFromSnapshotResult": { "base": null, "refs": { } }, "CreateDiskRequest": { "base": null, "refs": { } }, "CreateDiskResult": { "base": null, "refs": { } }, "CreateDiskSnapshotRequest": { "base": null, "refs": { } }, "CreateDiskSnapshotResult": { "base": null, "refs": { } }, "CreateDomainEntryRequest": { "base": null, "refs": { } }, "CreateDomainEntryResult": { "base": null, "refs": { } }, "CreateDomainRequest": { "base": null, "refs": { } }, "CreateDomainResult": { "base": null, "refs": { } }, "CreateInstanceSnapshotRequest": { "base": null, "refs": { } }, "CreateInstanceSnapshotResult": { "base": null, "refs": { } }, "CreateInstancesFromSnapshotRequest": { "base": null, "refs": { } }, "CreateInstancesFromSnapshotResult": { "base": null, "refs": { } }, "CreateInstancesRequest": { "base": null, "refs": { } }, "CreateInstancesResult": { "base": null, "refs": { } }, "CreateKeyPairRequest": { "base": null, "refs": { } }, "CreateKeyPairResult": { "base": null, "refs": { } }, "CreateLoadBalancerRequest": { "base": null, "refs": { } }, "CreateLoadBalancerResult": { "base": null, "refs": { } }, "CreateLoadBalancerTlsCertificateRequest": { "base": null, "refs": { } }, "CreateLoadBalancerTlsCertificateResult": { "base": null, "refs": { } }, "CreateRelationalDatabaseFromSnapshotRequest": { "base": null, "refs": { } }, "CreateRelationalDatabaseFromSnapshotResult": { "base": null, "refs": { } }, "CreateRelationalDatabaseRequest": { "base": null, "refs": { } }, "CreateRelationalDatabaseResult": { "base": null, "refs": { } }, "CreateRelationalDatabaseSnapshotRequest": { "base": null, "refs": { } }, "CreateRelationalDatabaseSnapshotResult": { "base": null, "refs": { } }, "DeleteDiskRequest": { "base": null, "refs": { } }, "DeleteDiskResult": { "base": null, "refs": { } }, "DeleteDiskSnapshotRequest": { "base": null, "refs": { } }, "DeleteDiskSnapshotResult": { "base": null, "refs": { } }, "DeleteDomainEntryRequest": { "base": null, "refs": { } }, "DeleteDomainEntryResult": { "base": null, "refs": { } }, "DeleteDomainRequest": { "base": null, "refs": { } }, "DeleteDomainResult": { "base": null, "refs": { } }, "DeleteInstanceRequest": { "base": null, "refs": { } }, "DeleteInstanceResult": { "base": null, "refs": { } }, "DeleteInstanceSnapshotRequest": { "base": null, "refs": { } }, "DeleteInstanceSnapshotResult": { "base": null, "refs": { } }, "DeleteKeyPairRequest": { "base": null, "refs": { } }, "DeleteKeyPairResult": { "base": null, "refs": { } }, "DeleteLoadBalancerRequest": { "base": null, "refs": { } }, "DeleteLoadBalancerResult": { "base": null, "refs": { } }, "DeleteLoadBalancerTlsCertificateRequest": { "base": null, "refs": { } }, "DeleteLoadBalancerTlsCertificateResult": { "base": null, "refs": { } }, "DeleteRelationalDatabaseRequest": { "base": null, "refs": { } }, "DeleteRelationalDatabaseResult": { "base": null, "refs": { } }, "DeleteRelationalDatabaseSnapshotRequest": { "base": null, "refs": { } }, "DeleteRelationalDatabaseSnapshotResult": { "base": null, "refs": { } }, "DetachDiskRequest": { "base": null, "refs": { } }, "DetachDiskResult": { "base": null, "refs": { } }, "DetachInstancesFromLoadBalancerRequest": { "base": null, "refs": { } }, "DetachInstancesFromLoadBalancerResult": { "base": null, "refs": { } }, "DetachStaticIpRequest": { "base": null, "refs": { } }, "DetachStaticIpResult": { "base": null, "refs": { } }, "Disk": { "base": "Describes a system disk or an block storage disk.
", "refs": { "DiskList$member": null, "GetDiskResult$disk": "An object containing information about the disk.
" } }, "DiskList": { "base": null, "refs": { "GetDisksResult$disks": "An array of objects containing information about all block storage disks.
", "InstanceHardware$disks": "The disks attached to the instance.
", "InstanceSnapshot$fromAttachedDisks": "An array of disk objects containing information about all block storage disks.
" } }, "DiskMap": { "base": "Describes a block storage disk mapping.
", "refs": { "DiskMapList$member": null } }, "DiskMapList": { "base": null, "refs": { "AttachedDiskMap$value": null } }, "DiskSnapshot": { "base": "Describes a block storage disk snapshot.
", "refs": { "DiskSnapshotList$member": null, "GetDiskSnapshotResult$diskSnapshot": "An object containing information about the disk snapshot.
" } }, "DiskSnapshotList": { "base": null, "refs": { "GetDiskSnapshotsResult$diskSnapshots": "An array of objects containing information about all block storage disk snapshots.
" } }, "DiskSnapshotState": { "base": null, "refs": { "DiskSnapshot$state": "The status of the disk snapshot operation.
" } }, "DiskState": { "base": null, "refs": { "Disk$state": "Describes the status of the disk.
" } }, "Domain": { "base": "Describes a domain where you are storing recordsets in Lightsail.
", "refs": { "DomainList$member": null, "GetDomainResult$domain": "An array of key-value pairs containing information about your get domain request.
" } }, "DomainEntry": { "base": "Describes a domain recordset entry.
", "refs": { "CreateDomainEntryRequest$domainEntry": "An array of key-value pairs containing information about the domain entry request.
", "DeleteDomainEntryRequest$domainEntry": "An array of key-value pairs containing information about your domain entries.
", "DomainEntryList$member": null, "UpdateDomainEntryRequest$domainEntry": "An array of key-value pairs containing information about the domain entry.
" } }, "DomainEntryList": { "base": null, "refs": { "Domain$domainEntries": "An array of key-value pairs containing information about the domain entries.
" } }, "DomainEntryOptions": { "base": null, "refs": { "DomainEntry$options": "(Deprecated) The options for the domain entry.
In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
The type of domain entry (e.g., SOA or NS).
An array of key-value pairs containing information about each of the domain entries in the user's account.
" } }, "DomainName": { "base": null, "refs": { "CreateDomainEntryRequest$domainName": "The domain name (e.g., example.com) for which you want to create the domain entry.
The domain name to manage (e.g., example.com).
You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.
The domain name with which your certificate is associated (e.g., example.com).
If you specify certificateDomainName, then certificateName is required (and vice-versa).
The domain name (e.g., example.com) for your SSL/TLS certificate.
The name of the domain entry to delete.
", "DeleteDomainRequest$domainName": "The specific domain name to delete.
", "DomainEntry$name": "The name of the domain.
", "DomainNameList$member": null, "GetDomainRequest$domainName": "The domain name for which your want to return information about.
", "LoadBalancerTlsCertificate$domainName": "The domain name for your SSL/TLS certificate.
", "LoadBalancerTlsCertificateDomainValidationOption$domainName": "The fully qualified domain name in the certificate request.
", "LoadBalancerTlsCertificateDomainValidationRecord$domainName": "The domain name against which your SSL/TLS certificate was validated.
", "UpdateDomainEntryRequest$domainName": "The name of the domain recordset to update.
" } }, "DomainNameList": { "base": null, "refs": { "CreateLoadBalancerRequest$certificateAlternativeNames": "The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com).
An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., *.example.com).
Describes an instance (a virtual private server).
", "refs": { "GetInstanceResult$instance": "An array of key-value pairs containing information about the specified instance.
", "InstanceList$member": null } }, "InstanceAccessDetails": { "base": "The parameters for gaining temporary access to one of your Amazon Lightsail instances.
", "refs": { "GetInstanceAccessDetailsResult$accessDetails": "An array of key-value pairs containing information about a get instance access request.
" } }, "InstanceAccessProtocol": { "base": null, "refs": { "GetInstanceAccessDetailsRequest$protocol": "The protocol to use to connect to your instance. Defaults to ssh.
The protocol for these Amazon Lightsail instance access details.
" } }, "InstanceHardware": { "base": "Describes the hardware for the instance.
", "refs": { "Instance$hardware": "The size of the vCPU and the amount of RAM for the instance.
" } }, "InstanceHealthReason": { "base": null, "refs": { "InstanceHealthSummary$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.
Describes the overall instance health. Valid values are below.
" } }, "InstanceHealthSummary": { "base": "Describes information about the health of the instance.
", "refs": { "InstanceHealthSummaryList$member": null } }, "InstanceHealthSummaryList": { "base": null, "refs": { "LoadBalancer$instanceHealthSummary": "An array of InstanceHealthSummary objects describing the health of the load balancer.
" } }, "InstanceList": { "base": null, "refs": { "GetInstancesResult$instances": "An array of key-value pairs containing information about your instances.
" } }, "InstanceMetricName": { "base": null, "refs": { "GetInstanceMetricDataRequest$metricName": "The metric name to get data about.
", "GetInstanceMetricDataResult$metricName": "The metric name to return data for.
" } }, "InstanceNetworking": { "base": "Describes monthly data transfer rates and port information for an instance.
", "refs": { "Instance$networking": "Information about the public ports and monthly data transfer rates for the instance.
" } }, "InstancePlatform": { "base": null, "refs": { "Blueprint$platform": "The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
", "InstancePlatformList$member": null } }, "InstancePlatformList": { "base": null, "refs": { "Bundle$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.
Describes information about the instance ports.
", "refs": { "InstancePortInfoList$member": null } }, "InstancePortInfoList": { "base": null, "refs": { "InstanceNetworking$ports": "An array of key-value pairs containing information about the ports on the instance.
" } }, "InstancePortState": { "base": "Describes the port state.
", "refs": { "InstancePortStateList$member": null } }, "InstancePortStateList": { "base": null, "refs": { "GetInstancePortStatesResult$portStates": "Information about the port states resulting from your request.
" } }, "InstanceSnapshot": { "base": "Describes the snapshot of the virtual private server, or instance.
", "refs": { "GetInstanceSnapshotResult$instanceSnapshot": "An array of key-value pairs containing information about the results of your get instance snapshot request.
", "InstanceSnapshotList$member": null } }, "InstanceSnapshotList": { "base": null, "refs": { "GetInstanceSnapshotsResult$instanceSnapshots": "An array of key-value pairs containing information about the results of your get instance snapshots request.
" } }, "InstanceSnapshotState": { "base": null, "refs": { "InstanceSnapshot$state": "The state the snapshot is in.
" } }, "InstanceState": { "base": "Describes the virtual private server (or instance) status.
", "refs": { "GetInstanceStateResult$state": "The state of the instance.
", "Instance$state": "The status code and the state (e.g., running) for the instance.
Lightsail throws this exception when user input does not conform to the validation rules of an input field.
Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
The private IP address of the instance.
", "Instance$publicIpAddress": "The public IP address of the instance.
", "InstanceAccessDetails$ipAddress": "The public IP address of the Amazon Lightsail instance.
", "StaticIp$ipAddress": "The static IP address.
" } }, "IpV6Address": { "base": null, "refs": { "Instance$ipv6Address": "The IPv6 address of the instance.
" } }, "IsVpcPeeredRequest": { "base": null, "refs": { } }, "IsVpcPeeredResult": { "base": null, "refs": { } }, "IsoDate": { "base": null, "refs": { "CreateRelationalDatabaseFromSnapshotRequest$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 Universal Coordinated 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.
The date when the disk was created.
", "DiskSnapshot$createdAt": "The date when the disk snapshot was created.
", "Domain$createdAt": "The date when the domain recordset was created.
", "GetRelationalDatabaseLogEventsRequest$startTime": "The start of the time interval from which to get log events.
Constraints:
Specified in Universal Coordinated 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.
The end of the time interval from which to get log events.
Constraints:
Specified in Universal Coordinated 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.
The timestamp when the specified version of the master user password was created.
", "GetRelationalDatabaseMetricDataRequest$startTime": "The start of the time interval from which to get metric data.
Constraints:
Specified in Universal Coordinated 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.
The end of the time interval from which to get metric data.
Constraints:
Specified in Universal Coordinated 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.
The timestamp when the instance was created (e.g., 1479734909.17).
For SSH access, the date on which the temporary keys expire.
", "InstanceSnapshot$createdAt": "The timestamp when the snapshot was created (e.g., 1479907467.024).
The timestamp when the key pair was created (e.g., 1479816991.349).
The date when your load balancer was created.
", "LoadBalancerTlsCertificate$createdAt": "The time when you created your SSL/TLS certificate.
", "LoadBalancerTlsCertificate$issuedAt": "The time when the SSL/TLS certificate was issued.
", "LoadBalancerTlsCertificate$notAfter": "The timestamp when the SSL/TLS certificate expires.
", "LoadBalancerTlsCertificate$notBefore": "The timestamp when the SSL/TLS certificate is first valid.
", "LoadBalancerTlsCertificate$revokedAt": "The timestamp when the SSL/TLS certificate was revoked.
", "LogEvent$createdAt": "The timestamp when the database log event was created.
", "Operation$createdAt": "The timestamp when the operation was initialized (e.g., 1479816991.349).
The timestamp when the status was changed (e.g., 1479816991.349).
The effective date of the pending database maintenance action.
", "RelationalDatabase$createdAt": "The timestamp when the database was created. Formatted in Unix time.
", "RelationalDatabase$latestRestorableTime": "The latest point in time to which the database can be restored. Formatted in Unix time.
", "RelationalDatabaseEvent$createdAt": "The timestamp when the database event was created.
", "RelationalDatabaseSnapshot$createdAt": "The timestamp when the database snapshot was created.
", "StaticIp$createdAt": "The timestamp when the static IP was created (e.g., 1479735304.222).
Describes the SSH key pair.
", "refs": { "CreateKeyPairResult$keyPair": "An array of key-value pairs containing information about the new key pair you just created.
", "GetKeyPairResult$keyPair": "An array of key-value pairs containing information about the key pair.
", "KeyPairList$member": null } }, "KeyPairList": { "base": null, "refs": { "GetKeyPairsResult$keyPairs": "An array of key-value pairs containing information about the key pairs.
" } }, "LoadBalancer": { "base": "Describes the Lightsail load balancer.
", "refs": { "GetLoadBalancerResult$loadBalancer": "An object containing information about your load balancer.
", "LoadBalancerList$member": null } }, "LoadBalancerAttributeName": { "base": null, "refs": { "LoadBalancerConfigurationOptions$key": null, "UpdateLoadBalancerAttributeRequest$attributeName": "The name of the attribute you want to update. Valid values are below.
" } }, "LoadBalancerConfigurationOptions": { "base": null, "refs": { "LoadBalancer$configurationOptions": "A string to string map of the configuration options for your load balancer. Valid values are listed below.
" } }, "LoadBalancerList": { "base": null, "refs": { "GetLoadBalancersResult$loadBalancers": "An array of LoadBalancer objects describing your load balancers.
" } }, "LoadBalancerMetricName": { "base": null, "refs": { "GetLoadBalancerMetricDataRequest$metricName": "The metric about which you want to return information. Valid values are listed below, along with the most useful statistics to include in your request.
ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.
Statistics: The most useful statistic is Sum.
HealthyHostCount - The number of target instances that are considered healthy.
Statistics: The most useful statistic are Average, Minimum, and Maximum.
UnhealthyHostCount - The number of target instances that are considered unhealthy.
Statistics: The most useful statistic are Average, Minimum, and Maximum.
HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1.
HTTPCode_Instance_2XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
HTTPCode_Instance_3XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
HTTPCode_Instance_4XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
HTTPCode_Instance_5XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.
Statistics: The most useful statistic is Average.
RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.
Statistics: The most useful statistic is Sum.
RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics to include in your request.
ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.
Statistics: The most useful statistic is Sum.
HealthyHostCount - The number of target instances that are considered healthy.
Statistics: The most useful statistic are Average, Minimum, and Maximum.
UnhealthyHostCount - The number of target instances that are considered unhealthy.
Statistics: The most useful statistic are Average, Minimum, and Maximum.
HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1.
HTTPCode_Instance_2XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
HTTPCode_Instance_3XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
HTTPCode_Instance_4XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
HTTPCode_Instance_5XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.
Statistics: The most useful statistic is Average.
RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.
Statistics: The most useful statistic is Sum.
RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.
Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
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.
The status of your load balancer. Valid values are below.
" } }, "LoadBalancerTlsCertificate": { "base": "Describes a load balancer SSL/TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
", "refs": { "LoadBalancerTlsCertificateList$member": null } }, "LoadBalancerTlsCertificateDomainStatus": { "base": null, "refs": { "LoadBalancerTlsCertificateDomainValidationOption$validationStatus": "The status of the domain validation. Valid values are listed below.
", "LoadBalancerTlsCertificateDomainValidationRecord$validationStatus": "The validation status. Valid values are listed below.
" } }, "LoadBalancerTlsCertificateDomainValidationOption": { "base": "Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.
", "refs": { "LoadBalancerTlsCertificateDomainValidationOptionList$member": null } }, "LoadBalancerTlsCertificateDomainValidationOptionList": { "base": null, "refs": { "LoadBalancerTlsCertificateRenewalSummary$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.
" } }, "LoadBalancerTlsCertificateDomainValidationRecord": { "base": "Describes the validation record of each domain name in the SSL/TLS certificate.
", "refs": { "LoadBalancerTlsCertificateDomainValidationRecordList$member": null } }, "LoadBalancerTlsCertificateDomainValidationRecordList": { "base": null, "refs": { "LoadBalancerTlsCertificate$domainValidationRecords": "An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
" } }, "LoadBalancerTlsCertificateFailureReason": { "base": null, "refs": { "LoadBalancerTlsCertificate$failureReason": "The reason for the SSL/TLS certificate validation failure.
" } }, "LoadBalancerTlsCertificateList": { "base": null, "refs": { "GetLoadBalancerTlsCertificatesResult$tlsCertificates": "An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.
" } }, "LoadBalancerTlsCertificateRenewalStatus": { "base": null, "refs": { "LoadBalancerTlsCertificateRenewalSummary$renewalStatus": "The status of Lightsail's managed renewal of the certificate. Valid values are listed below.
" } }, "LoadBalancerTlsCertificateRenewalSummary": { "base": "Contains information about the status of Lightsail's managed renewal for the certificate.
", "refs": { "LoadBalancerTlsCertificate$renewalSummary": "An object containing information about the status of Lightsail's managed renewal for the certificate.
" } }, "LoadBalancerTlsCertificateRevocationReason": { "base": null, "refs": { "LoadBalancerTlsCertificate$revocationReason": "The reason the certificate was revoked. Valid values are below.
" } }, "LoadBalancerTlsCertificateStatus": { "base": null, "refs": { "LoadBalancerTlsCertificate$status": "The status of the SSL/TLS certificate. Valid values are below.
" } }, "LoadBalancerTlsCertificateSummary": { "base": "Provides a summary of SSL/TLS certificate metadata.
", "refs": { "LoadBalancerTlsCertificateSummaryList$member": null } }, "LoadBalancerTlsCertificateSummaryList": { "base": null, "refs": { "LoadBalancer$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.
Describes a database log event.
", "refs": { "LogEventList$member": null } }, "LogEventList": { "base": null, "refs": { "GetRelationalDatabaseLogEventsResult$resourceLogEvents": "An object describing the result of your get relational database log events request.
" } }, "MetricDatapoint": { "base": "Describes the metric data point.
", "refs": { "MetricDatapointList$member": null } }, "MetricDatapointList": { "base": null, "refs": { "GetInstanceMetricDataResult$metricData": "An array of key-value pairs containing information about the results of your get instance metric data request.
", "GetLoadBalancerMetricDataResult$metricData": "An array of metric datapoint objects.
", "GetRelationalDatabaseMetricDataResult$metricData": "An object describing the result of your get relational database metric data request.
" } }, "MetricPeriod": { "base": null, "refs": { "GetInstanceMetricDataRequest$period": "The granularity, in seconds, of the returned data points.
", "GetLoadBalancerMetricDataRequest$period": "The granularity, in seconds, of the returned data points.
", "GetRelationalDatabaseMetricDataRequest$period": "The granularity, in seconds, of the returned data points.
" } }, "MetricStatistic": { "base": null, "refs": { "MetricStatisticList$member": null } }, "MetricStatisticList": { "base": null, "refs": { "GetInstanceMetricDataRequest$statistics": "The instance statistics.
", "GetLoadBalancerMetricDataRequest$statistics": "An array of statistics that you want to request metrics for. Valid values are listed below.
SampleCount - The count (number) of data points used for the statistical calculation.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed.
Sum - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.
Minimum - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.
Maximum - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.
The array of statistics for your metric data request.
" } }, "MetricUnit": { "base": null, "refs": { "GetInstanceMetricDataRequest$unit": "The unit. The list of valid values is below.
", "GetLoadBalancerMetricDataRequest$unit": "The unit for the time period request. Valid values are listed below.
", "GetRelationalDatabaseMetricDataRequest$unit": "The unit for the metric data request.
", "MetricDatapoint$unit": "The unit.
" } }, "MonthlyTransfer": { "base": "Describes the monthly data transfer in and out of your virtual private server (or instance).
", "refs": { "InstanceNetworking$monthlyTransfer": "The amount of data in GB allocated for monthly data transfers.
" } }, "NetworkProtocol": { "base": null, "refs": { "InstancePortInfo$protocol": "The protocol being used. 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.
The protocol being used. 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.
The protocol.
" } }, "NonEmptyString": { "base": null, "refs": { "AttachDiskRequest$diskPath": "The disk path to expose to the instance (e.g., /dev/xvdf).
The name of the Availability Zone. The format is us-east-2a (case-sensitive).
The state of the Availability Zone.
", "Blueprint$blueprintId": "The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
The group name of the blueprint (e.g., amazon-linux).
The bundle ID (e.g., micro_1_0).
The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
", "CreateDiskRequest$availabilityZone": "The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
", "CreateInstancesFromSnapshotRequest$bundleId": "The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).
The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints).
The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).
The Amazon Resource Name (ARN) of the disk.
", "DiskMap$originalDiskPath": "The original disk path exposed to the instance (for example, /dev/sdh).
The Amazon Resource Name (ARN) of the disk snapshot.
", "DiskSnapshot$fromDiskArn": "The Amazon Resource Name (ARN) of the source disk from which you are creating the disk snapshot.
", "Domain$arn": "The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).
The ID of the domain recordset entry.
", "GetOperationRequest$operationId": "A GUID used to identify the operation.
", "Instance$arn": "The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
The blueprint ID (e.g., os_amlinux_2016_03).
The friendly name of the blueprint (e.g., Amazon Linux).
The bundle for the instance (e.g., micro_1_0).
The user name for connecting to the instance (e.g., ec2-user).
The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
The Amazon Resource Name (ARN) of the load balancer.
", "LoadBalancer$dnsName": "The DNS name of your Lightsail load balancer.
", "LoadBalancer$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.
", "LoadBalancerTlsCertificate$arn": "The Amazon Resource Name (ARN) of the SSL/TLS certificate.
", "LoadBalancerTlsCertificate$issuer": "The issuer of the certificate.
", "LoadBalancerTlsCertificate$keyAlgorithm": "The algorithm that was used to generate the key pair (the public and private key).
", "LoadBalancerTlsCertificate$serial": "The serial number of the certificate.
", "LoadBalancerTlsCertificate$signatureAlgorithm": "The algorithm that was used to sign the certificate.
", "LoadBalancerTlsCertificate$subject": "The name of the entity that is associated with the public key contained in the certificate.
", "LoadBalancerTlsCertificateDomainValidationRecord$name": "A fully qualified domain name in the certificate. For example, example.com.
The type of validation record. For example, CNAME for domain validation.
The value for that type.
", "Operation$id": "The ID of the operation.
", "PendingMaintenanceAction$action": "The type of pending database maintenance action.
", "PendingMaintenanceAction$description": "Additional detail about the pending database maintenance action.
", "RelationalDatabase$arn": "The Amazon Resource Name (ARN) of the database.
", "RelationalDatabase$relationalDatabaseBlueprintId": "The blueprint ID for the database. A blueprint describes the major engine version of a database.
", "RelationalDatabase$relationalDatabaseBundleId": "The bundle ID for the database. A bundle describes the performance specifications for your database.
", "RelationalDatabase$state": "Describes the current state of the database.
", "RelationalDatabase$engine": "The database software (for example, MySQL).
The database engine version (for example, 5.7.23).
The master user name of the database.
", "RelationalDatabase$parameterApplyStatus": "The status of parameter updates for the database.
", "RelationalDatabase$preferredBackupWindow": "The daily time range during which automated backups are created for the database (for example, 16:00-16:30).
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.
Specifies the DNS address of the database.
", "RelationalDatabaseSnapshot$arn": "The Amazon Resource Name (ARN) of the database snapshot.
", "RelationalDatabaseSnapshot$engine": "The software of the database snapshot (for example, MySQL)
The database engine version for the database snapshot (for example, 5.7.23).
The state of the database snapshot.
", "RelationalDatabaseSnapshot$fromRelationalDatabaseName": "The name of the source database from which the database snapshot was created.
", "RelationalDatabaseSnapshot$fromRelationalDatabaseArn": "The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
", "StaticIp$arn": "The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
Lightsail throws this exception when it cannot find a resource.
", "refs": { } }, "OpenInstancePublicPortsRequest": { "base": null, "refs": { } }, "OpenInstancePublicPortsResult": { "base": null, "refs": { } }, "Operation": { "base": "Describes the API operation.
", "refs": { "CloseInstancePublicPortsResult$operation": "An array of key-value pairs that contains information about the operation.
", "CreateDomainEntryResult$operation": "An array of key-value pairs containing information about the operation.
", "CreateDomainResult$operation": "An array of key-value pairs containing information about the domain resource you created.
", "CreateKeyPairResult$operation": "An array of key-value pairs containing information about the results of your create key pair request.
", "DeleteDomainEntryResult$operation": "An array of key-value pairs containing information about the results of your delete domain entry request.
", "DeleteDomainResult$operation": "An array of key-value pairs containing information about the results of your delete domain request.
", "DeleteKeyPairResult$operation": "An array of key-value pairs containing information about the results of your delete key pair request.
", "GetOperationResult$operation": "An array of key-value pairs containing information about the results of your get operation request.
", "ImportKeyPairResult$operation": "An array of key-value pairs containing information about the request operation.
", "OpenInstancePublicPortsResult$operation": "An array of key-value pairs containing information about the request operation.
", "OperationList$member": null, "PeerVpcResult$operation": "An array of key-value pairs containing information about the request operation.
", "PutInstancePublicPortsResult$operation": "Describes metadata about the operation you just executed.
", "UnpeerVpcResult$operation": "An array of key-value pairs containing information about the request operation.
" } }, "OperationFailureException": { "base": "Lightsail throws this exception when an operation fails to execute.
", "refs": { } }, "OperationList": { "base": null, "refs": { "AllocateStaticIpResult$operations": "An array of key-value pairs containing information about the static IP address you allocated.
", "AttachDiskResult$operations": "An object describing the API operations.
", "AttachInstancesToLoadBalancerResult$operations": "An object representing the API operations.
", "AttachLoadBalancerTlsCertificateResult$operations": "An object representing the API operations.
These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get the certificate and use it for another purpose.
", "AttachStaticIpResult$operations": "An array of key-value pairs containing information about your API operations.
", "CreateDiskFromSnapshotResult$operations": "An object describing the API operations.
", "CreateDiskResult$operations": "An object describing the API operations.
", "CreateDiskSnapshotResult$operations": "An object describing the API operations.
", "CreateInstanceSnapshotResult$operations": "An array of key-value pairs containing information about the results of your create instances snapshot request.
", "CreateInstancesFromSnapshotResult$operations": "An array of key-value pairs containing information about the results of your create instances from snapshot request.
", "CreateInstancesResult$operations": "An array of key-value pairs containing information about the results of your create instances request.
", "CreateLoadBalancerResult$operations": "An object containing information about the API operations.
", "CreateLoadBalancerTlsCertificateResult$operations": "An object containing information about the API operations.
", "CreateRelationalDatabaseFromSnapshotResult$operations": "An object describing the result of your create relational database from snapshot request.
", "CreateRelationalDatabaseResult$operations": "An object describing the result of your create relational database request.
", "CreateRelationalDatabaseSnapshotResult$operations": "An object describing the result of your create relational database snapshot request.
", "DeleteDiskResult$operations": "An object describing the API operations.
", "DeleteDiskSnapshotResult$operations": "An object describing the API operations.
", "DeleteInstanceResult$operations": "An array of key-value pairs containing information about the results of your delete instance request.
", "DeleteInstanceSnapshotResult$operations": "An array of key-value pairs containing information about the results of your delete instance snapshot request.
", "DeleteLoadBalancerResult$operations": "An object describing the API operations.
", "DeleteLoadBalancerTlsCertificateResult$operations": "An object describing the API operations.
", "DeleteRelationalDatabaseResult$operations": "An object describing the result of your delete relational database request.
", "DeleteRelationalDatabaseSnapshotResult$operations": "An object describing the result of your delete relational database snapshot request.
", "DetachDiskResult$operations": "An object describing the API operations.
", "DetachInstancesFromLoadBalancerResult$operations": "An object describing the API operations.
", "DetachStaticIpResult$operations": "An array of key-value pairs containing information about the results of your detach static IP request.
", "GetOperationsForResourceResult$operations": "An array of key-value pairs containing information about the results of your get operations for resource request.
", "GetOperationsResult$operations": "An array of key-value pairs containing information about the results of your get operations request.
", "RebootInstanceResult$operations": "An array of key-value pairs containing information about the request operations.
", "RebootRelationalDatabaseResult$operations": "An object describing the result of your reboot relational database request.
", "ReleaseStaticIpResult$operations": "An array of key-value pairs containing information about the request operation.
", "StartInstanceResult$operations": "An array of key-value pairs containing information about the request operation.
", "StartRelationalDatabaseResult$operations": "An object describing the result of your start relational database request.
", "StopInstanceResult$operations": "An array of key-value pairs containing information about the request operation.
", "StopRelationalDatabaseResult$operations": "An object describing the result of your stop relational database request.
", "UpdateDomainEntryResult$operations": "An array of key-value pairs containing information about the request operation.
", "UpdateLoadBalancerAttributeResult$operations": "An object describing the API operations.
", "UpdateRelationalDatabaseParametersResult$operations": "An object describing the result of your update relational database parameters request.
", "UpdateRelationalDatabaseResult$operations": "An object describing the result of your update relational database request.
" } }, "OperationStatus": { "base": null, "refs": { "Operation$status": "The status of the operation.
" } }, "OperationType": { "base": null, "refs": { "Operation$operationType": "The type of operation.
" } }, "PasswordData": { "base": "The password data for the Windows Server-based instance, including the ciphertext and the key pair name.
", "refs": { "InstanceAccessDetails$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.
Describes a pending database maintenance action.
", "refs": { "PendingMaintenanceActionList$member": null } }, "PendingMaintenanceActionList": { "base": null, "refs": { "RelationalDatabase$pendingMaintenanceActions": "Describes the pending maintenance actions for the database.
" } }, "PendingModifiedRelationalDatabaseValues": { "base": "Describes a pending database value modification.
", "refs": { "RelationalDatabase$pendingModifiedValues": "Describes pending database value modifications.
" } }, "Port": { "base": null, "refs": { "CreateLoadBalancerRequest$instancePort": "The instance port where you're creating your load balancer.
", "InstancePortInfo$fromPort": "The first port in the range.
", "InstancePortInfo$toPort": "The last port in the range.
", "InstancePortState$fromPort": "The first port in the range.
", "InstancePortState$toPort": "The last port in the range.
", "PortInfo$fromPort": "The first port in the range.
", "PortInfo$toPort": "The last port in the range.
", "PortList$member": null } }, "PortAccessType": { "base": null, "refs": { "InstancePortInfo$accessType": "The type of access (Public or Private).
Describes information about the ports on your virtual private server (or instance).
", "refs": { "CloseInstancePublicPortsRequest$portInfo": "Information about the public port you are trying to close.
", "OpenInstancePublicPortsRequest$portInfo": "An array of key-value pairs containing information about the port mappings.
", "PortInfoList$member": null } }, "PortInfoList": { "base": null, "refs": { "PutInstancePublicPortsRequest$portInfos": "Specifies information about the public port(s).
" } }, "PortList": { "base": null, "refs": { "LoadBalancer$publicPorts": "An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
" } }, "PortState": { "base": null, "refs": { "InstancePortState$state": "Specifies whether the instance port is open or closed.
Describes the AWS Region.
", "refs": { "RegionList$member": null } }, "RegionList": { "base": null, "refs": { "GetRegionsResult$regions": "An array of key-value pairs containing information about your get regions request.
" } }, "RegionName": { "base": null, "refs": { "Region$name": "The region name (e.g., us-east-2).
The AWS Region name.
" } }, "RelationalDatabase": { "base": "Describes a database.
", "refs": { "GetRelationalDatabaseResult$relationalDatabase": "An object describing the specified database.
", "RelationalDatabaseList$member": null } }, "RelationalDatabaseBlueprint": { "base": "Describes a database image, or blueprint. A blueprint describes the major engine version of a database.
", "refs": { "RelationalDatabaseBlueprintList$member": null } }, "RelationalDatabaseBlueprintList": { "base": null, "refs": { "GetRelationalDatabaseBlueprintsResult$blueprints": "An object describing the result of your get relational database blueprints request.
" } }, "RelationalDatabaseBundle": { "base": "Describes a database bundle. A bundle describes the performance specifications of the database.
", "refs": { "RelationalDatabaseBundleList$member": null } }, "RelationalDatabaseBundleList": { "base": null, "refs": { "GetRelationalDatabaseBundlesResult$bundles": "An object describing the result of your get relational database bundles request.
" } }, "RelationalDatabaseEndpoint": { "base": "Describes an endpoint for a database.
", "refs": { "RelationalDatabase$masterEndpoint": "The master endpoint for the database.
" } }, "RelationalDatabaseEngine": { "base": null, "refs": { "RelationalDatabaseBlueprint$engine": "The database software of the database blueprint (for example, MySQL).
Describes an event for a database.
", "refs": { "RelationalDatabaseEventList$member": null } }, "RelationalDatabaseEventList": { "base": null, "refs": { "GetRelationalDatabaseEventsResult$relationalDatabaseEvents": "An object describing the result of your get relational database events request.
" } }, "RelationalDatabaseHardware": { "base": "Describes the hardware of a database.
", "refs": { "RelationalDatabase$hardware": "Describes the hardware of the database.
" } }, "RelationalDatabaseList": { "base": null, "refs": { "GetRelationalDatabasesResult$relationalDatabases": "An object describing the result of your get relational databases request.
" } }, "RelationalDatabaseMetricName": { "base": null, "refs": { "GetRelationalDatabaseMetricDataRequest$metricName": "The name of the metric data to return.
", "GetRelationalDatabaseMetricDataResult$metricName": "The name of the metric.
" } }, "RelationalDatabaseParameter": { "base": "Describes the parameters of a database.
", "refs": { "RelationalDatabaseParameterList$member": null } }, "RelationalDatabaseParameterList": { "base": null, "refs": { "GetRelationalDatabaseParametersResult$parameters": "An object describing the result of your get relational database parameters request.
", "UpdateRelationalDatabaseParametersRequest$parameters": "The database parameters to update.
" } }, "RelationalDatabasePasswordVersion": { "base": null, "refs": { "GetRelationalDatabaseMasterUserPasswordRequest$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
Describes a database snapshot.
", "refs": { "GetRelationalDatabaseSnapshotResult$relationalDatabaseSnapshot": "An object describing the specified database snapshot.
", "RelationalDatabaseSnapshotList$member": null } }, "RelationalDatabaseSnapshotList": { "base": null, "refs": { "GetRelationalDatabaseSnapshotsResult$relationalDatabaseSnapshots": "An object describing the result of your get relational database snapshots request.
" } }, "ReleaseStaticIpRequest": { "base": null, "refs": { } }, "ReleaseStaticIpResult": { "base": null, "refs": { } }, "ResourceLocation": { "base": "Describes the resource location.
", "refs": { "Disk$location": "The AWS Region and Availability Zone where the disk is located.
", "DiskSnapshot$location": "The AWS Region and Availability Zone where the disk snapshot was created.
", "Domain$location": "The AWS Region and Availability Zones where the domain recordset was created.
", "Instance$location": "The region name and Availability Zone where the instance is located.
", "InstanceSnapshot$location": "The region name and Availability Zone where you created the snapshot.
", "KeyPair$location": "The region name and Availability Zone where the key pair was created.
", "LoadBalancer$location": "The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.
The AWS Region and Availability Zone where you created your certificate.
", "Operation$location": "The region and Availability Zone.
", "RelationalDatabase$location": "The Region name and Availability Zone where the database is located.
", "RelationalDatabaseSnapshot$location": "The Region name and Availability Zone where the database snapshot is located.
", "StaticIp$location": "The region and Availability Zone where the static IP was created.
" } }, "ResourceName": { "base": null, "refs": { "AllocateStaticIpRequest$staticIpName": "The name of the static IP address.
", "AttachDiskRequest$diskName": "The unique Lightsail disk name (e.g., my-disk).
The name of the Lightsail instance where you want to utilize the storage disk.
", "AttachInstancesToLoadBalancerRequest$loadBalancerName": "The name of the load balancer.
", "AttachLoadBalancerTlsCertificateRequest$loadBalancerName": "The name of the load balancer to which you want to associate the SSL/TLS certificate.
", "AttachLoadBalancerTlsCertificateRequest$certificateName": "The name of your SSL/TLS certificate.
", "AttachStaticIpRequest$staticIpName": "The name of the static IP.
", "AttachStaticIpRequest$instanceName": "The instance name to which you want to attach the static IP address.
", "AttachedDiskMap$key": null, "Blueprint$name": "The friendly name of the blueprint (e.g., Amazon Linux).
The name of the instance on which you're attempting to close the public ports.
", "CreateDiskFromSnapshotRequest$diskName": "The unique Lightsail disk name (e.g., my-disk).
The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk.
The unique Lightsail disk name (e.g., my-disk).
The unique name of the source disk (e.g., my-source-disk).
The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk.
The name for your new snapshot.
", "CreateInstanceSnapshotRequest$instanceName": "The Lightsail instance on which to base your snapshot.
", "CreateInstancesFromSnapshotRequest$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.
", "CreateInstancesFromSnapshotRequest$keyPairName": "The name for your key pair.
", "CreateInstancesRequest$customImageName": "(Deprecated) The name for your custom image.
In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.
The name of your key pair.
", "CreateKeyPairRequest$keyPairName": "The name for your new key pair.
", "CreateLoadBalancerRequest$loadBalancerName": "The name of your load balancer.
", "CreateLoadBalancerRequest$certificateName": "The name of the SSL/TLS certificate.
If you specify certificateName, then certificateDomainName is required (and vice-versa).
The load balancer name where you want to create the SSL/TLS certificate.
", "CreateLoadBalancerTlsCertificateRequest$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.
", "CreateRelationalDatabaseFromSnapshotRequest$relationalDatabaseName": "The name to use for your new database.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
The name of the database snapshot from which to create your new database.
", "CreateRelationalDatabaseFromSnapshotRequest$sourceRelationalDatabaseName": "The name of the source database.
", "CreateRelationalDatabaseRequest$relationalDatabaseName": "The name to use for your new database.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
The name of the database on which to base your new snapshot.
", "CreateRelationalDatabaseSnapshotRequest$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.
The unique name of the disk you want to delete (e.g., my-disk).
The name of the disk snapshot you want to delete (e.g., my-disk-snapshot).
The name of the instance to delete.
", "DeleteInstanceSnapshotRequest$instanceSnapshotName": "The name of the snapshot to delete.
", "DeleteKeyPairRequest$keyPairName": "The name of the key pair to delete.
", "DeleteLoadBalancerRequest$loadBalancerName": "The name of the load balancer you want to delete.
", "DeleteLoadBalancerTlsCertificateRequest$loadBalancerName": "The load balancer name.
", "DeleteLoadBalancerTlsCertificateRequest$certificateName": "The SSL/TLS certificate name.
", "DeleteRelationalDatabaseRequest$relationalDatabaseName": "The name of the database that you are deleting.
", "DeleteRelationalDatabaseRequest$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.
The name of the database snapshot that you are deleting.
", "DetachDiskRequest$diskName": "The unique name of the disk you want to detach from your instance (e.g., my-disk).
The name of the Lightsail load balancer.
", "DetachStaticIpRequest$staticIpName": "The name of the static IP to detach from the instance.
", "Disk$name": "The unique name of the disk.
", "Disk$attachedTo": "The resources to which the disk is attached.
", "DiskMap$newDiskName": "The new disk name (e.g., my-new-disk).
The name of the disk snapshot (e.g., my-disk-snapshot).
The unique name of the source disk from which you are creating the disk snapshot.
", "Domain$name": "The name of the domain.
", "GetDiskRequest$diskName": "The name of the disk (e.g., my-disk).
The name of the disk snapshot (e.g., my-disk-snapshot).
The name of the instance to access.
", "GetInstanceMetricDataRequest$instanceName": "The name of the instance for which you want to get metrics data.
", "GetInstancePortStatesRequest$instanceName": "The name of the instance.
", "GetInstanceRequest$instanceName": "The name of the instance.
", "GetInstanceSnapshotRequest$instanceSnapshotName": "The name of the snapshot for which you are requesting information.
", "GetInstanceStateRequest$instanceName": "The name of the instance to get state information about.
", "GetKeyPairRequest$keyPairName": "The name of the key pair for which you are requesting information.
", "GetLoadBalancerMetricDataRequest$loadBalancerName": "The name of the load balancer.
", "GetLoadBalancerRequest$loadBalancerName": "The name of the load balancer.
", "GetLoadBalancerTlsCertificatesRequest$loadBalancerName": "The name of the load balancer you associated with your SSL/TLS certificate.
", "GetOperationsForResourceRequest$resourceName": "The name of the resource for which you are requesting information.
", "GetRelationalDatabaseEventsRequest$relationalDatabaseName": "The name of the database from which to get events.
", "GetRelationalDatabaseLogEventsRequest$relationalDatabaseName": "The name of your database for which to get log events.
", "GetRelationalDatabaseLogStreamsRequest$relationalDatabaseName": "The name of your database for which to get log streams.
", "GetRelationalDatabaseMasterUserPasswordRequest$relationalDatabaseName": "The name of your database for which to get the master user password.
", "GetRelationalDatabaseMetricDataRequest$relationalDatabaseName": "The name of your database from which to get metric data.
", "GetRelationalDatabaseParametersRequest$relationalDatabaseName": "The name of your database for which to get parameters.
", "GetRelationalDatabaseRequest$relationalDatabaseName": "The name of the database that you are looking up.
", "GetRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName": "The name of the database snapshot for which to get information.
", "GetStaticIpRequest$staticIpName": "The name of the static IP in Lightsail.
", "ImportKeyPairRequest$keyPairName": "The name of the key pair for which you want to import the public key.
", "Instance$name": "The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).
The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).
The name of this Amazon Lightsail instance.
", "InstanceHealthSummary$instanceName": "The name of the Lightsail instance for which you are requesting health check data.
", "InstanceSnapshot$name": "The name of the snapshot.
", "InstanceSnapshot$fromInstanceName": "The instance from which the snapshot was created.
", "KeyPair$name": "The friendly name of the SSH key pair.
", "LoadBalancer$name": "The name of the load balancer (e.g., my-load-balancer).
The name of the SSL/TLS certificate (e.g., my-certificate).
The load balancer name where your SSL/TLS certificate is attached.
", "LoadBalancerTlsCertificateSummary$name": "The name of the SSL/TLS certificate.
", "OpenInstancePublicPortsRequest$instanceName": "The name of the instance for which you want to open the public ports.
", "Operation$resourceName": "The resource name.
", "PasswordData$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.
The Lightsail instance name of the public port(s) you are setting.
", "RebootInstanceRequest$instanceName": "The name of the instance to reboot.
", "RebootRelationalDatabaseRequest$relationalDatabaseName": "The name of your database to reboot.
", "RelationalDatabase$name": "The unique name of the database resource in Lightsail.
", "RelationalDatabaseEvent$resource": "The database that the database event relates to.
", "RelationalDatabaseSnapshot$name": "The name of the database snapshot.
", "ReleaseStaticIpRequest$staticIpName": "The name of the static IP to delete.
", "ResourceNameList$member": null, "StartInstanceRequest$instanceName": "The name of the instance (a virtual private server) to start.
", "StartRelationalDatabaseRequest$relationalDatabaseName": "The name of your database to start.
", "StaticIp$name": "The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).
The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).
The name of the instance (a virtual private server) to stop.
", "StopRelationalDatabaseRequest$relationalDatabaseName": "The name of your database to stop.
", "StopRelationalDatabaseRequest$relationalDatabaseSnapshotName": "The name of your new database snapshot to be created before stopping your database.
", "UpdateLoadBalancerAttributeRequest$loadBalancerName": "The name of the load balancer that you want to modify (e.g., my-load-balancer.
The name of your database for which to update parameters.
", "UpdateRelationalDatabaseRequest$relationalDatabaseName": "The name of your database to update.
" } }, "ResourceNameList": { "base": null, "refs": { "AttachInstancesToLoadBalancerRequest$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).
", "DetachInstancesFromLoadBalancerRequest$instanceNames": "An array of strings containing the names of the instances you want to detach from the load balancer.
" } }, "ResourceType": { "base": null, "refs": { "Disk$resourceType": "The Lightsail resource type (e.g., Disk).
The Lightsail resource type (e.g., DiskSnapshot).
The resource type.
", "Instance$resourceType": "The type of resource (usually Instance).
The type of resource (usually InstanceSnapshot).
The resource type (usually KeyPair).
The resource type (e.g., LoadBalancer.
The resource type (e.g., LoadBalancerTlsCertificate).
Instance - A Lightsail instance (a virtual private server)
StaticIp - A static IP address
KeyPair - The key pair used to connect to a Lightsail instance
InstanceSnapshot - A Lightsail instance snapshot
Domain - A DNS zone
PeeredVpc - A peered VPC
LoadBalancer - A Lightsail load balancer
LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer
Disk - A Lightsail block storage disk
DiskSnapshot - A block storage disk snapshot
The resource type.
", "RelationalDatabase$resourceType": "The Lightsail resource type for the database (for example, RelationalDatabase).
The Lightsail resource type.
", "StaticIp$resourceType": "The resource type (usually StaticIp).
The password for the master user of your new database. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints: Must contain 8 to 41 characters.
", "GetRelationalDatabaseMasterUserPasswordResult$masterUserPassword": "The master user password for the password version specified.
The password for the master user of your database. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints: Must contain 8 to 41 characters.
" } }, "ServiceException": { "base": "A general service exception.
", "refs": { } }, "StartInstanceRequest": { "base": null, "refs": { } }, "StartInstanceResult": { "base": null, "refs": { } }, "StartRelationalDatabaseRequest": { "base": null, "refs": { } }, "StartRelationalDatabaseResult": { "base": null, "refs": { } }, "StaticIp": { "base": "Describes the static IP.
", "refs": { "GetStaticIpResult$staticIp": "An array of key-value pairs containing information about the requested static IP.
", "StaticIpList$member": null } }, "StaticIpList": { "base": null, "refs": { "GetStaticIpsResult$staticIps": "An array of key-value pairs containing information about your get static IPs request.
" } }, "StopInstanceRequest": { "base": null, "refs": { } }, "StopInstanceResult": { "base": null, "refs": { } }, "StopRelationalDatabaseRequest": { "base": null, "refs": { } }, "StopRelationalDatabaseResult": { "base": null, "refs": { } }, "StringList": { "base": null, "refs": { "CreateInstancesFromSnapshotRequest$instanceNames": "The names for your new instances.
", "CreateInstancesRequest$instanceNames": "The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: [\"MyFirstInstance\",\"MySecondInstance\"]
The list of active names returned by the get active names request.
", "GetRelationalDatabaseLogStreamsResult$logStreams": "An object describing the result of your get relational database log streams request.
", "LoadBalancerTlsCertificate$subjectAlternativeNames": "One or more domains or subdomains included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CNAME) of the certificate and additional domain names that can be used to connect to the website, such as example.com, www.example.com, or m.example.com.
The category that the database event belongs to.
" } }, "StringMax256": { "base": null, "refs": { "UpdateLoadBalancerAttributeRequest$attributeValue": "The value that you want to specify for the attribute name.
" } }, "UnauthenticatedException": { "base": "Lightsail throws this exception when the user has not been authenticated.
", "refs": { } }, "UnpeerVpcRequest": { "base": null, "refs": { } }, "UnpeerVpcResult": { "base": null, "refs": { } }, "UpdateDomainEntryRequest": { "base": null, "refs": { } }, "UpdateDomainEntryResult": { "base": null, "refs": { } }, "UpdateLoadBalancerAttributeRequest": { "base": null, "refs": { } }, "UpdateLoadBalancerAttributeResult": { "base": null, "refs": { } }, "UpdateRelationalDatabaseParametersRequest": { "base": null, "refs": { } }, "UpdateRelationalDatabaseParametersResult": { "base": null, "refs": { } }, "UpdateRelationalDatabaseRequest": { "base": null, "refs": { } }, "UpdateRelationalDatabaseResult": { "base": null, "refs": { } }, "boolean": { "base": null, "refs": { "Blueprint$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.
", "Bundle$isActive": "A Boolean value indicating whether the bundle is active.
", "CreateRelationalDatabaseFromSnapshotRequest$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.
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.
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.
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.
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
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
", "Disk$isAttached": "A Boolean value indicating whether the disk is attached.
", "DomainEntry$isAlias": "When true, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer
A Boolean value indicating whether to include inactive results in your request.
", "GetBundlesRequest$includeInactive": "A Boolean value that indicates whether to include inactive bundle results in your request.
", "GetRegionsRequest$includeAvailabilityZones": "A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., us-east-2a.
>A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (e.g., us-east-2a).
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.
Default: false
A Boolean value indicating whether this instance has a static IP assigned to it.
", "IsVpcPeeredResult$isPeered": "Returns true if the Lightsail VPC is peered; otherwise, false.
When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
A Boolean value indicating whether the operation is terminal.
", "PendingModifiedRelationalDatabaseValues$backupRetentionEnabled": "A Boolean value indicating whether automated backup retention is enabled.
", "RelationalDatabase$backupRetentionEnabled": "A Boolean value indicating whether automated backup retention is enabled for the database.
", "RelationalDatabase$publiclyAccessible": "A Boolean value indicating whether the database is publicly accessible.
", "RelationalDatabaseBlueprint$isEngineDefault": "A Boolean value indicating whether the engine version is the default for the database blueprint.
", "RelationalDatabaseBundle$isEncrypted": "A Boolean value indicating whether the database bundle is encrypted.
", "RelationalDatabaseBundle$isActive": "A Boolean value indicating whether the database bundle is active.
", "RelationalDatabaseParameter$isModifiable": "A Boolean value indicating whether the parameter can be modified.
", "StaticIp$isAttached": "A Boolean value indicating whether the static IP is attached.
", "StopInstanceRequest$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.
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.
When true, enables automated backup retention for your database.
Updates are applied during the next maintenance window because this can result in an outage.
", "UpdateRelationalDatabaseRequest$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.
", "UpdateRelationalDatabaseRequest$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.
When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.
Default: false
The average.
", "MetricDatapoint$maximum": "The maximum.
", "MetricDatapoint$minimum": "The minimum.
", "MetricDatapoint$sampleCount": "The sample count.
", "MetricDatapoint$sum": "The sum.
" } }, "float": { "base": null, "refs": { "Bundle$price": "The price in US dollars (e.g., 5.0).
The amount of RAM in GB (e.g., 2.0).
The amount of RAM in GB on the instance (e.g., 1.0).
The cost of the database bundle in US currency.
", "RelationalDatabaseBundle$ramSizeInGb": "The amount of RAM in GB (for example, 2.0) for the database bundle.
The amount of RAM in GB for the database.
" } }, "integer": { "base": null, "refs": { "Blueprint$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.
The number of vCPUs included in the bundle (e.g., 2).
The size of the SSD (e.g., 30).
A numeric value that represents the power of the bundle (e.g., 500). You can use the bundle's power value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.
The data transfer rate per month in GB (e.g., 2000).
The size of the disk in GB (e.g., 32).
The size of the disk in GB (e.g., 32).
The size of the disk in GB.
", "Disk$iops": "The input/output operations per second (IOPS) of the disk.
", "Disk$gbInUse": "(Deprecated) The number of GB in use by the disk.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
The size of the disk in GB.
", "GetRelationalDatabaseEventsRequest$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).
", "InstanceHardware$cpuCount": "The number of vCPUs the instance has.
", "InstanceSnapshot$sizeInGb": "The size in GB of the SSD.
", "InstanceState$code": "The status code for the instance.
", "LoadBalancer$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.
", "MonthlyTransfer$gbPerMonthAllocated": "The amount allocated per month (in GB).
", "RelationalDatabaseBundle$diskSizeInGb": "The size of the disk for the database bundle.
", "RelationalDatabaseBundle$transferPerMonthInGb": "The data transfer rate per month in GB for the database bundle.
", "RelationalDatabaseBundle$cpuCount": "The number of virtual CPUs (vCPUs) for the database bundle.
", "RelationalDatabaseEndpoint$port": "Specifies the port that the database is listening on.
", "RelationalDatabaseHardware$cpuCount": "The number of vCPUs for the database.
", "RelationalDatabaseHardware$diskSizeInGb": "The size of the disk for the database.
", "RelationalDatabaseSnapshot$sizeInGb": "The size of the disk in GB (for example, 32) for the database snapshot.
The description of the blueprint.
", "Blueprint$version": "The version number of the operating system, application, or stack (e.g., 2016.03.0).
The version code.
", "Blueprint$productUrl": "The product URL to learn more about the image or blueprint.
", "Blueprint$licenseUrl": "The end-user license agreement URL for the image or blueprint.
", "Bundle$instanceType": "The Amazon EC2 instance type (e.g., t2.micro).
A friendly name for the bundle (e.g., Micro).
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.
You can create a launch script that configures a server with additional user data. For example, apt-get -y update.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Dev Guide.
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.
A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Dev Guide.
The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., \"/\").
You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.
", "CreateRelationalDatabaseFromSnapshotRequest$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.
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.
", "CreateRelationalDatabaseRequest$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.
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.
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.
The name of the master database created when the Lightsail database resource is created.
Constraints:
Must contain from 1 to 64 alphanumeric characters.
Cannot be a word reserved by the specified database engine
The master user name for your new database.
Constraints:
Master user name is required.
Must contain from 1 to 16 alphanumeric characters.
The first character must be a letter.
Cannot be a reserved word for the database engine you choose.
For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6 or MySQL 5.7 respectively.
The daily time range during which automated backups are created for your new database if automated backups are enabled.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.
Constraints:
Must be in the hh24:mi-hh24:mi format.
Example: 16:00-16:30
Specified in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
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 Universal Coordinated Time (UTC).
Example: Tue:17:00-Tue:17:30
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.
", "Disk$path": "The disk path.
", "Disk$attachmentState": "(Deprecated) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.
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.
", "DiskSnapshot$progress": "The progress of the disk snapshot operation.
", "Domain$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.
", "DomainEntry$target": "The target AWS name server (e.g., ns-111.awsdns-22.com.).
For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure to also set isAlias to true when setting up an A record for a load balancer.
A token used for paginating results from your get active names request.
", "GetActiveNamesResult$nextPageToken": "A token used for advancing to the next page of results from your get active names request.
", "GetBlueprintsRequest$pageToken": "A token used for advancing to the next page of results from your get blueprints request.
", "GetBlueprintsResult$nextPageToken": "A token used for advancing to the next page of results from your get blueprints request.
", "GetBundlesRequest$pageToken": "A token used for advancing to the next page of results from your get bundles request.
", "GetBundlesResult$nextPageToken": "A token used for advancing to the next page of results from your get active names request.
", "GetDiskSnapshotsRequest$pageToken": "A token used for advancing to the next page of results from your GetDiskSnapshots request.
", "GetDiskSnapshotsResult$nextPageToken": "A token used for advancing to the next page of results from your GetDiskSnapshots request.
", "GetDisksRequest$pageToken": "A token used for advancing to the next page of results from your GetDisks request.
", "GetDisksResult$nextPageToken": "A token used for advancing to the next page of results from your GetDisks request.
", "GetDomainsRequest$pageToken": "A token used for advancing to the next page of results from your get domains request.
", "GetDomainsResult$nextPageToken": "A token used for advancing to the next page of results from your get active names request.
", "GetInstanceSnapshotsRequest$pageToken": "A token used for advancing to the next page of results from your get instance snapshots request.
", "GetInstanceSnapshotsResult$nextPageToken": "A token used for advancing to the next page of results from your get instance snapshots request.
", "GetInstancesRequest$pageToken": "A token used for advancing to the next page of results from your get instances request.
", "GetInstancesResult$nextPageToken": "A token used for advancing to the next page of results from your get instances request.
", "GetKeyPairsRequest$pageToken": "A token used for advancing to the next page of results from your get key pairs request.
", "GetKeyPairsResult$nextPageToken": "A token used for advancing to the next page of results from your get key pairs request.
", "GetLoadBalancersRequest$pageToken": "A token used for paginating the results from your GetLoadBalancers request.
", "GetLoadBalancersResult$nextPageToken": "A token used for advancing to the next page of results from your GetLoadBalancers request.
", "GetOperationsForResourceRequest$pageToken": "A token used for advancing to the next page of results from your get operations for resource request.
", "GetOperationsForResourceResult$nextPageCount": "(Deprecated) Returns the number of pages of results that remain.
In releases prior to June 12, 2017, this parameter returned null by the API. It is now deprecated, and the API returns the next page token parameter instead.
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "GetOperationsRequest$pageToken": "A token used for advancing to the next page of results from your get operations request.
", "GetOperationsResult$nextPageToken": "A token used for advancing to the next page of results from your get operations request.
", "GetRelationalDatabaseBlueprintsRequest$pageToken": "A token used for advancing to a specific page of results for your get relational database blueprints request.
", "GetRelationalDatabaseBlueprintsResult$nextPageToken": "A token used for advancing to the next page of results of your get relational database blueprints request.
", "GetRelationalDatabaseBundlesRequest$pageToken": "A token used for advancing to a specific page of results for your get relational database bundles request.
", "GetRelationalDatabaseBundlesResult$nextPageToken": "A token used for advancing to the next page of results of your get relational database bundles request.
", "GetRelationalDatabaseEventsRequest$pageToken": "A token used for advancing to a specific page of results from for get relational database events request.
", "GetRelationalDatabaseEventsResult$nextPageToken": "A token used for advancing to the next page of results from your get relational database events request.
", "GetRelationalDatabaseLogEventsRequest$logStreamName": "The name of the log stream.
Use the get relational database log streams operation to get a list of available log streams.
A token used for advancing to a specific page of results for your get relational database log events request.
", "GetRelationalDatabaseLogEventsResult$nextBackwardToken": "A token used for advancing to the previous page of results from your get relational database log events request.
", "GetRelationalDatabaseLogEventsResult$nextForwardToken": "A token used for advancing to the next page of results from your get relational database log events request.
", "GetRelationalDatabaseParametersRequest$pageToken": "A token used for advancing to a specific page of results for your get relational database parameters request.
", "GetRelationalDatabaseParametersResult$nextPageToken": "A token used for advancing to the next page of results from your get static IPs request.
", "GetRelationalDatabaseSnapshotsRequest$pageToken": "A token used for advancing to a specific page of results for your get relational database snapshots request.
", "GetRelationalDatabaseSnapshotsResult$nextPageToken": "A token used for advancing to the next page of results from your get relational database snapshots request.
", "GetRelationalDatabasesRequest$pageToken": "A token used for advancing to a specific page of results for your get relational database request.
", "GetRelationalDatabasesResult$nextPageToken": "A token used for advancing to the next page of results from your get relational databases request.
", "GetStaticIpsRequest$pageToken": "A token used for advancing to the next page of results from your get static IPs request.
", "GetStaticIpsResult$nextPageToken": "A token used for advancing to the next page of results from your get static IPs request.
", "Instance$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.
", "InstanceAccessDetails$certKey": "For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub.
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.
For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).
The user name to use when logging in to the Amazon Lightsail instance.
", "InstancePortInfo$accessFrom": "The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).
The common name.
", "InstanceSnapshot$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.
", "InstanceSnapshot$progress": "The progress of the snapshot.
", "InstanceSnapshot$fromBlueprintId": "The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.
The bundle ID from which you created the snapshot (e.g., micro_1_0).
The state of the instance (e.g., running or pending).
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.
", "LoadBalancer$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.
", "LoadBalancerConfigurationOptions$value": null, "LoadBalancerTlsCertificate$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.
", "LogEvent$message": "The message of the database log event.
", "NotFoundException$code": null, "NotFoundException$docs": null, "NotFoundException$message": null, "NotFoundException$tip": null, "Operation$operationDetails": "Details about the operation (e.g., Debian-1GB-Ohio-1).
The error code.
", "Operation$errorDetails": "The error details.
", "OperationFailureException$code": null, "OperationFailureException$docs": null, "OperationFailureException$message": null, "OperationFailureException$tip": null, "PasswordData$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.
The password for the master user of the database.
", "PendingModifiedRelationalDatabaseValues$engineVersion": "The database engine version.
", "Region$continentCode": "The continent code (e.g., NA, meaning North America).
The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).
The display name (e.g., Ohio).
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.
", "RelationalDatabase$masterDatabaseName": "The name of the master database created when the Lightsail database resource is created.
", "RelationalDatabase$secondaryAvailabilityZone": "Describes the secondary Availability Zone of a high availability database.
The secondary database is used for failover support of a high availability database.
", "RelationalDatabaseBlueprint$blueprintId": "The ID for the database blueprint.
", "RelationalDatabaseBlueprint$engineVersion": "The database engine version for the database blueprint (for example, 5.7.23).
The description of the database engine for the database blueprint.
", "RelationalDatabaseBlueprint$engineVersionDescription": "The description of the database engine version for the database blueprint.
", "RelationalDatabaseBundle$bundleId": "The ID for the database bundle.
", "RelationalDatabaseBundle$name": "The name for the database bundle.
", "RelationalDatabaseEvent$message": "The message of the database event.
", "RelationalDatabaseParameter$allowedValues": "Specifies the valid range of values for the parameter.
", "RelationalDatabaseParameter$applyMethod": "Indicates when parameter updates are applied.
Can be immediate or pending-reboot.
Specifies the engine-specific parameter type.
", "RelationalDatabaseParameter$dataType": "Specifies the valid data type for the parameter.
", "RelationalDatabaseParameter$description": "Provides a description of the parameter.
", "RelationalDatabaseParameter$parameterName": "Specifies the name of the parameter.
", "RelationalDatabaseParameter$parameterValue": "Specifies the value of the parameter.
", "RelationalDatabaseSnapshot$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.
", "RelationalDatabaseSnapshot$fromRelationalDatabaseBundleId": "The bundle ID of the database from which the database snapshot was created.
", "RelationalDatabaseSnapshot$fromRelationalDatabaseBlueprintId": "The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
", "ResourceLocation$availabilityZone": "The Availability Zone. Follows the format us-east-2a (case-sensitive).
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.
", "StringList$member": null, "UnauthenticatedException$code": null, "UnauthenticatedException$docs": null, "UnauthenticatedException$message": null, "UnauthenticatedException$tip": null, "UpdateRelationalDatabaseRequest$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 Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur on your database.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints:
Must be in the ddd:hh24:mi-ddd:hh24:mi format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Universal Coordinated Time (UTC).
Example: Tue:17:00-Tue:17:30
The start time of the time period.
", "GetInstanceMetricDataRequest$endTime": "The end time of the time period.
", "GetLoadBalancerMetricDataRequest$startTime": "The start time of the period.
", "GetLoadBalancerMetricDataRequest$endTime": "The end time of the period.
", "MetricDatapoint$timestamp": "The timestamp (e.g., 1479816991.349).