@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 and Type | Method and Description |
|---|---|
AllocateStaticIpResult |
allocateStaticIp(AllocateStaticIpRequest request)
Allocates a static IP address.
|
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.
|
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: A record, CNAME record, TXT record, or MX
record.
|
CreateInstancesResult |
createInstances(CreateInstancesRequest request)
Creates one or more Amazon Lightsail virtual private servers, or instances.
|
CreateInstancesFromSnapshotResult |
createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest request)
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical
configuration.
|
CreateInstanceSnapshotResult |
createInstanceSnapshot(CreateInstanceSnapshotRequest request)
Creates a snapshot of a specific virtual private server, or instance.
|
CreateKeyPairResult |
createKeyPair(CreateKeyPairRequest request)
Creates sn SSH key pair.
|
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 a specific Amazon Lightsail virtual private server, or 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.
|
DetachStaticIpResult |
detachStaticIp(DetachStaticIpRequest request)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
DownloadDefaultKeyPairResult |
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest request)
Downloads the default SSH key pair from the user's account.
|
GetActiveNamesResult |
getActiveNames(GetActiveNamesRequest request)
Returns the names of all active (not deleted) resources.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
StopInstanceResult |
stopInstance(StopInstanceRequest request)
Stops a specific Amazon Lightsail instance that is currently running.
|
UnpeerVpcResult |
unpeerVpc(UnpeerVpcRequest request)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
UpdateDomainEntryResult |
updateDomainEntry(UpdateDomainEntryRequest request)
Updates a domain recordset after it is created.
|
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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
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 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.
closeInstancePublicPorts in interface AmazonLightsailpublic CreateDomainResult createDomain(CreateDomainRequest request)
AmazonLightsailCreates a domain resource for the specified domain (e.g., example.com).
createDomain in interface AmazonLightsailpublic CreateDomainEntryResult createDomainEntry(CreateDomainEntryRequest request)
AmazonLightsailCreates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
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.
createInstanceSnapshot in interface AmazonLightsailpublic CreateInstancesResult createInstances(CreateInstancesRequest request)
AmazonLightsailCreates one or more Amazon Lightsail virtual private servers, or instances.
createInstances in interface AmazonLightsailpublic CreateInstancesFromSnapshotResult createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest request)
AmazonLightsailUses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
createInstancesFromSnapshot in interface AmazonLightsailpublic CreateKeyPairResult createKeyPair(CreateKeyPairRequest request)
AmazonLightsailCreates sn SSH key pair.
createKeyPair in interface AmazonLightsailpublic DeleteDomainResult deleteDomain(DeleteDomainRequest request)
AmazonLightsailDeletes the specified domain recordset and all of its domain records.
deleteDomain in interface AmazonLightsailpublic DeleteDomainEntryResult deleteDomainEntry(DeleteDomainEntryRequest request)
AmazonLightsailDeletes a specific domain entry.
deleteDomainEntry in interface AmazonLightsailpublic DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
AmazonLightsailDeletes a specific Amazon Lightsail virtual private server, or instance.
deleteInstance in interface AmazonLightsailpublic DeleteInstanceSnapshotResult deleteInstanceSnapshot(DeleteInstanceSnapshotRequest request)
AmazonLightsailDeletes a specific snapshot of a virtual private server (or instance).
deleteInstanceSnapshot in interface AmazonLightsailpublic DeleteKeyPairResult deleteKeyPair(DeleteKeyPairRequest request)
AmazonLightsailDeletes a specific SSH key pair.
deleteKeyPair 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 DownloadDefaultKeyPairResult downloadDefaultKeyPair(DownloadDefaultKeyPairRequest request)
AmazonLightsailDownloads the default SSH key pair from the user's account.
downloadDefaultKeyPair in interface AmazonLightsailpublic GetActiveNamesResult getActiveNames(GetActiveNamesRequest request)
AmazonLightsailReturns the names of all active (not deleted) resources.
getActiveNames 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 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.
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 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 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.
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 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 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.
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.
putInstancePublicPorts in interface AmazonLightsailpublic RebootInstanceResult rebootInstance(RebootInstanceRequest request)
AmazonLightsailRestarts 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.
rebootInstance in interface AmazonLightsailpublic ReleaseStaticIpResult releaseStaticIp(ReleaseStaticIpRequest request)
AmazonLightsailDeletes a specific static IP from your account.
releaseStaticIp in interface AmazonLightsailpublic StartInstanceResult startInstance(StartInstanceRequest request)
AmazonLightsailStarts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
startInstance in interface AmazonLightsailpublic StopInstanceResult stopInstance(StopInstanceRequest request)
AmazonLightsailStops a specific Amazon Lightsail instance that is currently running.
stopInstance in interface AmazonLightsailpublic UnpeerVpcResult unpeerVpc(UnpeerVpcRequest request)
AmazonLightsailAttempts to unpeer the Lightsail VPC from the user's default VPC.
unpeerVpc in interface AmazonLightsailpublic UpdateDomainEntryResult updateDomainEntry(UpdateDomainEntryRequest request)
AmazonLightsailUpdates a domain recordset after it is created.
updateDomainEntry 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 © 2013 Amazon Web Services, Inc. All Rights Reserved.