@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.
|
AttachCertificateToDistributionResult |
attachCertificateToDistribution(AttachCertificateToDistributionRequest request)
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
|
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 ports for a specific Amazon Lightsail instance.
|
CopySnapshotResult |
copySnapshot(CopySnapshotRequest request)
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an
instance or disk as a manual snapshot.
|
CreateCertificateResult |
createCertificate(CreateCertificateRequest request)
Creates an SSL/TLS certificate for a Amazon Lightsail content delivery network (CDN) distribution.
|
CreateCloudFormationStackResult |
createCloudFormationStack(CreateCloudFormationStackRequest request)
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail
snapshot.
|
CreateContactMethodResult |
createContactMethod(CreateContactMethodRequest request)
Creates an email or SMS text message contact method.
|
CreateContainerServiceResult |
createContainerService(CreateContainerServiceRequest request)
Creates an Amazon Lightsail container service.
|
CreateContainerServiceDeploymentResult |
createContainerServiceDeployment(CreateContainerServiceDeploymentRequest request)
Creates a deployment for your Amazon Lightsail container service.
|
CreateContainerServiceRegistryLoginResult |
createContainerServiceRegistryLogin(CreateContainerServiceRegistryLoginRequest request)
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local
machine.
|
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.
|
CreateDistributionResult |
createDistribution(CreateDistributionRequest request)
Creates an Amazon Lightsail content delivery network (CDN) distribution.
|
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 domain name system (DNS) records in a domain DNS zone: 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.
|
DeleteAlarmResult |
deleteAlarm(DeleteAlarmRequest request)
Deletes an alarm.
|
DeleteAutoSnapshotResult |
deleteAutoSnapshot(DeleteAutoSnapshotRequest request)
Deletes an automatic snapshot of an instance or disk.
|
DeleteCertificateResult |
deleteCertificate(DeleteCertificateRequest request)
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
|
DeleteContactMethodResult |
deleteContactMethod(DeleteContactMethodRequest request)
Deletes a contact method.
|
DeleteContainerImageResult |
deleteContainerImage(DeleteContainerImageRequest request)
Deletes a container image that is registered to your Amazon Lightsail container service.
|
DeleteContainerServiceResult |
deleteContainerService(DeleteContainerServiceRequest request)
Deletes your Amazon Lightsail container service.
|
DeleteDiskResult |
deleteDisk(DeleteDiskRequest request)
Deletes the specified block storage disk.
|
DeleteDiskSnapshotResult |
deleteDiskSnapshot(DeleteDiskSnapshotRequest request)
Deletes the specified disk snapshot.
|
DeleteDistributionResult |
deleteDistribution(DeleteDistributionRequest request)
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
|
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.
|
DetachCertificateFromDistributionResult |
detachCertificateFromDistribution(DetachCertificateFromDistributionRequest request)
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
|
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.
|
GetAlarmsResult |
getAlarms(GetAlarmsRequest request)
Returns information about the configured alarms.
|
GetAutoSnapshotsResult |
getAutoSnapshots(GetAutoSnapshotsRequest request)
Returns the available automatic snapshots for an instance or disk.
|
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.
|
GetCertificatesResult |
getCertificates(GetCertificatesRequest request)
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
|
GetCloudFormationStackRecordsResult |
getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest request)
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. |
GetContactMethodsResult |
getContactMethods(GetContactMethodsRequest request)
Returns information about the configured contact methods.
|
GetContainerAPIMetadataResult |
getContainerAPIMetadata(GetContainerAPIMetadataRequest request)
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control
(lightsailctl) plugin.
|
GetContainerImagesResult |
getContainerImages(GetContainerImagesRequest request)
Returns the container images that are registered to your Amazon Lightsail container service.
|
GetContainerLogResult |
getContainerLog(GetContainerLogRequest request)
Returns the log events of a container of your Amazon Lightsail container service.
|
GetContainerServiceDeploymentsResult |
getContainerServiceDeployments(GetContainerServiceDeploymentsRequest request)
Returns the deployments for your Amazon Lightsail container service
|
GetContainerServiceMetricDataResult |
getContainerServiceMetricData(GetContainerServiceMetricDataRequest request)
Returns the data points of a specific metric of your Amazon Lightsail container service.
|
GetContainerServicePowersResult |
getContainerServicePowers(GetContainerServicePowersRequest request)
Returns the list of powers that can be specified for your Amazon Lightsail container services.
|
GetContainerServicesResult |
getContainerServices(GetContainerServicesRequest request)
Returns information about one or more of your Amazon Lightsail container services.
|
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.
|
GetDistributionBundlesResult |
getDistributionBundles(GetDistributionBundlesRequest request)
Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN)
distributions.
|
GetDistributionLatestCacheResetResult |
getDistributionLatestCacheReset(GetDistributionLatestCacheResetRequest request)
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network
(CDN) distribution.
|
GetDistributionMetricDataResult |
getDistributionMetricData(GetDistributionMetricDataRequest request)
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
|
GetDistributionsResult |
getDistributions(GetDistributionsRequest request)
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
|
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 firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to
the instance through the ports, and the protocol.
|
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)
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the
instance through the ports, and the protocol.
|
PeerVpcResult |
peerVpc(PeerVpcRequest request)
Tries to peer the Lightsail VPC with the user's default VPC.
|
PutAlarmResult |
putAlarm(PutAlarmRequest request)
Creates or updates an alarm, and associates it with the specified metric.
|
PutInstancePublicPortsResult |
putInstancePublicPorts(PutInstancePublicPortsRequest request)
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the
instance through the ports, and the protocol.
|
RebootInstanceResult |
rebootInstance(RebootInstanceRequest request)
Restarts a specific instance.
|
RebootRelationalDatabaseResult |
rebootRelationalDatabase(RebootRelationalDatabaseRequest request)
Restarts a specific database in Amazon Lightsail.
|
RegisterContainerImageResult |
registerContainerImage(RegisterContainerImageRequest request)
Registers a container image to your Amazon Lightsail container service.
|
ReleaseStaticIpResult |
releaseStaticIp(ReleaseStaticIpRequest request)
Deletes a specific static IP from your account.
|
ResetDistributionCacheResult |
resetDistributionCache(ResetDistributionCacheRequest request)
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
|
SendContactMethodVerificationResult |
sendContactMethodVerification(SendContactMethodVerificationRequest request)
Sends a verification request to an email contact method to ensure it's owned by the requester.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("lightsail.us-east-1.amazonaws.com").
|
SetIpAddressTypeResult |
setIpAddressType(SetIpAddressTypeRequest request)
Sets the IP address type for a Amazon Lightsail resource.
|
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.
|
TestAlarmResult |
testAlarm(TestAlarmRequest request)
Tests an alarm by displaying a banner on the Amazon Lightsail console.
|
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.
|
UpdateContainerServiceResult |
updateContainerService(UpdateContainerServiceRequest request)
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain
names.
|
UpdateDistributionResult |
updateDistribution(UpdateDistributionRequest request)
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
|
UpdateDistributionBundleResult |
updateDistributionBundle(UpdateDistributionBundleRequest request)
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
|
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 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 AttachCertificateToDistributionResult attachCertificateToDistribution(AttachCertificateToDistributionRequest request)
AmazonLightsail
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.
Use the CreateCertificate
action to create a certificate that you can attach to your distribution.
Only certificates created in the us-east-1
AWS Region can be attached to Lightsail distributions.
Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its
content globally. However, all distributions are located in the us-east-1
Region.
attachCertificateToDistribution
in interface AmazonLightsail
public AttachDiskResult attachDisk(AttachDiskRequest request)
AmazonLightsail
Attaches 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 AmazonLightsail
public AttachInstancesToLoadBalancerResult attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest request)
AmazonLightsail
Attaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
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 AmazonLightsail
public AttachLoadBalancerTlsCertificateResult attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest request)
AmazonLightsail
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API
to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate
action with the
non-attached certificate, and it will replace the existing one and become the attached certificate.
The AttachLoadBalancerTlsCertificate
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 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 ports for a specific Amazon Lightsail instance.
The CloseInstancePublicPorts
action supports tag-based access control via resource tags applied to
the resource identified by instanceName
. For more information, see the Lightsail Dev Guide.
closeInstancePublicPorts
in interface AmazonLightsail
public CopySnapshotResult copySnapshot(CopySnapshotRequest request)
AmazonLightsail
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk 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.
copySnapshot
in interface AmazonLightsail
public CreateCertificateResult createCertificate(CreateCertificateRequest request)
AmazonLightsail
Creates an SSL/TLS certificate for a Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is created, use the AttachCertificateToDistribution
action to attach the
certificate to your distribution.
Only certificates created in the us-east-1
AWS Region can be attached to Lightsail distributions.
Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its
content globally. However, all distributions are located in the us-east-1
Region.
createCertificate
in interface AmazonLightsail
public 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 AmazonLightsail
public CreateContactMethodResult createContactMethod(CreateContactMethodRequest request)
AmazonLightsail
Creates an email or SMS text message contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
createContactMethod
in interface AmazonLightsail
public CreateContainerServiceResult createContainerService(CreateContainerServiceRequest request)
AmazonLightsail
Creates an Amazon Lightsail container service.
A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.
createContainerService
in interface AmazonLightsail
public CreateContainerServiceDeploymentResult createContainerServiceDeployment(CreateContainerServiceDeploymentRequest request)
AmazonLightsail
Creates a deployment for your Amazon Lightsail container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from a public registry like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Lightsail Dev Guide.
createContainerServiceDeployment
in interface AmazonLightsail
public CreateContainerServiceRegistryLoginResult createContainerServiceRegistryLogin(CreateContainerServiceRegistryLoginRequest request)
AmazonLightsail
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.
You can only push container images to the container service registry of your Lightsail account. You cannot pull container images perform any other container image management actions on the container service registry of your Lightsail account.
After you push your container images to the container image registry of your Lightsail account, use the
RegisterContainerImage
action to register the pushed images to a specific Lightsail container
service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Lightsail Dev Guide.
createContainerServiceRegistryLogin
in interface AmazonLightsail
public 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 AmazonLightsail
public 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 AmazonLightsail
public CreateDiskSnapshotResult createDiskSnapshot(CreateDiskSnapshotRequest request)
AmazonLightsail
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
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 AmazonLightsail
public CreateDistributionResult createDistribution(CreateDistributionRequest request)
AmazonLightsail
Creates an Amazon Lightsail content delivery network (CDN) distribution.
A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.
createDistribution
in interface AmazonLightsail
public CreateDomainResult createDomain(CreateDomainRequest request)
AmazonLightsail
Creates 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 AmazonLightsail
public CreateDomainEntryResult createDomainEntry(CreateDomainEntryRequest request)
AmazonLightsail
Creates one of the following domain name system (DNS) records in a domain DNS zone: 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 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.
The create instance snapshot
operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createInstanceSnapshot
in interface AmazonLightsail
public CreateInstancesResult createInstances(CreateInstancesRequest request)
AmazonLightsail
Creates 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 AmazonLightsail
public CreateInstancesFromSnapshotResult createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest request)
AmazonLightsail
Creates 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 AmazonLightsail
public CreateKeyPairResult createKeyPair(CreateKeyPairRequest request)
AmazonLightsail
Creates 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 AmazonLightsail
public CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest request)
AmazonLightsail
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port settings. To change additional load
balancer settings, use the UpdateLoadBalancerAttribute
operation.
The create load balancer
operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createLoadBalancer
in interface AmazonLightsail
public CreateLoadBalancerTlsCertificateResult createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest request)
AmazonLightsail
Creates a Lightsail load balancer TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
The CreateLoadBalancerTlsCertificate
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 AmazonLightsail
public CreateRelationalDatabaseResult createRelationalDatabase(CreateRelationalDatabaseRequest request)
AmazonLightsail
Creates 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 AmazonLightsail
public CreateRelationalDatabaseFromSnapshotResult createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest request)
AmazonLightsail
Creates a new database from an existing database snapshot in Amazon Lightsail.
You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.
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 AmazonLightsail
public CreateRelationalDatabaseSnapshotResult createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest request)
AmazonLightsail
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.
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 AmazonLightsail
public DeleteAlarmResult deleteAlarm(DeleteAlarmRequest request)
AmazonLightsail
Deletes an alarm.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
deleteAlarm
in interface AmazonLightsail
public DeleteAutoSnapshotResult deleteAutoSnapshot(DeleteAutoSnapshotRequest request)
AmazonLightsail
Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
deleteAutoSnapshot
in interface AmazonLightsail
public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
AmazonLightsail
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
Certificates that are currently attached to a distribution cannot be deleted. Use the
DetachCertificateFromDistribution
action to detach a certificate from a distribution.
deleteCertificate
in interface AmazonLightsail
public DeleteContactMethodResult deleteContactMethod(DeleteContactMethodRequest request)
AmazonLightsail
Deletes a contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
deleteContactMethod
in interface AmazonLightsail
public DeleteContainerImageResult deleteContainerImage(DeleteContainerImageRequest request)
AmazonLightsail
Deletes a container image that is registered to your Amazon Lightsail container service.
deleteContainerImage
in interface AmazonLightsail
public DeleteContainerServiceResult deleteContainerService(DeleteContainerServiceRequest request)
AmazonLightsail
Deletes your Amazon Lightsail container service.
deleteContainerService
in interface AmazonLightsail
public 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 AmazonLightsail
public DeleteDiskSnapshotResult deleteDiskSnapshot(DeleteDiskSnapshotRequest request)
AmazonLightsail
Deletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
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 AmazonLightsail
public DeleteDistributionResult deleteDistribution(DeleteDistributionRequest request)
AmazonLightsail
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
deleteDistribution
in interface AmazonLightsail
public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
AmazonLightsail
Deletes 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 AmazonLightsail
public DeleteDomainEntryResult deleteDomainEntry(DeleteDomainEntryRequest request)
AmazonLightsail
Deletes 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 AmazonLightsail
public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
AmazonLightsail
Deletes 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 AmazonLightsail
public DeleteInstanceSnapshotResult deleteInstanceSnapshot(DeleteInstanceSnapshotRequest request)
AmazonLightsail
Deletes 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 AmazonLightsail
public DeleteKeyPairResult deleteKeyPair(DeleteKeyPairRequest request)
AmazonLightsail
Deletes 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 AmazonLightsail
public DeleteKnownHostKeysResult deleteKnownHostKeys(DeleteKnownHostKeysRequest request)
AmazonLightsail
Deletes 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 AmazonLightsail
public DeleteLoadBalancerResult deleteLoadBalancer(DeleteLoadBalancerRequest request)
AmazonLightsail
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.
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 AmazonLightsail
public DeleteLoadBalancerTlsCertificateResult deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest request)
AmazonLightsail
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
The DeleteLoadBalancerTlsCertificate
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 AmazonLightsail
public DeleteRelationalDatabaseResult deleteRelationalDatabase(DeleteRelationalDatabaseRequest request)
AmazonLightsail
Deletes 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 AmazonLightsail
public DeleteRelationalDatabaseSnapshotResult deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest request)
AmazonLightsail
Deletes 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 AmazonLightsail
public DetachCertificateFromDistributionResult detachCertificateFromDistribution(DetachCertificateFromDistributionRequest request)
AmazonLightsail
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.
detachCertificateFromDistribution
in interface AmazonLightsail
public DetachDiskResult detachDisk(DetachDiskRequest request)
AmazonLightsail
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
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 AmazonLightsail
public DetachInstancesFromLoadBalancerResult detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest request)
AmazonLightsail
Detaches the specified instances from a Lightsail load balancer.
This operation waits until the instances are no longer needed before they are detached from the load balancer.
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 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 DisableAddOnResult disableAddOn(DisableAddOnRequest request)
AmazonLightsail
Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
disableAddOn
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 EnableAddOnResult enableAddOn(EnableAddOnRequest request)
AmazonLightsail
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
enableAddOn
in interface AmazonLightsail
public 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 AmazonLightsail
public GetActiveNamesResult getActiveNames(GetActiveNamesRequest request)
AmazonLightsail
Returns the names of all active (not deleted) resources.
getActiveNames
in interface AmazonLightsail
public GetAlarmsResult getAlarms(GetAlarmsRequest request)
AmazonLightsail
Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
getAlarms
in interface AmazonLightsail
public GetAutoSnapshotsResult getAutoSnapshots(GetAutoSnapshotsRequest request)
AmazonLightsail
Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide.
getAutoSnapshots
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 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 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 GetCertificatesResult getCertificates(GetCertificatesRequest request)
AmazonLightsail
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
To get a summary of a certificate, ommit includeCertificateDetails
from your request. The response
will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
getCertificates
in interface AmazonLightsail
public 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 AmazonLightsail
public GetContactMethodsResult getContactMethods(GetContactMethodsRequest request)
AmazonLightsail
Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
getContactMethods
in interface AmazonLightsail
public GetContainerAPIMetadataResult getContainerAPIMetadata(GetContainerAPIMetadataRequest request)
AmazonLightsail
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
getContainerAPIMetadata
in interface AmazonLightsail
public GetContainerImagesResult getContainerImages(GetContainerImagesRequest request)
AmazonLightsail
Returns the container images that are registered to your Amazon Lightsail container service.
If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.
getContainerImages
in interface AmazonLightsail
public GetContainerLogResult getContainerLog(GetContainerLogRequest request)
AmazonLightsail
Returns the log events of a container of your Amazon Lightsail container service.
If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.
Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference.
getContainerLog
in interface AmazonLightsail
public GetContainerServiceDeploymentsResult getContainerServiceDeployments(GetContainerServiceDeploymentsRequest request)
AmazonLightsail
Returns the deployments for your Amazon Lightsail container service
A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.
A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference.
getContainerServiceDeployments
in interface AmazonLightsail
public GetContainerServiceMetricDataResult getContainerServiceMetricData(GetContainerServiceMetricDataRequest request)
AmazonLightsail
Returns the data points of a specific metric of your Amazon Lightsail container service.
Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getContainerServiceMetricData
in interface AmazonLightsail
public GetContainerServicePowersResult getContainerServicePowers(GetContainerServicePowersRequest request)
AmazonLightsail
Returns the list of powers that can be specified for your Amazon Lightsail container services.
The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.
getContainerServicePowers
in interface AmazonLightsail
public GetContainerServicesResult getContainerServices(GetContainerServicesRequest request)
AmazonLightsail
Returns information about one or more of your Amazon Lightsail container services.
getContainerServices
in interface AmazonLightsail
public GetDiskResult getDisk(GetDiskRequest request)
AmazonLightsail
Returns information about a specific block storage disk.
getDisk
in interface AmazonLightsail
public GetDiskSnapshotResult getDiskSnapshot(GetDiskSnapshotRequest request)
AmazonLightsail
Returns information about a specific block storage disk snapshot.
getDiskSnapshot
in interface AmazonLightsail
public GetDiskSnapshotsResult getDiskSnapshots(GetDiskSnapshotsRequest request)
AmazonLightsail
Returns information about all block storage disk snapshots in your AWS account and region.
getDiskSnapshots
in interface AmazonLightsail
public GetDisksResult getDisks(GetDisksRequest request)
AmazonLightsail
Returns information about all block storage disks in your AWS account and region.
getDisks
in interface AmazonLightsail
public GetDistributionBundlesResult getDistributionBundles(GetDistributionBundlesRequest request)
AmazonLightsail
Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.
getDistributionBundles
in interface AmazonLightsail
public GetDistributionLatestCacheResetResult getDistributionLatestCacheReset(GetDistributionLatestCacheResetRequest request)
AmazonLightsail
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
getDistributionLatestCacheReset
in interface AmazonLightsail
public GetDistributionMetricDataResult getDistributionMetricData(GetDistributionMetricDataRequest request)
AmazonLightsail
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getDistributionMetricData
in interface AmazonLightsail
public GetDistributionsResult getDistributions(GetDistributionsRequest request)
AmazonLightsail
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
getDistributions
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 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 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.
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 AmazonLightsail
public GetInstanceMetricDataResult getInstanceMetricData(GetInstanceMetricDataRequest request)
AmazonLightsail
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getInstanceMetricData
in interface AmazonLightsail
public GetInstancePortStatesResult getInstancePortStates(GetInstancePortStatesRequest request)
AmazonLightsail
Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
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 GetLoadBalancerResult getLoadBalancer(GetLoadBalancerRequest request)
AmazonLightsail
Returns information about the specified Lightsail load balancer.
getLoadBalancer
in interface AmazonLightsail
public GetLoadBalancerMetricDataResult getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest request)
AmazonLightsail
Returns information about health metrics for your Lightsail load balancer.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getLoadBalancerMetricData
in interface AmazonLightsail
public GetLoadBalancerTlsCertificatesResult getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest request)
AmazonLightsail
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
getLoadBalancerTlsCertificates
in interface AmazonLightsail
public GetLoadBalancersResult getLoadBalancers(GetLoadBalancersRequest request)
AmazonLightsail
Returns information about all load balancers in an account.
getLoadBalancers
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 GetRelationalDatabaseResult getRelationalDatabase(GetRelationalDatabaseRequest request)
AmazonLightsail
Returns information about a specific database in Amazon Lightsail.
getRelationalDatabase
in interface AmazonLightsail
public GetRelationalDatabaseBlueprintsResult getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest request)
AmazonLightsail
Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
You can use a blueprint ID to create a new database that runs a specific database engine.
getRelationalDatabaseBlueprints
in interface AmazonLightsail
public GetRelationalDatabaseBundlesResult getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest request)
AmazonLightsail
Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
You can use a bundle ID to create a new database with explicit performance specifications.
getRelationalDatabaseBundles
in interface AmazonLightsail
public GetRelationalDatabaseEventsResult getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest request)
AmazonLightsail
Returns a list of events for a specific database in Amazon Lightsail.
getRelationalDatabaseEvents
in interface AmazonLightsail
public GetRelationalDatabaseLogEventsResult getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest request)
AmazonLightsail
Returns a list of log events for a database in Amazon Lightsail.
getRelationalDatabaseLogEvents
in interface AmazonLightsail
public GetRelationalDatabaseLogStreamsResult getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest request)
AmazonLightsail
Returns a list of available log streams for a specific database in Amazon Lightsail.
getRelationalDatabaseLogStreams
in interface AmazonLightsail
public GetRelationalDatabaseMasterUserPasswordResult getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest request)
AmazonLightsail
Returns 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 AmazonLightsail
public GetRelationalDatabaseMetricDataResult getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest request)
AmazonLightsail
Returns the data points of the specified metric for a database in Amazon Lightsail.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getRelationalDatabaseMetricData
in interface AmazonLightsail
public GetRelationalDatabaseParametersResult getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest request)
AmazonLightsail
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
getRelationalDatabaseParameters
in interface AmazonLightsail
public GetRelationalDatabaseSnapshotResult getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest request)
AmazonLightsail
Returns information about a specific database snapshot in Amazon Lightsail.
getRelationalDatabaseSnapshot
in interface AmazonLightsail
public GetRelationalDatabaseSnapshotsResult getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest request)
AmazonLightsail
Returns information about all of your database snapshots in Amazon Lightsail.
getRelationalDatabaseSnapshots
in interface AmazonLightsail
public GetRelationalDatabasesResult getRelationalDatabases(GetRelationalDatabasesRequest request)
AmazonLightsail
Returns information about all of your databases in Amazon Lightsail.
getRelationalDatabases
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
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.
The OpenInstancePublicPorts
action supports tag-based access control via resource tags applied to
the resource identified by instanceName
. For more information, see the Lightsail Dev Guide.
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 PutAlarmResult putAlarm(PutAlarmRequest request)
AmazonLightsail
Creates or updates an alarm, and associates it with the specified metric.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA
. The
alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
putAlarm
in interface AmazonLightsail
public PutInstancePublicPortsResult putInstancePublicPorts(PutInstancePublicPortsRequest request)
AmazonLightsail
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the
instance through the ports, and the protocol. This action also closes all currently open ports that are not
included in the request. Include all of the ports and the protocols you want to open in your
PutInstancePublicPorts
request. Or use the OpenInstancePublicPorts
action to open ports
without closing currently open ports.
The PutInstancePublicPorts
action supports tag-based access control via resource tags applied to the
resource identified by instanceName
. For more information, see the Lightsail Dev Guide.
putInstancePublicPorts
in interface AmazonLightsail
public RebootInstanceResult rebootInstance(RebootInstanceRequest request)
AmazonLightsail
Restarts 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 AmazonLightsail
public RebootRelationalDatabaseResult rebootRelationalDatabase(RebootRelationalDatabaseRequest request)
AmazonLightsail
Restarts 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 AmazonLightsail
public RegisterContainerImageResult registerContainerImage(RegisterContainerImageRequest request)
AmazonLightsail
Registers a container image to your Amazon Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Lightsail Dev Guide.
registerContainerImage
in interface AmazonLightsail
public ReleaseStaticIpResult releaseStaticIp(ReleaseStaticIpRequest request)
AmazonLightsail
Deletes a specific static IP from your account.
releaseStaticIp
in interface AmazonLightsail
public ResetDistributionCacheResult resetDistributionCache(ResetDistributionCacheRequest request)
AmazonLightsail
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.
resetDistributionCache
in interface AmazonLightsail
public SendContactMethodVerificationResult sendContactMethodVerification(SendContactMethodVerificationRequest request)
AmazonLightsail
Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.
Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
sendContactMethodVerification
in interface AmazonLightsail
public SetIpAddressTypeResult setIpAddressType(SetIpAddressTypeRequest request)
AmazonLightsail
Sets the IP address type for a Amazon Lightsail resource.
Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.
setIpAddressType
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.
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 AmazonLightsail
public 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 AmazonLightsail
public StopInstanceResult stopInstance(StopInstanceRequest request)
AmazonLightsail
Stops 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 AmazonLightsail
public StopRelationalDatabaseResult stopRelationalDatabase(StopRelationalDatabaseRequest request)
AmazonLightsail
Stops 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 AmazonLightsail
public TagResourceResult tagResource(TagResourceRequest request)
AmazonLightsail
Adds 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 AmazonLightsail
public TestAlarmResult testAlarm(TestAlarmRequest request)
AmazonLightsail
Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured
for the specified alarm, the test also sends a notification to the notification protocol (Email
and/or SMS
) configured for the alarm.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
testAlarm
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 UntagResourceResult untagResource(UntagResourceRequest request)
AmazonLightsail
Deletes 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 AmazonLightsail
public UpdateContainerServiceResult updateContainerService(UpdateContainerServiceRequest request)
AmazonLightsail
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
updateContainerService
in interface AmazonLightsail
public UpdateDistributionResult updateDistribution(UpdateDistributionRequest request)
AmazonLightsail
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distribution
updateDistribution
in interface AmazonLightsail
public UpdateDistributionBundleResult updateDistributionBundle(UpdateDistributionBundleRequest request)
AmazonLightsail
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.
Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.
You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if
you can update your distribution's bundle, use the GetDistributions
action. The
ableToUpdateBundle
parameter in the result will indicate whether you can currently update your
distribution's bundle.
updateDistributionBundle
in interface AmazonLightsail
public UpdateDomainEntryResult updateDomainEntry(UpdateDomainEntryRequest request)
AmazonLightsail
Updates 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 AmazonLightsail
public UpdateLoadBalancerAttributeResult updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest request)
AmazonLightsail
Updates 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 AmazonLightsail
public UpdateRelationalDatabaseResult updateRelationalDatabase(UpdateRelationalDatabaseRequest request)
AmazonLightsail
Allows the update of one or more attributes of a database in Amazon Lightsail.
Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.
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 AmazonLightsail
public UpdateRelationalDatabaseParametersResult updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest request)
AmazonLightsail
Allows the update of one or more parameters of a database in Amazon Lightsail.
Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance
window. However, there are two ways in which parameter 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 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.