@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 AmazonLightsail
endpoint
- 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)
AmazonLightsail
AmazonLightsail.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 AmazonLightsail
region
- 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)
AmazonLightsail
Allocates a static IP address.
allocateStaticIp
in interface AmazonLightsail
public AttachStaticIpResult attachStaticIp(AttachStaticIpRequest request)
AmazonLightsail
Attaches a static IP address to a specific Amazon Lightsail instance.
attachStaticIp
in interface AmazonLightsail
public CloseInstancePublicPortsResult closeInstancePublicPorts(CloseInstancePublicPortsRequest request)
AmazonLightsail
Closes the public ports on a specific Amazon Lightsail instance.
closeInstancePublicPorts
in interface AmazonLightsail
public CreateDomainResult createDomain(CreateDomainRequest request)
AmazonLightsail
Creates a domain resource for the specified domain (e.g., example.com).
createDomain
in interface AmazonLightsail
public CreateDomainEntryResult createDomainEntry(CreateDomainEntryRequest request)
AmazonLightsail
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
createDomainEntry
in interface AmazonLightsail
public CreateInstanceSnapshotResult createInstanceSnapshot(CreateInstanceSnapshotRequest request)
AmazonLightsail
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.
createInstanceSnapshot
in interface AmazonLightsail
public CreateInstancesResult createInstances(CreateInstancesRequest request)
AmazonLightsail
Creates one or more Amazon Lightsail virtual private servers, or instances.
createInstances
in interface AmazonLightsail
public CreateInstancesFromSnapshotResult createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest request)
AmazonLightsail
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
createInstancesFromSnapshot
in interface AmazonLightsail
public CreateKeyPairResult createKeyPair(CreateKeyPairRequest request)
AmazonLightsail
Creates sn SSH key pair.
createKeyPair
in interface AmazonLightsail
public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
AmazonLightsail
Deletes the specified domain recordset and all of its domain records.
deleteDomain
in interface AmazonLightsail
public DeleteDomainEntryResult deleteDomainEntry(DeleteDomainEntryRequest request)
AmazonLightsail
Deletes a specific domain entry.
deleteDomainEntry
in interface AmazonLightsail
public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
AmazonLightsail
Deletes a specific Amazon Lightsail virtual private server, or instance.
deleteInstance
in interface AmazonLightsail
public DeleteInstanceSnapshotResult deleteInstanceSnapshot(DeleteInstanceSnapshotRequest request)
AmazonLightsail
Deletes a specific snapshot of a virtual private server (or instance).
deleteInstanceSnapshot
in interface AmazonLightsail
public DeleteKeyPairResult deleteKeyPair(DeleteKeyPairRequest request)
AmazonLightsail
Deletes a specific SSH key pair.
deleteKeyPair
in interface AmazonLightsail
public DetachStaticIpResult detachStaticIp(DetachStaticIpRequest request)
AmazonLightsail
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
detachStaticIp
in interface AmazonLightsail
public DownloadDefaultKeyPairResult downloadDefaultKeyPair(DownloadDefaultKeyPairRequest request)
AmazonLightsail
Downloads the default SSH key pair from the user's account.
downloadDefaultKeyPair
in interface AmazonLightsail
public GetActiveNamesResult getActiveNames(GetActiveNamesRequest request)
AmazonLightsail
Returns the names of all active (not deleted) resources.
getActiveNames
in interface AmazonLightsail
public GetBlueprintsResult getBlueprints(GetBlueprintsRequest request)
AmazonLightsail
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.
getBlueprints
in interface AmazonLightsail
public GetBundlesResult getBundles(GetBundlesRequest request)
AmazonLightsail
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
getBundles
in interface AmazonLightsail
public GetDomainResult getDomain(GetDomainRequest request)
AmazonLightsail
Returns information about a specific domain recordset.
getDomain
in interface AmazonLightsail
public GetDomainsResult getDomains(GetDomainsRequest request)
AmazonLightsail
Returns a list of all domains in the user's account.
getDomains
in interface AmazonLightsail
public GetInstanceResult getInstance(GetInstanceRequest request)
AmazonLightsail
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
getInstance
in interface AmazonLightsail
public GetInstanceAccessDetailsResult getInstanceAccessDetails(GetInstanceAccessDetailsRequest request)
AmazonLightsail
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
getInstanceAccessDetails
in interface AmazonLightsail
public GetInstanceMetricDataResult getInstanceMetricData(GetInstanceMetricDataRequest request)
AmazonLightsail
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
getInstanceMetricData
in interface AmazonLightsail
public GetInstancePortStatesResult getInstancePortStates(GetInstancePortStatesRequest request)
AmazonLightsail
Returns the port states for a specific virtual private server, or instance.
getInstancePortStates
in interface AmazonLightsail
public GetInstanceSnapshotResult getInstanceSnapshot(GetInstanceSnapshotRequest request)
AmazonLightsail
Returns information about a specific instance snapshot.
getInstanceSnapshot
in interface AmazonLightsail
public GetInstanceSnapshotsResult getInstanceSnapshots(GetInstanceSnapshotsRequest request)
AmazonLightsail
Returns all instance snapshots for the user's account.
getInstanceSnapshots
in interface AmazonLightsail
public GetInstanceStateResult getInstanceState(GetInstanceStateRequest request)
AmazonLightsail
Returns the state of a specific instance. Works on one instance at a time.
getInstanceState
in interface AmazonLightsail
public GetInstancesResult getInstances(GetInstancesRequest request)
AmazonLightsail
Returns information about all Amazon Lightsail virtual private servers, or instances.
getInstances
in interface AmazonLightsail
public GetKeyPairResult getKeyPair(GetKeyPairRequest request)
AmazonLightsail
Returns information about a specific key pair.
getKeyPair
in interface AmazonLightsail
public GetKeyPairsResult getKeyPairs(GetKeyPairsRequest request)
AmazonLightsail
Returns information about all key pairs in the user's account.
getKeyPairs
in interface AmazonLightsail
public GetOperationResult getOperation(GetOperationRequest request)
AmazonLightsail
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.
getOperation
in interface AmazonLightsail
public GetOperationsResult getOperations(GetOperationsRequest request)
AmazonLightsail
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.
getOperations
in interface AmazonLightsail
public GetOperationsForResourceResult getOperationsForResource(GetOperationsForResourceRequest request)
AmazonLightsail
Gets operations for a specific resource (e.g., an instance or a static IP).
getOperationsForResource
in interface AmazonLightsail
public 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 AmazonLightsail
public GetStaticIpResult getStaticIp(GetStaticIpRequest request)
AmazonLightsail
Returns information about a specific static IP.
getStaticIp
in interface AmazonLightsail
public GetStaticIpsResult getStaticIps(GetStaticIpsRequest request)
AmazonLightsail
Returns information about all static IPs in the user's account.
getStaticIps
in interface AmazonLightsail
public ImportKeyPairResult importKeyPair(ImportKeyPairRequest request)
AmazonLightsail
Imports a public SSH key from a specific key pair.
importKeyPair
in interface AmazonLightsail
public IsVpcPeeredResult isVpcPeered(IsVpcPeeredRequest request)
AmazonLightsail
Returns a Boolean value indicating whether your Lightsail VPC is peered.
isVpcPeered
in interface AmazonLightsail
public OpenInstancePublicPortsResult openInstancePublicPorts(OpenInstancePublicPortsRequest request)
AmazonLightsail
Adds public ports to an Amazon Lightsail instance.
openInstancePublicPorts
in interface AmazonLightsail
public PeerVpcResult peerVpc(PeerVpcRequest request)
AmazonLightsail
Tries to peer the Lightsail VPC with the user's default VPC.
peerVpc
in interface AmazonLightsail
public PutInstancePublicPortsResult putInstancePublicPorts(PutInstancePublicPortsRequest request)
AmazonLightsail
Sets 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 AmazonLightsail
public RebootInstanceResult rebootInstance(RebootInstanceRequest request)
AmazonLightsail
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.
rebootInstance
in interface AmazonLightsail
public ReleaseStaticIpResult releaseStaticIp(ReleaseStaticIpRequest request)
AmazonLightsail
Deletes a specific static IP from your account.
releaseStaticIp
in interface AmazonLightsail
public StartInstanceResult startInstance(StartInstanceRequest request)
AmazonLightsail
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
startInstance
in interface AmazonLightsail
public StopInstanceResult stopInstance(StopInstanceRequest request)
AmazonLightsail
Stops a specific Amazon Lightsail instance that is currently running.
stopInstance
in interface AmazonLightsail
public UnpeerVpcResult unpeerVpc(UnpeerVpcRequest request)
AmazonLightsail
Attempts to unpeer the Lightsail VPC from the user's default VPC.
unpeerVpc
in interface AmazonLightsail
public UpdateDomainEntryResult updateDomainEntry(UpdateDomainEntryRequest request)
AmazonLightsail
Updates a domain recordset after it is created.
updateDomainEntry
in interface AmazonLightsail
public void shutdown()
AmazonLightsail
shutdown
in interface AmazonLightsail
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonLightsail
Response 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 AmazonLightsail
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.