@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonLightsail extends Object implements AmazonLightsail
AmazonLightsail. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAmazonLightsail() |
| Modifier and Type | Method and Description |
|---|---|
AllocateStaticIpResult |
allocateStaticIp(AllocateStaticIpRequest request)
Allocates a static IP address.
|
AttachDiskResult |
attachDisk(AttachDiskRequest request)
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the
specified disk name.
|
AttachInstancesToLoadBalancerResult |
attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest request)
Attaches one or more Lightsail instances to a load balancer.
|
AttachLoadBalancerTlsCertificateResult |
attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest request)
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
|
AttachStaticIpResult |
attachStaticIp(AttachStaticIpRequest request)
Attaches a static IP address to a specific Amazon Lightsail instance.
|
CloseInstancePublicPortsResult |
closeInstancePublicPorts(CloseInstancePublicPortsRequest request)
Closes the public ports on a specific Amazon Lightsail instance.
|
CopySnapshotResult |
copySnapshot(CopySnapshotRequest request)
Copies a manual instance or disk snapshot as another manual snapshot, or copies an automatic instance or disk
snapshot as a manual snapshot.
|
CreateCloudFormationStackResult |
createCloudFormationStack(CreateCloudFormationStackRequest request)
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail
snapshot.
|
CreateDiskResult |
createDisk(CreateDiskRequest request)
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone
(e.g.,
us-east-2a). |
CreateDiskFromSnapshotResult |
createDiskFromSnapshot(CreateDiskFromSnapshotRequest request)
Creates a block storage disk from a manual or automatic snapshot of a disk.
|
CreateDiskSnapshotResult |
createDiskSnapshot(CreateDiskSnapshotRequest request)
Creates a snapshot of a block storage disk.
|
CreateDomainResult |
createDomain(CreateDomainRequest request)
Creates a domain resource for the specified domain (e.g., example.com).
|
CreateDomainEntryResult |
createDomainEntry(CreateDomainEntryRequest request)
Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail
exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
|
CreateInstancesResult |
createInstances(CreateInstancesRequest request)
Creates one or more Amazon Lightsail instances.
|
CreateInstancesFromSnapshotResult |
createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest request)
Creates one or more new instances from a manual or automatic snapshot of an instance.
|
CreateInstanceSnapshotResult |
createInstanceSnapshot(CreateInstanceSnapshotRequest request)
Creates a snapshot of a specific virtual private server, or instance.
|
CreateKeyPairResult |
createKeyPair(CreateKeyPairRequest request)
Creates an SSH key pair.
|
CreateLoadBalancerResult |
createLoadBalancer(CreateLoadBalancerRequest request)
Creates a Lightsail load balancer.
|
CreateLoadBalancerTlsCertificateResult |
createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest request)
Creates a Lightsail load balancer TLS certificate.
|
CreateRelationalDatabaseResult |
createRelationalDatabase(CreateRelationalDatabaseRequest request)
Creates a new database in Amazon Lightsail.
|
CreateRelationalDatabaseFromSnapshotResult |
createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest request)
Creates a new database from an existing database snapshot in Amazon Lightsail.
|
CreateRelationalDatabaseSnapshotResult |
createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest request)
Creates a snapshot of your database in Amazon Lightsail.
|
DeleteAutoSnapshotResult |
deleteAutoSnapshot(DeleteAutoSnapshotRequest request)
Deletes an automatic snapshot for an instance or disk.
|
DeleteDiskResult |
deleteDisk(DeleteDiskRequest request)
Deletes the specified block storage disk.
|
DeleteDiskSnapshotResult |
deleteDiskSnapshot(DeleteDiskSnapshotRequest request)
Deletes the specified disk snapshot.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest request)
Deletes the specified domain recordset and all of its domain records.
|
DeleteDomainEntryResult |
deleteDomainEntry(DeleteDomainEntryRequest request)
Deletes a specific domain entry.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest request)
Deletes an Amazon Lightsail instance.
|
DeleteInstanceSnapshotResult |
deleteInstanceSnapshot(DeleteInstanceSnapshotRequest request)
Deletes a specific snapshot of a virtual private server (or instance).
|
DeleteKeyPairResult |
deleteKeyPair(DeleteKeyPairRequest request)
Deletes a specific SSH key pair.
|
DeleteKnownHostKeysResult |
deleteKnownHostKeys(DeleteKnownHostKeysRequest request)
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to
authenticate an instance.
|
DeleteLoadBalancerResult |
deleteLoadBalancer(DeleteLoadBalancerRequest request)
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.
|
DeleteLoadBalancerTlsCertificateResult |
deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest request)
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
|
DeleteRelationalDatabaseResult |
deleteRelationalDatabase(DeleteRelationalDatabaseRequest request)
Deletes a database in Amazon Lightsail.
|
DeleteRelationalDatabaseSnapshotResult |
deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest request)
Deletes a database snapshot in Amazon Lightsail.
|
DetachDiskResult |
detachDisk(DetachDiskRequest request)
Detaches a stopped block storage disk from a Lightsail instance.
|
DetachInstancesFromLoadBalancerResult |
detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest request)
Detaches the specified instances from a Lightsail load balancer.
|
DetachStaticIpResult |
detachStaticIp(DetachStaticIpRequest request)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
DisableAddOnResult |
disableAddOn(DisableAddOnRequest request)
Disables an add-on for an Amazon Lightsail resource.
|
DownloadDefaultKeyPairResult |
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest request)
Downloads the default SSH key pair from the user's account.
|
EnableAddOnResult |
enableAddOn(EnableAddOnRequest request)
Enables or modifies an add-on for an Amazon Lightsail resource.
|
ExportSnapshotResult |
exportSnapshot(ExportSnapshotRequest request)
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
|
GetActiveNamesResult |
getActiveNames(GetActiveNamesRequest request)
Returns the names of all active (not deleted) resources.
|
GetAutoSnapshotsResult |
getAutoSnapshots(GetAutoSnapshotsRequest request)
Returns the available automatic snapshots for the specified resource name.
|
GetBlueprintsResult |
getBlueprints(GetBlueprintsRequest request)
Returns the list of available instance images, or blueprints.
|
GetBundlesResult |
getBundles(GetBundlesRequest request)
Returns the list of bundles that are available for purchase.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCloudFormationStackRecordsResult |
getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest request)
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. |
GetDiskResult |
getDisk(GetDiskRequest request)
Returns information about a specific block storage disk.
|
GetDisksResult |
getDisks(GetDisksRequest request)
Returns information about all block storage disks in your AWS account and region.
|
GetDiskSnapshotResult |
getDiskSnapshot(GetDiskSnapshotRequest request)
Returns information about a specific block storage disk snapshot.
|
GetDiskSnapshotsResult |
getDiskSnapshots(GetDiskSnapshotsRequest request)
Returns information about all block storage disk snapshots in your AWS account and region.
|
GetDomainResult |
getDomain(GetDomainRequest request)
Returns information about a specific domain recordset.
|
GetDomainsResult |
getDomains(GetDomainsRequest request)
Returns a list of all domains in the user's account.
|
GetExportSnapshotRecordsResult |
getExportSnapshotRecords(GetExportSnapshotRecordsRequest request)
Returns the export snapshot record created as a result of the
export snapshot operation. |
GetInstanceResult |
getInstance(GetInstanceRequest request)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
|
GetInstanceAccessDetailsResult |
getInstanceAccessDetails(GetInstanceAccessDetailsRequest request)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
|
GetInstanceMetricDataResult |
getInstanceMetricData(GetInstanceMetricDataRequest request)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
|
GetInstancePortStatesResult |
getInstancePortStates(GetInstancePortStatesRequest request)
Returns the port states for a specific virtual private server, or instance.
|
GetInstancesResult |
getInstances(GetInstancesRequest request)
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
GetInstanceSnapshotResult |
getInstanceSnapshot(GetInstanceSnapshotRequest request)
Returns information about a specific instance snapshot.
|
GetInstanceSnapshotsResult |
getInstanceSnapshots(GetInstanceSnapshotsRequest request)
Returns all instance snapshots for the user's account.
|
GetInstanceStateResult |
getInstanceState(GetInstanceStateRequest request)
Returns the state of a specific instance.
|
GetKeyPairResult |
getKeyPair(GetKeyPairRequest request)
Returns information about a specific key pair.
|
GetKeyPairsResult |
getKeyPairs(GetKeyPairsRequest request)
Returns information about all key pairs in the user's account.
|
GetLoadBalancerResult |
getLoadBalancer(GetLoadBalancerRequest request)
Returns information about the specified Lightsail load balancer.
|
GetLoadBalancerMetricDataResult |
getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest request)
Returns information about health metrics for your Lightsail load balancer.
|
GetLoadBalancersResult |
getLoadBalancers(GetLoadBalancersRequest request)
Returns information about all load balancers in an account.
|
GetLoadBalancerTlsCertificatesResult |
getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest request)
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
|
GetOperationResult |
getOperation(GetOperationRequest request)
Returns information about a specific operation.
|
GetOperationsResult |
getOperations(GetOperationsRequest request)
Returns information about all operations.
|
GetOperationsForResourceResult |
getOperationsForResource(GetOperationsForResourceRequest request)
Gets operations for a specific resource (e.g., an instance or a static IP).
|
GetRegionsResult |
getRegions(GetRegionsRequest request)
Returns a list of all valid regions for Amazon Lightsail.
|
GetRelationalDatabaseResult |
getRelationalDatabase(GetRelationalDatabaseRequest request)
Returns information about a specific database in Amazon Lightsail.
|
GetRelationalDatabaseBlueprintsResult |
getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest request)
Returns a list of available database blueprints in Amazon Lightsail.
|
GetRelationalDatabaseBundlesResult |
getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest request)
Returns the list of bundles that are available in Amazon Lightsail.
|
GetRelationalDatabaseEventsResult |
getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest request)
Returns a list of events for a specific database in Amazon Lightsail.
|
GetRelationalDatabaseLogEventsResult |
getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest request)
Returns a list of log events for a database in Amazon Lightsail.
|
GetRelationalDatabaseLogStreamsResult |
getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest request)
Returns a list of available log streams for a specific database in Amazon Lightsail.
|
GetRelationalDatabaseMasterUserPasswordResult |
getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest request)
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
|
GetRelationalDatabaseMetricDataResult |
getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest request)
Returns the data points of the specified metric for a database in Amazon Lightsail.
|
GetRelationalDatabaseParametersResult |
getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest request)
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific
database in Amazon Lightsail.
|
GetRelationalDatabasesResult |
getRelationalDatabases(GetRelationalDatabasesRequest request)
Returns information about all of your databases in Amazon Lightsail.
|
GetRelationalDatabaseSnapshotResult |
getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest request)
Returns information about a specific database snapshot in Amazon Lightsail.
|
GetRelationalDatabaseSnapshotsResult |
getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest request)
Returns information about all of your database snapshots in Amazon Lightsail.
|
GetStaticIpResult |
getStaticIp(GetStaticIpRequest request)
Returns information about a specific static IP.
|
GetStaticIpsResult |
getStaticIps(GetStaticIpsRequest request)
Returns information about all static IPs in the user's account.
|
ImportKeyPairResult |
importKeyPair(ImportKeyPairRequest request)
Imports a public SSH key from a specific key pair.
|
IsVpcPeeredResult |
isVpcPeered(IsVpcPeeredRequest request)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
OpenInstancePublicPortsResult |
openInstancePublicPorts(OpenInstancePublicPortsRequest request)
Adds public ports to an Amazon Lightsail instance.
|
PeerVpcResult |
peerVpc(PeerVpcRequest request)
Tries to peer the Lightsail VPC with the user's default VPC.
|
PutInstancePublicPortsResult |
putInstancePublicPorts(PutInstancePublicPortsRequest request)
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not
included in the current request.
|
RebootInstanceResult |
rebootInstance(RebootInstanceRequest request)
Restarts a specific instance.
|
RebootRelationalDatabaseResult |
rebootRelationalDatabase(RebootRelationalDatabaseRequest request)
Restarts a specific database in Amazon Lightsail.
|
ReleaseStaticIpResult |
releaseStaticIp(ReleaseStaticIpRequest request)
Deletes a specific static IP from your account.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("lightsail.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonLightsail.setEndpoint(String), sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartInstanceResult |
startInstance(StartInstanceRequest request)
Starts a specific Amazon Lightsail instance from a stopped state.
|
StartRelationalDatabaseResult |
startRelationalDatabase(StartRelationalDatabaseRequest request)
Starts a specific database from a stopped state in Amazon Lightsail.
|
StopInstanceResult |
stopInstance(StopInstanceRequest request)
Stops a specific Amazon Lightsail instance that is currently running.
|
StopRelationalDatabaseResult |
stopRelationalDatabase(StopRelationalDatabaseRequest request)
Stops a specific database that is currently running in Amazon Lightsail.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to the specified Amazon Lightsail resource.
|
UnpeerVpcResult |
unpeerVpc(UnpeerVpcRequest request)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
|
UpdateDomainEntryResult |
updateDomainEntry(UpdateDomainEntryRequest request)
Updates a domain recordset after it is created.
|
UpdateLoadBalancerAttributeResult |
updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest request)
Updates the specified attribute for a load balancer.
|
UpdateRelationalDatabaseResult |
updateRelationalDatabase(UpdateRelationalDatabaseRequest request)
Allows the update of one or more attributes of a database in Amazon Lightsail.
|
UpdateRelationalDatabaseParametersResult |
updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest request)
Allows the update of one or more parameters of a database in Amazon Lightsail.
|
public void setEndpoint(String endpoint)
AmazonLightsail
Callers can pass in just the endpoint (ex: "lightsail.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "lightsail.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol
from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonLightsailendpoint - The endpoint (ex: "lightsail.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"lightsail.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AmazonLightsailAmazonLightsail.setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AmazonLightsailregion - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for accessing a given
region. Must not be null and must be a region where the service is available.Region#getRegion(com.amazonaws.regions.Regions),
Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public AllocateStaticIpResult allocateStaticIp(AllocateStaticIpRequest request)
AmazonLightsailAllocates a static IP address.
allocateStaticIp in interface AmazonLightsailpublic AttachDiskResult attachDisk(AttachDiskRequest request)
AmazonLightsailAttaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
The attach disk operation supports tag-based access control via resource tags applied to the
resource identified by disk name. For more information, see the Lightsail Dev Guide.
attachDisk in interface AmazonLightsailpublic AttachInstancesToLoadBalancerResult attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest request)
AmazonLightsailAttaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
The attach instances to load balancer operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
attachInstancesToLoadBalancer in interface AmazonLightsailpublic AttachLoadBalancerTlsCertificateResult attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest request)
AmazonLightsailAttaches 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 attach load balancer tls certificate operation
with the non-attached certificate, and it will replace the existing one and become the attached certificate.
The attach load balancer tls certificate operation supports tag-based access control via resource
tags applied to the resource identified by load balancer name. For more information, see the Lightsail
Dev Guide.
attachLoadBalancerTlsCertificate in interface AmazonLightsailpublic AttachStaticIpResult attachStaticIp(AttachStaticIpRequest request)
AmazonLightsailAttaches a static IP address to a specific Amazon Lightsail instance.
attachStaticIp in interface AmazonLightsailpublic CloseInstancePublicPortsResult closeInstancePublicPorts(CloseInstancePublicPortsRequest request)
AmazonLightsailCloses the public ports on a specific Amazon Lightsail instance.
The close instance public ports operation supports tag-based access control via resource tags
applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
closeInstancePublicPorts in interface AmazonLightsailpublic CopySnapshotResult copySnapshot(CopySnapshotRequest request)
AmazonLightsailCopies a manual instance or disk snapshot as another manual snapshot, or copies an automatic instance or disk snapshot as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.
When copying a manual snapshot, be sure to define the source region,
source snapshot name, and target snapshot name parameters.
When copying an automatic snapshot, be sure to define the source region,
source resource name, target snapshot name, and either the restore date or
the use latest restorable auto snapshot parameters.
Database snapshots cannot be copied at this time.
copySnapshot in interface AmazonLightsailpublic CreateCloudFormationStackResult createCloudFormationStack(CreateCloudFormationStackRequest request)
AmazonLightsail
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail
snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS
CloudFormation stack created. Use the get cloud formation stack records operation to get a list of
the CloudFormation stacks created.
Wait until after your new Amazon EC2 instance is created before running the
create cloud formation stack operation again with the same export snapshot record.
createCloudFormationStack in interface AmazonLightsailpublic CreateDiskResult createDisk(CreateDiskRequest request)
AmazonLightsail
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone
(e.g., us-east-2a).
The create disk operation supports tag-based access control via request tags. For more information,
see the Lightsail Dev Guide.
createDisk in interface AmazonLightsailpublic CreateDiskFromSnapshotResult createDiskFromSnapshot(CreateDiskFromSnapshotRequest request)
AmazonLightsail
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to
an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).
The create disk from snapshot operation supports tag-based access control via request tags and
resource tags applied to the resource identified by disk snapshot name. For more information, see
the
Lightsail Dev Guide.
createDiskFromSnapshot in interface AmazonLightsailpublic CreateDiskSnapshotResult createDiskSnapshot(CreateDiskSnapshotRequest request)
AmazonLightsailCreates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
You can also use this operation to create a snapshot of an instance's system volume. You might want to do this,
for example, to recover data from the system volume of a botched instance or to create a backup of the system
volume like you would for a block storage disk. To create a snapshot of a system volume, just define the
instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's
system volume will be created. After the snapshot is available, you can create a block storage disk from the
snapshot and attach it to a running instance to access the data on the disk.
The create disk snapshot operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createDiskSnapshot in interface AmazonLightsailpublic CreateDomainResult createDomain(CreateDomainRequest request)
AmazonLightsailCreates a domain resource for the specified domain (e.g., example.com).
The create domain operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createDomain in interface AmazonLightsailpublic CreateDomainEntryResult createDomainEntry(CreateDomainEntryRequest request)
AmazonLightsailCreates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The create domain entry operation supports tag-based access control via resource tags applied to the
resource identified by domain name. For more information, see the Lightsail Dev Guide.
createDomainEntry in interface AmazonLightsailpublic CreateInstanceSnapshotResult createInstanceSnapshot(CreateInstanceSnapshotRequest request)
AmazonLightsailCreates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
The create instance snapshot operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createInstanceSnapshot in interface AmazonLightsailpublic CreateInstancesResult createInstances(CreateInstancesRequest request)
AmazonLightsailCreates one or more Amazon Lightsail instances.
The create instances operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createInstances in interface AmazonLightsailpublic CreateInstancesFromSnapshotResult createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest request)
AmazonLightsailCreates one or more new instances from a manual or automatic snapshot of an instance.
The create instances from snapshot operation supports tag-based access control via request tags and
resource tags applied to the resource identified by instance snapshot name. For more information,
see the Lightsail Dev Guide.
createInstancesFromSnapshot in interface AmazonLightsailpublic CreateKeyPairResult createKeyPair(CreateKeyPairRequest request)
AmazonLightsailCreates an SSH key pair.
The create key pair operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createKeyPair in interface AmazonLightsailpublic CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest request)
AmazonLightsailCreates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port settings. To change additional load
balancer settings, use the UpdateLoadBalancerAttribute operation.
The create load balancer operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createLoadBalancer in interface AmazonLightsailpublic CreateLoadBalancerTlsCertificateResult createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest request)
AmazonLightsailCreates a Lightsail load balancer TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
The create load balancer tls certificate operation supports tag-based access control via resource
tags applied to the resource identified by load balancer name. For more information, see the Lightsail
Dev Guide.
createLoadBalancerTlsCertificate in interface AmazonLightsailpublic CreateRelationalDatabaseResult createRelationalDatabase(CreateRelationalDatabaseRequest request)
AmazonLightsailCreates a new database in Amazon Lightsail.
The create relational database operation supports tag-based access control via request tags. For
more information, see the Lightsail Dev Guide.
createRelationalDatabase in interface AmazonLightsailpublic CreateRelationalDatabaseFromSnapshotResult createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest request)
AmazonLightsailCreates a new database from an existing database snapshot in Amazon Lightsail.
You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.
The create relational database from snapshot operation supports tag-based access control via request
tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more
information, see the Lightsail Dev Guide.
createRelationalDatabaseFromSnapshot in interface AmazonLightsailpublic CreateRelationalDatabaseSnapshotResult createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest request)
AmazonLightsailCreates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.
The create relational database snapshot operation supports tag-based access control via request
tags. For more information, see the Lightsail Dev Guide.
createRelationalDatabaseSnapshot in interface AmazonLightsailpublic DeleteAutoSnapshotResult deleteAutoSnapshot(DeleteAutoSnapshotRequest request)
AmazonLightsailDeletes an automatic snapshot for an instance or disk.
deleteAutoSnapshot in interface AmazonLightsailpublic DeleteDiskResult deleteDisk(DeleteDiskRequest request)
AmazonLightsail
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.
The delete disk operation supports tag-based access control via resource tags applied to the
resource identified by disk name. For more information, see the Lightsail Dev Guide.
deleteDisk in interface AmazonLightsailpublic DeleteDiskSnapshotResult deleteDiskSnapshot(DeleteDiskSnapshotRequest request)
AmazonLightsailDeletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
The delete disk snapshot operation supports tag-based access control via resource tags applied to
the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide.
deleteDiskSnapshot in interface AmazonLightsailpublic DeleteDomainResult deleteDomain(DeleteDomainRequest request)
AmazonLightsailDeletes the specified domain recordset and all of its domain records.
The delete domain operation supports tag-based access control via resource tags applied to the
resource identified by domain name. For more information, see the Lightsail Dev Guide.
deleteDomain in interface AmazonLightsailpublic DeleteDomainEntryResult deleteDomainEntry(DeleteDomainEntryRequest request)
AmazonLightsailDeletes a specific domain entry.
The delete domain entry operation supports tag-based access control via resource tags applied to the
resource identified by domain name. For more information, see the Lightsail Dev Guide.
deleteDomainEntry in interface AmazonLightsailpublic DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
AmazonLightsailDeletes an Amazon Lightsail instance.
The delete instance operation supports tag-based access control via resource tags applied to the
resource identified by instance name. For more information, see the Lightsail Dev Guide.
deleteInstance in interface AmazonLightsailpublic DeleteInstanceSnapshotResult deleteInstanceSnapshot(DeleteInstanceSnapshotRequest request)
AmazonLightsailDeletes a specific snapshot of a virtual private server (or instance).
The delete instance snapshot operation supports tag-based access control via resource tags applied
to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide.
deleteInstanceSnapshot in interface AmazonLightsailpublic DeleteKeyPairResult deleteKeyPair(DeleteKeyPairRequest request)
AmazonLightsailDeletes a specific SSH key pair.
The delete key pair operation supports tag-based access control via resource tags applied to the
resource identified by key pair name. For more information, see the Lightsail Dev Guide.
deleteKeyPair in interface AmazonLightsailpublic DeleteKnownHostKeysResult deleteKnownHostKeys(DeleteKnownHostKeysRequest request)
AmazonLightsailDeletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.
Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.
deleteKnownHostKeys in interface AmazonLightsailpublic DeleteLoadBalancerResult deleteLoadBalancer(DeleteLoadBalancerRequest request)
AmazonLightsailDeletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.
The delete load balancer operation supports tag-based access control via resource tags applied to
the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
deleteLoadBalancer in interface AmazonLightsailpublic DeleteLoadBalancerTlsCertificateResult deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest request)
AmazonLightsailDeletes an SSL/TLS certificate associated with a Lightsail load balancer.
The delete load balancer tls certificate operation supports tag-based access control via resource
tags applied to the resource identified by load balancer name. For more information, see the Lightsail
Dev Guide.
deleteLoadBalancerTlsCertificate in interface AmazonLightsailpublic DeleteRelationalDatabaseResult deleteRelationalDatabase(DeleteRelationalDatabaseRequest request)
AmazonLightsailDeletes a database in Amazon Lightsail.
The delete relational database operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
deleteRelationalDatabase in interface AmazonLightsailpublic DeleteRelationalDatabaseSnapshotResult deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest request)
AmazonLightsailDeletes a database snapshot in Amazon Lightsail.
The delete relational database snapshot operation supports tag-based access control via resource
tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
deleteRelationalDatabaseSnapshot in interface AmazonLightsailpublic DetachDiskResult detachDisk(DetachDiskRequest request)
AmazonLightsailDetaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
The detach disk operation supports tag-based access control via resource tags applied to the
resource identified by disk name. For more information, see the Lightsail Dev Guide.
detachDisk in interface AmazonLightsailpublic DetachInstancesFromLoadBalancerResult detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest request)
AmazonLightsailDetaches the specified instances from a Lightsail load balancer.
This operation waits until the instances are no longer needed before they are detached from the load balancer.
The detach instances from load balancer operation supports tag-based access control via resource
tags applied to the resource identified by load balancer name. For more information, see the Lightsail
Dev Guide.
detachInstancesFromLoadBalancer in interface AmazonLightsailpublic DetachStaticIpResult detachStaticIp(DetachStaticIpRequest request)
AmazonLightsailDetaches a static IP from the Amazon Lightsail instance to which it is attached.
detachStaticIp in interface AmazonLightsailpublic DisableAddOnResult disableAddOn(DisableAddOnRequest request)
AmazonLightsailDisables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
disableAddOn in interface AmazonLightsailpublic DownloadDefaultKeyPairResult downloadDefaultKeyPair(DownloadDefaultKeyPairRequest request)
AmazonLightsailDownloads the default SSH key pair from the user's account.
downloadDefaultKeyPair in interface AmazonLightsailpublic EnableAddOnResult enableAddOn(EnableAddOnRequest request)
AmazonLightsailEnables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
enableAddOn in interface AmazonLightsailpublic ExportSnapshotResult exportSnapshot(ExportSnapshotRequest request)
AmazonLightsail
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
This operation results in an export snapshot record that can be used with the
create cloud formation stack operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.
The export snapshot operation supports tag-based access control via resource tags applied to the
resource identified by source snapshot name. For more information, see the Lightsail Dev Guide.
Use the get instance snapshots or get disk snapshots operations to get a list of
snapshots that you can export to Amazon EC2.
exportSnapshot in interface AmazonLightsailpublic GetActiveNamesResult getActiveNames(GetActiveNamesRequest request)
AmazonLightsailReturns the names of all active (not deleted) resources.
getActiveNames in interface AmazonLightsailpublic GetAutoSnapshotsResult getAutoSnapshots(GetAutoSnapshotsRequest request)
AmazonLightsailReturns the available automatic snapshots for the specified resource name. For more information, see the Lightsail Dev Guide.
getAutoSnapshots in interface AmazonLightsailpublic GetBlueprintsResult getBlueprints(GetBlueprintsRequest request)
AmazonLightsailReturns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
getBlueprints in interface AmazonLightsailpublic GetBundlesResult getBundles(GetBundlesRequest request)
AmazonLightsailReturns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
getBundles in interface AmazonLightsailpublic GetCloudFormationStackRecordsResult getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest request)
AmazonLightsail
Returns the CloudFormation stack record created as a result of the create cloud formation stack
operation.
An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.
getCloudFormationStackRecords in interface AmazonLightsailpublic GetDiskResult getDisk(GetDiskRequest request)
AmazonLightsailReturns information about a specific block storage disk.
getDisk in interface AmazonLightsailpublic GetDiskSnapshotResult getDiskSnapshot(GetDiskSnapshotRequest request)
AmazonLightsailReturns information about a specific block storage disk snapshot.
getDiskSnapshot in interface AmazonLightsailpublic GetDiskSnapshotsResult getDiskSnapshots(GetDiskSnapshotsRequest request)
AmazonLightsailReturns 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.
getDiskSnapshots in interface AmazonLightsailpublic GetDisksResult getDisks(GetDisksRequest request)
AmazonLightsailReturns 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.
getDisks in interface AmazonLightsailpublic GetDomainResult getDomain(GetDomainRequest request)
AmazonLightsailReturns information about a specific domain recordset.
getDomain in interface AmazonLightsailpublic GetDomainsResult getDomains(GetDomainsRequest request)
AmazonLightsailReturns a list of all domains in the user's account.
getDomains in interface AmazonLightsailpublic GetExportSnapshotRecordsResult getExportSnapshotRecords(GetExportSnapshotRecordsRequest request)
AmazonLightsail
Returns the export snapshot record created as a result of the export snapshot operation.
An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the
create cloud formation stack operation.
getExportSnapshotRecords in interface AmazonLightsailpublic GetInstanceResult getInstance(GetInstanceRequest request)
AmazonLightsailReturns information about a specific Amazon Lightsail instance, which is a virtual private server.
getInstance in interface AmazonLightsailpublic GetInstanceAccessDetailsResult getInstanceAccessDetails(GetInstanceAccessDetailsRequest request)
AmazonLightsailReturns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
The get instance access details operation supports tag-based access control via resource tags
applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
getInstanceAccessDetails in interface AmazonLightsailpublic GetInstanceMetricDataResult getInstanceMetricData(GetInstanceMetricDataRequest request)
AmazonLightsailReturns the data points for the specified Amazon Lightsail instance metric, given an instance name.
getInstanceMetricData in interface AmazonLightsailpublic GetInstancePortStatesResult getInstancePortStates(GetInstancePortStatesRequest request)
AmazonLightsailReturns the port states for a specific virtual private server, or instance.
getInstancePortStates in interface AmazonLightsailpublic GetInstanceSnapshotResult getInstanceSnapshot(GetInstanceSnapshotRequest request)
AmazonLightsailReturns information about a specific instance snapshot.
getInstanceSnapshot in interface AmazonLightsailpublic GetInstanceSnapshotsResult getInstanceSnapshots(GetInstanceSnapshotsRequest request)
AmazonLightsailReturns all instance snapshots for the user's account.
getInstanceSnapshots in interface AmazonLightsailpublic GetInstanceStateResult getInstanceState(GetInstanceStateRequest request)
AmazonLightsailReturns the state of a specific instance. Works on one instance at a time.
getInstanceState in interface AmazonLightsailpublic GetInstancesResult getInstances(GetInstancesRequest request)
AmazonLightsailReturns information about all Amazon Lightsail virtual private servers, or instances.
getInstances in interface AmazonLightsailpublic GetKeyPairResult getKeyPair(GetKeyPairRequest request)
AmazonLightsailReturns information about a specific key pair.
getKeyPair in interface AmazonLightsailpublic GetKeyPairsResult getKeyPairs(GetKeyPairsRequest request)
AmazonLightsailReturns information about all key pairs in the user's account.
getKeyPairs in interface AmazonLightsailpublic GetLoadBalancerResult getLoadBalancer(GetLoadBalancerRequest request)
AmazonLightsailReturns information about the specified Lightsail load balancer.
getLoadBalancer in interface AmazonLightsailpublic GetLoadBalancerMetricDataResult getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest request)
AmazonLightsailReturns information about health metrics for your Lightsail load balancer.
getLoadBalancerMetricData in interface AmazonLightsailpublic GetLoadBalancerTlsCertificatesResult getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest request)
AmazonLightsailReturns 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.
getLoadBalancerTlsCertificates in interface AmazonLightsailpublic GetLoadBalancersResult getLoadBalancers(GetLoadBalancersRequest request)
AmazonLightsailReturns 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.
getLoadBalancers in interface AmazonLightsailpublic GetOperationResult getOperation(GetOperationRequest request)
AmazonLightsailReturns 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.
getOperation in interface AmazonLightsailpublic GetOperationsResult getOperations(GetOperationsRequest request)
AmazonLightsailReturns 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.
getOperations in interface AmazonLightsailpublic GetOperationsForResourceResult getOperationsForResource(GetOperationsForResourceRequest request)
AmazonLightsailGets operations for a specific resource (e.g., an instance or a static IP).
getOperationsForResource in interface AmazonLightsailpublic GetRegionsResult getRegions(GetRegionsRequest request)
AmazonLightsail
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.
getRegions in interface AmazonLightsailpublic GetRelationalDatabaseResult getRelationalDatabase(GetRelationalDatabaseRequest request)
AmazonLightsailReturns information about a specific database in Amazon Lightsail.
getRelationalDatabase in interface AmazonLightsailpublic GetRelationalDatabaseBlueprintsResult getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest request)
AmazonLightsailReturns 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.
getRelationalDatabaseBlueprints in interface AmazonLightsailpublic GetRelationalDatabaseBundlesResult getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest request)
AmazonLightsailReturns 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.
getRelationalDatabaseBundles in interface AmazonLightsailpublic GetRelationalDatabaseEventsResult getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest request)
AmazonLightsailReturns a list of events for a specific database in Amazon Lightsail.
getRelationalDatabaseEvents in interface AmazonLightsailpublic GetRelationalDatabaseLogEventsResult getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest request)
AmazonLightsailReturns a list of log events for a database in Amazon Lightsail.
getRelationalDatabaseLogEvents in interface AmazonLightsailpublic GetRelationalDatabaseLogStreamsResult getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest request)
AmazonLightsailReturns a list of available log streams for a specific database in Amazon Lightsail.
getRelationalDatabaseLogStreams in interface AmazonLightsailpublic GetRelationalDatabaseMasterUserPasswordResult getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest request)
AmazonLightsailReturns the current, previous, or pending versions of the master user password for a Lightsail database.
The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource
tags applied to the resource identified by relationalDatabaseName.
getRelationalDatabaseMasterUserPassword in interface AmazonLightsailpublic GetRelationalDatabaseMetricDataResult getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest request)
AmazonLightsailReturns the data points of the specified metric for a database in Amazon Lightsail.
getRelationalDatabaseMetricData in interface AmazonLightsailpublic GetRelationalDatabaseParametersResult getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest request)
AmazonLightsailReturns 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.
getRelationalDatabaseParameters in interface AmazonLightsailpublic GetRelationalDatabaseSnapshotResult getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest request)
AmazonLightsailReturns information about a specific database snapshot in Amazon Lightsail.
getRelationalDatabaseSnapshot in interface AmazonLightsailpublic GetRelationalDatabaseSnapshotsResult getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest request)
AmazonLightsailReturns information about all of your database snapshots in Amazon Lightsail.
getRelationalDatabaseSnapshots in interface AmazonLightsailpublic GetRelationalDatabasesResult getRelationalDatabases(GetRelationalDatabasesRequest request)
AmazonLightsailReturns information about all of your databases in Amazon Lightsail.
getRelationalDatabases in interface AmazonLightsailpublic GetStaticIpResult getStaticIp(GetStaticIpRequest request)
AmazonLightsailReturns information about a specific static IP.
getStaticIp in interface AmazonLightsailpublic GetStaticIpsResult getStaticIps(GetStaticIpsRequest request)
AmazonLightsailReturns information about all static IPs in the user's account.
getStaticIps in interface AmazonLightsailpublic ImportKeyPairResult importKeyPair(ImportKeyPairRequest request)
AmazonLightsailImports a public SSH key from a specific key pair.
importKeyPair in interface AmazonLightsailpublic IsVpcPeeredResult isVpcPeered(IsVpcPeeredRequest request)
AmazonLightsailReturns a Boolean value indicating whether your Lightsail VPC is peered.
isVpcPeered in interface AmazonLightsailpublic OpenInstancePublicPortsResult openInstancePublicPorts(OpenInstancePublicPortsRequest request)
AmazonLightsailAdds public ports to an Amazon Lightsail instance.
The open instance public ports operation supports tag-based access control via resource tags applied
to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
openInstancePublicPorts in interface AmazonLightsailpublic PeerVpcResult peerVpc(PeerVpcRequest request)
AmazonLightsailTries to peer the Lightsail VPC with the user's default VPC.
peerVpc in interface AmazonLightsailpublic PutInstancePublicPortsResult putInstancePublicPorts(PutInstancePublicPortsRequest request)
AmazonLightsailSets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
The put instance public ports operation supports tag-based access control via resource tags applied
to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
putInstancePublicPorts in interface AmazonLightsailpublic RebootInstanceResult rebootInstance(RebootInstanceRequest request)
AmazonLightsailRestarts a specific instance.
The reboot instance operation supports tag-based access control via resource tags applied to the
resource identified by instance name. For more information, see the Lightsail Dev Guide.
rebootInstance in interface AmazonLightsailpublic RebootRelationalDatabaseResult rebootRelationalDatabase(RebootRelationalDatabaseRequest request)
AmazonLightsailRestarts a specific database in Amazon Lightsail.
The reboot relational database operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
rebootRelationalDatabase in interface AmazonLightsailpublic ReleaseStaticIpResult releaseStaticIp(ReleaseStaticIpRequest request)
AmazonLightsailDeletes a specific static IP from your account.
releaseStaticIp in interface AmazonLightsailpublic StartInstanceResult startInstance(StartInstanceRequest request)
AmazonLightsail
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the
reboot instance operation.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
The start instance operation supports tag-based access control via resource tags applied to the
resource identified by instance name. For more information, see the Lightsail Dev Guide.
startInstance in interface AmazonLightsailpublic StartRelationalDatabaseResult startRelationalDatabase(StartRelationalDatabaseRequest request)
AmazonLightsail
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the
reboot relational database operation.
The start relational database operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
startRelationalDatabase in interface AmazonLightsailpublic StopInstanceResult stopInstance(StopInstanceRequest request)
AmazonLightsailStops a specific Amazon Lightsail instance that is currently running.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
The stop instance operation supports tag-based access control via resource tags applied to the
resource identified by instance name. For more information, see the Lightsail Dev Guide.
stopInstance in interface AmazonLightsailpublic StopRelationalDatabaseResult stopRelationalDatabase(StopRelationalDatabaseRequest request)
AmazonLightsailStops a specific database that is currently running in Amazon Lightsail.
The stop relational database operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
stopRelationalDatabase in interface AmazonLightsailpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonLightsailAdds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide.
The tag resource operation supports tag-based access control via request tags and resource tags
applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide.
tagResource in interface AmazonLightsailpublic UnpeerVpcResult unpeerVpc(UnpeerVpcRequest request)
AmazonLightsailAttempts to unpeer the Lightsail VPC from the user's default VPC.
unpeerVpc in interface AmazonLightsailpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonLightsailDeletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
The untag resource operation supports tag-based access control via request tags and resource tags
applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide.
untagResource in interface AmazonLightsailpublic UpdateDomainEntryResult updateDomainEntry(UpdateDomainEntryRequest request)
AmazonLightsailUpdates a domain recordset after it is created.
The update domain entry operation supports tag-based access control via resource tags applied to the
resource identified by domain name. For more information, see the Lightsail Dev Guide.
updateDomainEntry in interface AmazonLightsailpublic UpdateLoadBalancerAttributeResult updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest request)
AmazonLightsailUpdates the specified attribute for a load balancer. You can only update one attribute at a time.
The update load balancer attribute operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
updateLoadBalancerAttribute in interface AmazonLightsailpublic UpdateRelationalDatabaseResult updateRelationalDatabase(UpdateRelationalDatabaseRequest request)
AmazonLightsailAllows 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.
The update relational database operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
updateRelationalDatabase in interface AmazonLightsailpublic UpdateRelationalDatabaseParametersResult updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest request)
AmazonLightsailAllows 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.
The update relational database parameters operation supports tag-based access control via resource
tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
updateRelationalDatabaseParameters in interface AmazonLightsailpublic void shutdown()
AmazonLightsailshutdown in interface AmazonLightsailpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonLightsailResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonLightsailrequest - The originally executed request.Copyright © 2019. All rights reserved.