@Generated(value="software.amazon.awssdk:codegen") public interface LightsailAsyncClient extends SdkClient
builder()
method.
Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported AWS Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the AWS General Reference.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AllocateStaticIpResponse> |
allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest)
Allocates a static IP address.
|
default CompletableFuture<AllocateStaticIpResponse> |
allocateStaticIp(Consumer<AllocateStaticIpRequest.Builder> allocateStaticIpRequest)
Allocates a static IP address.
|
default CompletableFuture<AttachCertificateToDistributionResponse> |
attachCertificateToDistribution(AttachCertificateToDistributionRequest attachCertificateToDistributionRequest)
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<AttachCertificateToDistributionResponse> |
attachCertificateToDistribution(Consumer<AttachCertificateToDistributionRequest.Builder> attachCertificateToDistributionRequest)
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<AttachDiskResponse> |
attachDisk(AttachDiskRequest attachDiskRequest)
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the
specified disk name.
|
default CompletableFuture<AttachDiskResponse> |
attachDisk(Consumer<AttachDiskRequest.Builder> attachDiskRequest)
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the
specified disk name.
|
default CompletableFuture<AttachInstancesToLoadBalancerResponse> |
attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest attachInstancesToLoadBalancerRequest)
Attaches one or more Lightsail instances to a load balancer.
|
default CompletableFuture<AttachInstancesToLoadBalancerResponse> |
attachInstancesToLoadBalancer(Consumer<AttachInstancesToLoadBalancerRequest.Builder> attachInstancesToLoadBalancerRequest)
Attaches one or more Lightsail instances to a load balancer.
|
default CompletableFuture<AttachLoadBalancerTlsCertificateResponse> |
attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest attachLoadBalancerTlsCertificateRequest)
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
|
default CompletableFuture<AttachLoadBalancerTlsCertificateResponse> |
attachLoadBalancerTlsCertificate(Consumer<AttachLoadBalancerTlsCertificateRequest.Builder> attachLoadBalancerTlsCertificateRequest)
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
|
default CompletableFuture<AttachStaticIpResponse> |
attachStaticIp(AttachStaticIpRequest attachStaticIpRequest)
Attaches a static IP address to a specific Amazon Lightsail instance.
|
default CompletableFuture<AttachStaticIpResponse> |
attachStaticIp(Consumer<AttachStaticIpRequest.Builder> attachStaticIpRequest)
Attaches a static IP address to a specific Amazon Lightsail instance.
|
static LightsailAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
LightsailAsyncClient . |
default CompletableFuture<CloseInstancePublicPortsResponse> |
closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest)
Closes ports for a specific Amazon Lightsail instance.
|
default CompletableFuture<CloseInstancePublicPortsResponse> |
closeInstancePublicPorts(Consumer<CloseInstancePublicPortsRequest.Builder> closeInstancePublicPortsRequest)
Closes ports for a specific Amazon Lightsail instance.
|
default CompletableFuture<CopySnapshotResponse> |
copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest)
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.
|
default CompletableFuture<CopySnapshotResponse> |
copySnapshot(CopySnapshotRequest copySnapshotRequest)
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.
|
static LightsailAsyncClient |
create()
Create a
LightsailAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateCertificateResponse> |
createCertificate(Consumer<CreateCertificateRequest.Builder> createCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a
container service.
|
default CompletableFuture<CreateCertificateResponse> |
createCertificate(CreateCertificateRequest createCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a
container service.
|
default CompletableFuture<CreateCloudFormationStackResponse> |
createCloudFormationStack(Consumer<CreateCloudFormationStackRequest.Builder> createCloudFormationStackRequest)
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail
snapshot.
|
default CompletableFuture<CreateCloudFormationStackResponse> |
createCloudFormationStack(CreateCloudFormationStackRequest createCloudFormationStackRequest)
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail
snapshot.
|
default CompletableFuture<CreateContactMethodResponse> |
createContactMethod(Consumer<CreateContactMethodRequest.Builder> createContactMethodRequest)
Creates an email or SMS text message contact method.
|
default CompletableFuture<CreateContactMethodResponse> |
createContactMethod(CreateContactMethodRequest createContactMethodRequest)
Creates an email or SMS text message contact method.
|
default CompletableFuture<CreateContainerServiceResponse> |
createContainerService(Consumer<CreateContainerServiceRequest.Builder> createContainerServiceRequest)
Creates an Amazon Lightsail container service.
|
default CompletableFuture<CreateContainerServiceResponse> |
createContainerService(CreateContainerServiceRequest createContainerServiceRequest)
Creates an Amazon Lightsail container service.
|
default CompletableFuture<CreateContainerServiceDeploymentResponse> |
createContainerServiceDeployment(Consumer<CreateContainerServiceDeploymentRequest.Builder> createContainerServiceDeploymentRequest)
Creates a deployment for your Amazon Lightsail container service.
|
default CompletableFuture<CreateContainerServiceDeploymentResponse> |
createContainerServiceDeployment(CreateContainerServiceDeploymentRequest createContainerServiceDeploymentRequest)
Creates a deployment for your Amazon Lightsail container service.
|
default CompletableFuture<CreateContainerServiceRegistryLoginResponse> |
createContainerServiceRegistryLogin(Consumer<CreateContainerServiceRegistryLoginRequest.Builder> createContainerServiceRegistryLoginRequest)
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local
machine.
|
default CompletableFuture<CreateContainerServiceRegistryLoginResponse> |
createContainerServiceRegistryLogin(CreateContainerServiceRegistryLoginRequest createContainerServiceRegistryLoginRequest)
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local
machine.
|
default CompletableFuture<CreateDiskResponse> |
createDisk(Consumer<CreateDiskRequest.Builder> createDiskRequest)
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone
(e.g.,
us-east-2a ). |
default CompletableFuture<CreateDiskResponse> |
createDisk(CreateDiskRequest createDiskRequest)
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone
(e.g.,
us-east-2a ). |
default CompletableFuture<CreateDiskFromSnapshotResponse> |
createDiskFromSnapshot(Consumer<CreateDiskFromSnapshotRequest.Builder> createDiskFromSnapshotRequest)
Creates a block storage disk from a manual or automatic snapshot of a disk.
|
default CompletableFuture<CreateDiskFromSnapshotResponse> |
createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest)
Creates a block storage disk from a manual or automatic snapshot of a disk.
|
default CompletableFuture<CreateDiskSnapshotResponse> |
createDiskSnapshot(Consumer<CreateDiskSnapshotRequest.Builder> createDiskSnapshotRequest)
Creates a snapshot of a block storage disk.
|
default CompletableFuture<CreateDiskSnapshotResponse> |
createDiskSnapshot(CreateDiskSnapshotRequest createDiskSnapshotRequest)
Creates a snapshot of a block storage disk.
|
default CompletableFuture<CreateDistributionResponse> |
createDistribution(Consumer<CreateDistributionRequest.Builder> createDistributionRequest)
Creates an Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<CreateDistributionResponse> |
createDistribution(CreateDistributionRequest createDistributionRequest)
Creates an Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<CreateDomainResponse> |
createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)
Creates a domain resource for the specified domain (e.g., example.com).
|
default CompletableFuture<CreateDomainResponse> |
createDomain(CreateDomainRequest createDomainRequest)
Creates a domain resource for the specified domain (e.g., example.com).
|
default CompletableFuture<CreateDomainEntryResponse> |
createDomainEntry(Consumer<CreateDomainEntryRequest.Builder> createDomainEntryRequest)
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).
|
default CompletableFuture<CreateDomainEntryResponse> |
createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest)
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).
|
default CompletableFuture<CreateInstancesResponse> |
createInstances(Consumer<CreateInstancesRequest.Builder> createInstancesRequest)
Creates one or more Amazon Lightsail instances.
|
default CompletableFuture<CreateInstancesResponse> |
createInstances(CreateInstancesRequest createInstancesRequest)
Creates one or more Amazon Lightsail instances.
|
default CompletableFuture<CreateInstancesFromSnapshotResponse> |
createInstancesFromSnapshot(Consumer<CreateInstancesFromSnapshotRequest.Builder> createInstancesFromSnapshotRequest)
Creates one or more new instances from a manual or automatic snapshot of an instance.
|
default CompletableFuture<CreateInstancesFromSnapshotResponse> |
createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest)
Creates one or more new instances from a manual or automatic snapshot of an instance.
|
default CompletableFuture<CreateInstanceSnapshotResponse> |
createInstanceSnapshot(Consumer<CreateInstanceSnapshotRequest.Builder> createInstanceSnapshotRequest)
Creates a snapshot of a specific virtual private server, or instance.
|
default CompletableFuture<CreateInstanceSnapshotResponse> |
createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest)
Creates a snapshot of a specific virtual private server, or instance.
|
default CompletableFuture<CreateKeyPairResponse> |
createKeyPair(Consumer<CreateKeyPairRequest.Builder> createKeyPairRequest)
Creates an SSH key pair.
|
default CompletableFuture<CreateKeyPairResponse> |
createKeyPair(CreateKeyPairRequest createKeyPairRequest)
Creates an SSH key pair.
|
default CompletableFuture<CreateLoadBalancerResponse> |
createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest)
Creates a Lightsail load balancer.
|
default CompletableFuture<CreateLoadBalancerResponse> |
createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
Creates a Lightsail load balancer.
|
default CompletableFuture<CreateLoadBalancerTlsCertificateResponse> |
createLoadBalancerTlsCertificate(Consumer<CreateLoadBalancerTlsCertificateRequest.Builder> createLoadBalancerTlsCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
|
default CompletableFuture<CreateLoadBalancerTlsCertificateResponse> |
createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest createLoadBalancerTlsCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
|
default CompletableFuture<CreateRelationalDatabaseResponse> |
createRelationalDatabase(Consumer<CreateRelationalDatabaseRequest.Builder> createRelationalDatabaseRequest)
Creates a new database in Amazon Lightsail.
|
default CompletableFuture<CreateRelationalDatabaseResponse> |
createRelationalDatabase(CreateRelationalDatabaseRequest createRelationalDatabaseRequest)
Creates a new database in Amazon Lightsail.
|
default CompletableFuture<CreateRelationalDatabaseFromSnapshotResponse> |
createRelationalDatabaseFromSnapshot(Consumer<CreateRelationalDatabaseFromSnapshotRequest.Builder> createRelationalDatabaseFromSnapshotRequest)
Creates a new database from an existing database snapshot in Amazon Lightsail.
|
default CompletableFuture<CreateRelationalDatabaseFromSnapshotResponse> |
createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest createRelationalDatabaseFromSnapshotRequest)
Creates a new database from an existing database snapshot in Amazon Lightsail.
|
default CompletableFuture<CreateRelationalDatabaseSnapshotResponse> |
createRelationalDatabaseSnapshot(Consumer<CreateRelationalDatabaseSnapshotRequest.Builder> createRelationalDatabaseSnapshotRequest)
Creates a snapshot of your database in Amazon Lightsail.
|
default CompletableFuture<CreateRelationalDatabaseSnapshotResponse> |
createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest createRelationalDatabaseSnapshotRequest)
Creates a snapshot of your database in Amazon Lightsail.
|
default CompletableFuture<DeleteAlarmResponse> |
deleteAlarm(Consumer<DeleteAlarmRequest.Builder> deleteAlarmRequest)
Deletes an alarm.
|
default CompletableFuture<DeleteAlarmResponse> |
deleteAlarm(DeleteAlarmRequest deleteAlarmRequest)
Deletes an alarm.
|
default CompletableFuture<DeleteAutoSnapshotResponse> |
deleteAutoSnapshot(Consumer<DeleteAutoSnapshotRequest.Builder> deleteAutoSnapshotRequest)
Deletes an automatic snapshot of an instance or disk.
|
default CompletableFuture<DeleteAutoSnapshotResponse> |
deleteAutoSnapshot(DeleteAutoSnapshotRequest deleteAutoSnapshotRequest)
Deletes an automatic snapshot of an instance or disk.
|
default CompletableFuture<DeleteCertificateResponse> |
deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<DeleteCertificateResponse> |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<DeleteContactMethodResponse> |
deleteContactMethod(Consumer<DeleteContactMethodRequest.Builder> deleteContactMethodRequest)
Deletes a contact method.
|
default CompletableFuture<DeleteContactMethodResponse> |
deleteContactMethod(DeleteContactMethodRequest deleteContactMethodRequest)
Deletes a contact method.
|
default CompletableFuture<DeleteContainerImageResponse> |
deleteContainerImage(Consumer<DeleteContainerImageRequest.Builder> deleteContainerImageRequest)
Deletes a container image that is registered to your Amazon Lightsail container service.
|
default CompletableFuture<DeleteContainerImageResponse> |
deleteContainerImage(DeleteContainerImageRequest deleteContainerImageRequest)
Deletes a container image that is registered to your Amazon Lightsail container service.
|
default CompletableFuture<DeleteContainerServiceResponse> |
deleteContainerService(Consumer<DeleteContainerServiceRequest.Builder> deleteContainerServiceRequest)
Deletes your Amazon Lightsail container service.
|
default CompletableFuture<DeleteContainerServiceResponse> |
deleteContainerService(DeleteContainerServiceRequest deleteContainerServiceRequest)
Deletes your Amazon Lightsail container service.
|
default CompletableFuture<DeleteDiskResponse> |
deleteDisk(Consumer<DeleteDiskRequest.Builder> deleteDiskRequest)
Deletes the specified block storage disk.
|
default CompletableFuture<DeleteDiskResponse> |
deleteDisk(DeleteDiskRequest deleteDiskRequest)
Deletes the specified block storage disk.
|
default CompletableFuture<DeleteDiskSnapshotResponse> |
deleteDiskSnapshot(Consumer<DeleteDiskSnapshotRequest.Builder> deleteDiskSnapshotRequest)
Deletes the specified disk snapshot.
|
default CompletableFuture<DeleteDiskSnapshotResponse> |
deleteDiskSnapshot(DeleteDiskSnapshotRequest deleteDiskSnapshotRequest)
Deletes the specified disk snapshot.
|
default CompletableFuture<DeleteDistributionResponse> |
deleteDistribution(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest)
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<DeleteDistributionResponse> |
deleteDistribution(DeleteDistributionRequest deleteDistributionRequest)
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<DeleteDomainResponse> |
deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)
Deletes the specified domain recordset and all of its domain records.
|
default CompletableFuture<DeleteDomainResponse> |
deleteDomain(DeleteDomainRequest deleteDomainRequest)
Deletes the specified domain recordset and all of its domain records.
|
default CompletableFuture<DeleteDomainEntryResponse> |
deleteDomainEntry(Consumer<DeleteDomainEntryRequest.Builder> deleteDomainEntryRequest)
Deletes a specific domain entry.
|
default CompletableFuture<DeleteDomainEntryResponse> |
deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest)
Deletes a specific domain entry.
|
default CompletableFuture<DeleteInstanceResponse> |
deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest)
Deletes an Amazon Lightsail instance.
|
default CompletableFuture<DeleteInstanceResponse> |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
Deletes an Amazon Lightsail instance.
|
default CompletableFuture<DeleteInstanceSnapshotResponse> |
deleteInstanceSnapshot(Consumer<DeleteInstanceSnapshotRequest.Builder> deleteInstanceSnapshotRequest)
Deletes a specific snapshot of a virtual private server (or instance).
|
default CompletableFuture<DeleteInstanceSnapshotResponse> |
deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest)
Deletes a specific snapshot of a virtual private server (or instance).
|
default CompletableFuture<DeleteKeyPairResponse> |
deleteKeyPair(Consumer<DeleteKeyPairRequest.Builder> deleteKeyPairRequest)
Deletes a specific SSH key pair.
|
default CompletableFuture<DeleteKeyPairResponse> |
deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)
Deletes a specific SSH key pair.
|
default CompletableFuture<DeleteKnownHostKeysResponse> |
deleteKnownHostKeys(Consumer<DeleteKnownHostKeysRequest.Builder> deleteKnownHostKeysRequest)
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to
authenticate an instance.
|
default CompletableFuture<DeleteKnownHostKeysResponse> |
deleteKnownHostKeys(DeleteKnownHostKeysRequest deleteKnownHostKeysRequest)
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to
authenticate an instance.
|
default CompletableFuture<DeleteLoadBalancerResponse> |
deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest)
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.
|
default CompletableFuture<DeleteLoadBalancerResponse> |
deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.
|
default CompletableFuture<DeleteLoadBalancerTlsCertificateResponse> |
deleteLoadBalancerTlsCertificate(Consumer<DeleteLoadBalancerTlsCertificateRequest.Builder> deleteLoadBalancerTlsCertificateRequest)
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
|
default CompletableFuture<DeleteLoadBalancerTlsCertificateResponse> |
deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest deleteLoadBalancerTlsCertificateRequest)
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
|
default CompletableFuture<DeleteRelationalDatabaseResponse> |
deleteRelationalDatabase(Consumer<DeleteRelationalDatabaseRequest.Builder> deleteRelationalDatabaseRequest)
Deletes a database in Amazon Lightsail.
|
default CompletableFuture<DeleteRelationalDatabaseResponse> |
deleteRelationalDatabase(DeleteRelationalDatabaseRequest deleteRelationalDatabaseRequest)
Deletes a database in Amazon Lightsail.
|
default CompletableFuture<DeleteRelationalDatabaseSnapshotResponse> |
deleteRelationalDatabaseSnapshot(Consumer<DeleteRelationalDatabaseSnapshotRequest.Builder> deleteRelationalDatabaseSnapshotRequest)
Deletes a database snapshot in Amazon Lightsail.
|
default CompletableFuture<DeleteRelationalDatabaseSnapshotResponse> |
deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest deleteRelationalDatabaseSnapshotRequest)
Deletes a database snapshot in Amazon Lightsail.
|
default CompletableFuture<DetachCertificateFromDistributionResponse> |
detachCertificateFromDistribution(Consumer<DetachCertificateFromDistributionRequest.Builder> detachCertificateFromDistributionRequest)
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<DetachCertificateFromDistributionResponse> |
detachCertificateFromDistribution(DetachCertificateFromDistributionRequest detachCertificateFromDistributionRequest)
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<DetachDiskResponse> |
detachDisk(Consumer<DetachDiskRequest.Builder> detachDiskRequest)
Detaches a stopped block storage disk from a Lightsail instance.
|
default CompletableFuture<DetachDiskResponse> |
detachDisk(DetachDiskRequest detachDiskRequest)
Detaches a stopped block storage disk from a Lightsail instance.
|
default CompletableFuture<DetachInstancesFromLoadBalancerResponse> |
detachInstancesFromLoadBalancer(Consumer<DetachInstancesFromLoadBalancerRequest.Builder> detachInstancesFromLoadBalancerRequest)
Detaches the specified instances from a Lightsail load balancer.
|
default CompletableFuture<DetachInstancesFromLoadBalancerResponse> |
detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest detachInstancesFromLoadBalancerRequest)
Detaches the specified instances from a Lightsail load balancer.
|
default CompletableFuture<DetachStaticIpResponse> |
detachStaticIp(Consumer<DetachStaticIpRequest.Builder> detachStaticIpRequest)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
default CompletableFuture<DetachStaticIpResponse> |
detachStaticIp(DetachStaticIpRequest detachStaticIpRequest)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
default CompletableFuture<DisableAddOnResponse> |
disableAddOn(Consumer<DisableAddOnRequest.Builder> disableAddOnRequest)
Disables an add-on for an Amazon Lightsail resource.
|
default CompletableFuture<DisableAddOnResponse> |
disableAddOn(DisableAddOnRequest disableAddOnRequest)
Disables an add-on for an Amazon Lightsail resource.
|
default CompletableFuture<DownloadDefaultKeyPairResponse> |
downloadDefaultKeyPair()
Downloads the default SSH key pair from the user's account.
|
default CompletableFuture<DownloadDefaultKeyPairResponse> |
downloadDefaultKeyPair(Consumer<DownloadDefaultKeyPairRequest.Builder> downloadDefaultKeyPairRequest)
Downloads the default SSH key pair from the user's account.
|
default CompletableFuture<DownloadDefaultKeyPairResponse> |
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest)
Downloads the default SSH key pair from the user's account.
|
default CompletableFuture<EnableAddOnResponse> |
enableAddOn(Consumer<EnableAddOnRequest.Builder> enableAddOnRequest)
Enables or modifies an add-on for an Amazon Lightsail resource.
|
default CompletableFuture<EnableAddOnResponse> |
enableAddOn(EnableAddOnRequest enableAddOnRequest)
Enables or modifies an add-on for an Amazon Lightsail resource.
|
default CompletableFuture<ExportSnapshotResponse> |
exportSnapshot(Consumer<ExportSnapshotRequest.Builder> exportSnapshotRequest)
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
|
default CompletableFuture<ExportSnapshotResponse> |
exportSnapshot(ExportSnapshotRequest exportSnapshotRequest)
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
|
default CompletableFuture<GetActiveNamesResponse> |
getActiveNames()
Returns the names of all active (not deleted) resources.
|
default CompletableFuture<GetActiveNamesResponse> |
getActiveNames(Consumer<GetActiveNamesRequest.Builder> getActiveNamesRequest)
Returns the names of all active (not deleted) resources.
|
default CompletableFuture<GetActiveNamesResponse> |
getActiveNames(GetActiveNamesRequest getActiveNamesRequest)
Returns the names of all active (not deleted) resources.
|
default CompletableFuture<GetAlarmsResponse> |
getAlarms(Consumer<GetAlarmsRequest.Builder> getAlarmsRequest)
Returns information about the configured alarms.
|
default CompletableFuture<GetAlarmsResponse> |
getAlarms(GetAlarmsRequest getAlarmsRequest)
Returns information about the configured alarms.
|
default CompletableFuture<GetAutoSnapshotsResponse> |
getAutoSnapshots(Consumer<GetAutoSnapshotsRequest.Builder> getAutoSnapshotsRequest)
Returns the available automatic snapshots for an instance or disk.
|
default CompletableFuture<GetAutoSnapshotsResponse> |
getAutoSnapshots(GetAutoSnapshotsRequest getAutoSnapshotsRequest)
Returns the available automatic snapshots for an instance or disk.
|
default CompletableFuture<GetBlueprintsResponse> |
getBlueprints()
Returns the list of available instance images, or blueprints.
|
default CompletableFuture<GetBlueprintsResponse> |
getBlueprints(Consumer<GetBlueprintsRequest.Builder> getBlueprintsRequest)
Returns the list of available instance images, or blueprints.
|
default CompletableFuture<GetBlueprintsResponse> |
getBlueprints(GetBlueprintsRequest getBlueprintsRequest)
Returns the list of available instance images, or blueprints.
|
default CompletableFuture<GetBundlesResponse> |
getBundles()
Returns the list of bundles that are available for purchase.
|
default CompletableFuture<GetBundlesResponse> |
getBundles(Consumer<GetBundlesRequest.Builder> getBundlesRequest)
Returns the list of bundles that are available for purchase.
|
default CompletableFuture<GetBundlesResponse> |
getBundles(GetBundlesRequest getBundlesRequest)
Returns the list of bundles that are available for purchase.
|
default CompletableFuture<GetCertificatesResponse> |
getCertificates(Consumer<GetCertificatesRequest.Builder> getCertificatesRequest)
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
|
default CompletableFuture<GetCertificatesResponse> |
getCertificates(GetCertificatesRequest getCertificatesRequest)
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
|
default CompletableFuture<GetCloudFormationStackRecordsResponse> |
getCloudFormationStackRecords()
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. |
default CompletableFuture<GetCloudFormationStackRecordsResponse> |
getCloudFormationStackRecords(Consumer<GetCloudFormationStackRecordsRequest.Builder> getCloudFormationStackRecordsRequest)
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. |
default CompletableFuture<GetCloudFormationStackRecordsResponse> |
getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest getCloudFormationStackRecordsRequest)
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. |
default CompletableFuture<GetContactMethodsResponse> |
getContactMethods(Consumer<GetContactMethodsRequest.Builder> getContactMethodsRequest)
Returns information about the configured contact methods.
|
default CompletableFuture<GetContactMethodsResponse> |
getContactMethods(GetContactMethodsRequest getContactMethodsRequest)
Returns information about the configured contact methods.
|
default CompletableFuture<GetContainerApiMetadataResponse> |
getContainerAPIMetadata(Consumer<GetContainerApiMetadataRequest.Builder> getContainerApiMetadataRequest)
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control
(lightsailctl) plugin.
|
default CompletableFuture<GetContainerApiMetadataResponse> |
getContainerAPIMetadata(GetContainerApiMetadataRequest getContainerApiMetadataRequest)
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control
(lightsailctl) plugin.
|
default CompletableFuture<GetContainerImagesResponse> |
getContainerImages(Consumer<GetContainerImagesRequest.Builder> getContainerImagesRequest)
Returns the container images that are registered to your Amazon Lightsail container service.
|
default CompletableFuture<GetContainerImagesResponse> |
getContainerImages(GetContainerImagesRequest getContainerImagesRequest)
Returns the container images that are registered to your Amazon Lightsail container service.
|
default CompletableFuture<GetContainerLogResponse> |
getContainerLog(Consumer<GetContainerLogRequest.Builder> getContainerLogRequest)
Returns the log events of a container of your Amazon Lightsail container service.
|
default CompletableFuture<GetContainerLogResponse> |
getContainerLog(GetContainerLogRequest getContainerLogRequest)
Returns the log events of a container of your Amazon Lightsail container service.
|
default CompletableFuture<GetContainerServiceDeploymentsResponse> |
getContainerServiceDeployments(Consumer<GetContainerServiceDeploymentsRequest.Builder> getContainerServiceDeploymentsRequest)
Returns the deployments for your Amazon Lightsail container service
|
default CompletableFuture<GetContainerServiceDeploymentsResponse> |
getContainerServiceDeployments(GetContainerServiceDeploymentsRequest getContainerServiceDeploymentsRequest)
Returns the deployments for your Amazon Lightsail container service
|
default CompletableFuture<GetContainerServiceMetricDataResponse> |
getContainerServiceMetricData(Consumer<GetContainerServiceMetricDataRequest.Builder> getContainerServiceMetricDataRequest)
Returns the data points of a specific metric of your Amazon Lightsail container service.
|
default CompletableFuture<GetContainerServiceMetricDataResponse> |
getContainerServiceMetricData(GetContainerServiceMetricDataRequest getContainerServiceMetricDataRequest)
Returns the data points of a specific metric of your Amazon Lightsail container service.
|
default CompletableFuture<GetContainerServicePowersResponse> |
getContainerServicePowers(Consumer<GetContainerServicePowersRequest.Builder> getContainerServicePowersRequest)
Returns the list of powers that can be specified for your Amazon Lightsail container services.
|
default CompletableFuture<GetContainerServicePowersResponse> |
getContainerServicePowers(GetContainerServicePowersRequest getContainerServicePowersRequest)
Returns the list of powers that can be specified for your Amazon Lightsail container services.
|
default CompletableFuture<GetContainerServicesResponse> |
getContainerServices(Consumer<GetContainerServicesRequest.Builder> getContainerServicesRequest)
Returns information about one or more of your Amazon Lightsail container services.
|
default CompletableFuture<GetContainerServicesResponse> |
getContainerServices(GetContainerServicesRequest getContainerServicesRequest)
Returns information about one or more of your Amazon Lightsail container services.
|
default CompletableFuture<GetDiskResponse> |
getDisk(Consumer<GetDiskRequest.Builder> getDiskRequest)
Returns information about a specific block storage disk.
|
default CompletableFuture<GetDiskResponse> |
getDisk(GetDiskRequest getDiskRequest)
Returns information about a specific block storage disk.
|
default CompletableFuture<GetDisksResponse> |
getDisks()
Returns information about all block storage disks in your AWS account and region.
|
default CompletableFuture<GetDisksResponse> |
getDisks(Consumer<GetDisksRequest.Builder> getDisksRequest)
Returns information about all block storage disks in your AWS account and region.
|
default CompletableFuture<GetDisksResponse> |
getDisks(GetDisksRequest getDisksRequest)
Returns information about all block storage disks in your AWS account and region.
|
default CompletableFuture<GetDiskSnapshotResponse> |
getDiskSnapshot(Consumer<GetDiskSnapshotRequest.Builder> getDiskSnapshotRequest)
Returns information about a specific block storage disk snapshot.
|
default CompletableFuture<GetDiskSnapshotResponse> |
getDiskSnapshot(GetDiskSnapshotRequest getDiskSnapshotRequest)
Returns information about a specific block storage disk snapshot.
|
default CompletableFuture<GetDiskSnapshotsResponse> |
getDiskSnapshots()
Returns information about all block storage disk snapshots in your AWS account and region.
|
default CompletableFuture<GetDiskSnapshotsResponse> |
getDiskSnapshots(Consumer<GetDiskSnapshotsRequest.Builder> getDiskSnapshotsRequest)
Returns information about all block storage disk snapshots in your AWS account and region.
|
default CompletableFuture<GetDiskSnapshotsResponse> |
getDiskSnapshots(GetDiskSnapshotsRequest getDiskSnapshotsRequest)
Returns information about all block storage disk snapshots in your AWS account and region.
|
default CompletableFuture<GetDistributionBundlesResponse> |
getDistributionBundles(Consumer<GetDistributionBundlesRequest.Builder> getDistributionBundlesRequest)
Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN)
distributions.
|
default CompletableFuture<GetDistributionBundlesResponse> |
getDistributionBundles(GetDistributionBundlesRequest getDistributionBundlesRequest)
Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN)
distributions.
|
default CompletableFuture<GetDistributionLatestCacheResetResponse> |
getDistributionLatestCacheReset(Consumer<GetDistributionLatestCacheResetRequest.Builder> getDistributionLatestCacheResetRequest)
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network
(CDN) distribution.
|
default CompletableFuture<GetDistributionLatestCacheResetResponse> |
getDistributionLatestCacheReset(GetDistributionLatestCacheResetRequest getDistributionLatestCacheResetRequest)
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network
(CDN) distribution.
|
default CompletableFuture<GetDistributionMetricDataResponse> |
getDistributionMetricData(Consumer<GetDistributionMetricDataRequest.Builder> getDistributionMetricDataRequest)
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<GetDistributionMetricDataResponse> |
getDistributionMetricData(GetDistributionMetricDataRequest getDistributionMetricDataRequest)
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<GetDistributionsResponse> |
getDistributions(Consumer<GetDistributionsRequest.Builder> getDistributionsRequest)
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
|
default CompletableFuture<GetDistributionsResponse> |
getDistributions(GetDistributionsRequest getDistributionsRequest)
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
|
default CompletableFuture<GetDomainResponse> |
getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)
Returns information about a specific domain recordset.
|
default CompletableFuture<GetDomainResponse> |
getDomain(GetDomainRequest getDomainRequest)
Returns information about a specific domain recordset.
|
default CompletableFuture<GetDomainsResponse> |
getDomains()
Returns a list of all domains in the user's account.
|
default CompletableFuture<GetDomainsResponse> |
getDomains(Consumer<GetDomainsRequest.Builder> getDomainsRequest)
Returns a list of all domains in the user's account.
|
default CompletableFuture<GetDomainsResponse> |
getDomains(GetDomainsRequest getDomainsRequest)
Returns a list of all domains in the user's account.
|
default CompletableFuture<GetExportSnapshotRecordsResponse> |
getExportSnapshotRecords()
Returns the export snapshot record created as a result of the
export snapshot operation. |
default CompletableFuture<GetExportSnapshotRecordsResponse> |
getExportSnapshotRecords(Consumer<GetExportSnapshotRecordsRequest.Builder> getExportSnapshotRecordsRequest)
Returns the export snapshot record created as a result of the
export snapshot operation. |
default CompletableFuture<GetExportSnapshotRecordsResponse> |
getExportSnapshotRecords(GetExportSnapshotRecordsRequest getExportSnapshotRecordsRequest)
Returns the export snapshot record created as a result of the
export snapshot operation. |
default CompletableFuture<GetInstanceResponse> |
getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
|
default CompletableFuture<GetInstanceResponse> |
getInstance(GetInstanceRequest getInstanceRequest)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
|
default CompletableFuture<GetInstanceAccessDetailsResponse> |
getInstanceAccessDetails(Consumer<GetInstanceAccessDetailsRequest.Builder> getInstanceAccessDetailsRequest)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
|
default CompletableFuture<GetInstanceAccessDetailsResponse> |
getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
|
default CompletableFuture<GetInstanceMetricDataResponse> |
getInstanceMetricData(Consumer<GetInstanceMetricDataRequest.Builder> getInstanceMetricDataRequest)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
|
default CompletableFuture<GetInstanceMetricDataResponse> |
getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
|
default CompletableFuture<GetInstancePortStatesResponse> |
getInstancePortStates(Consumer<GetInstancePortStatesRequest.Builder> getInstancePortStatesRequest)
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.
|
default CompletableFuture<GetInstancePortStatesResponse> |
getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest)
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.
|
default CompletableFuture<GetInstancesResponse> |
getInstances()
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
default CompletableFuture<GetInstancesResponse> |
getInstances(Consumer<GetInstancesRequest.Builder> getInstancesRequest)
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
default CompletableFuture<GetInstancesResponse> |
getInstances(GetInstancesRequest getInstancesRequest)
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
default CompletableFuture<GetInstanceSnapshotResponse> |
getInstanceSnapshot(Consumer<GetInstanceSnapshotRequest.Builder> getInstanceSnapshotRequest)
Returns information about a specific instance snapshot.
|
default CompletableFuture<GetInstanceSnapshotResponse> |
getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest)
Returns information about a specific instance snapshot.
|
default CompletableFuture<GetInstanceSnapshotsResponse> |
getInstanceSnapshots()
Returns all instance snapshots for the user's account.
|
default CompletableFuture<GetInstanceSnapshotsResponse> |
getInstanceSnapshots(Consumer<GetInstanceSnapshotsRequest.Builder> getInstanceSnapshotsRequest)
Returns all instance snapshots for the user's account.
|
default CompletableFuture<GetInstanceSnapshotsResponse> |
getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest)
Returns all instance snapshots for the user's account.
|
default CompletableFuture<GetInstanceStateResponse> |
getInstanceState(Consumer<GetInstanceStateRequest.Builder> getInstanceStateRequest)
Returns the state of a specific instance.
|
default CompletableFuture<GetInstanceStateResponse> |
getInstanceState(GetInstanceStateRequest getInstanceStateRequest)
Returns the state of a specific instance.
|
default CompletableFuture<GetKeyPairResponse> |
getKeyPair(Consumer<GetKeyPairRequest.Builder> getKeyPairRequest)
Returns information about a specific key pair.
|
default CompletableFuture<GetKeyPairResponse> |
getKeyPair(GetKeyPairRequest getKeyPairRequest)
Returns information about a specific key pair.
|
default CompletableFuture<GetKeyPairsResponse> |
getKeyPairs()
Returns information about all key pairs in the user's account.
|
default CompletableFuture<GetKeyPairsResponse> |
getKeyPairs(Consumer<GetKeyPairsRequest.Builder> getKeyPairsRequest)
Returns information about all key pairs in the user's account.
|
default CompletableFuture<GetKeyPairsResponse> |
getKeyPairs(GetKeyPairsRequest getKeyPairsRequest)
Returns information about all key pairs in the user's account.
|
default CompletableFuture<GetLoadBalancerResponse> |
getLoadBalancer(Consumer<GetLoadBalancerRequest.Builder> getLoadBalancerRequest)
Returns information about the specified Lightsail load balancer.
|
default CompletableFuture<GetLoadBalancerResponse> |
getLoadBalancer(GetLoadBalancerRequest getLoadBalancerRequest)
Returns information about the specified Lightsail load balancer.
|
default CompletableFuture<GetLoadBalancerMetricDataResponse> |
getLoadBalancerMetricData(Consumer<GetLoadBalancerMetricDataRequest.Builder> getLoadBalancerMetricDataRequest)
Returns information about health metrics for your Lightsail load balancer.
|
default CompletableFuture<GetLoadBalancerMetricDataResponse> |
getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest getLoadBalancerMetricDataRequest)
Returns information about health metrics for your Lightsail load balancer.
|
default CompletableFuture<GetLoadBalancersResponse> |
getLoadBalancers()
Returns information about all load balancers in an account.
|
default CompletableFuture<GetLoadBalancersResponse> |
getLoadBalancers(Consumer<GetLoadBalancersRequest.Builder> getLoadBalancersRequest)
Returns information about all load balancers in an account.
|
default CompletableFuture<GetLoadBalancersResponse> |
getLoadBalancers(GetLoadBalancersRequest getLoadBalancersRequest)
Returns information about all load balancers in an account.
|
default CompletableFuture<GetLoadBalancerTlsCertificatesResponse> |
getLoadBalancerTlsCertificates(Consumer<GetLoadBalancerTlsCertificatesRequest.Builder> getLoadBalancerTlsCertificatesRequest)
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
|
default CompletableFuture<GetLoadBalancerTlsCertificatesResponse> |
getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest getLoadBalancerTlsCertificatesRequest)
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
|
default CompletableFuture<GetOperationResponse> |
getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest)
Returns information about a specific operation.
|
default CompletableFuture<GetOperationResponse> |
getOperation(GetOperationRequest getOperationRequest)
Returns information about a specific operation.
|
default CompletableFuture<GetOperationsResponse> |
getOperations()
Returns information about all operations.
|
default CompletableFuture<GetOperationsResponse> |
getOperations(Consumer<GetOperationsRequest.Builder> getOperationsRequest)
Returns information about all operations.
|
default CompletableFuture<GetOperationsResponse> |
getOperations(GetOperationsRequest getOperationsRequest)
Returns information about all operations.
|
default CompletableFuture<GetOperationsForResourceResponse> |
getOperationsForResource(Consumer<GetOperationsForResourceRequest.Builder> getOperationsForResourceRequest)
Gets operations for a specific resource (e.g., an instance or a static IP).
|
default CompletableFuture<GetOperationsForResourceResponse> |
getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest)
Gets operations for a specific resource (e.g., an instance or a static IP).
|
default CompletableFuture<GetRegionsResponse> |
getRegions()
Returns a list of all valid regions for Amazon Lightsail.
|
default CompletableFuture<GetRegionsResponse> |
getRegions(Consumer<GetRegionsRequest.Builder> getRegionsRequest)
Returns a list of all valid regions for Amazon Lightsail.
|
default CompletableFuture<GetRegionsResponse> |
getRegions(GetRegionsRequest getRegionsRequest)
Returns a list of all valid regions for Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseResponse> |
getRelationalDatabase(Consumer<GetRelationalDatabaseRequest.Builder> getRelationalDatabaseRequest)
Returns information about a specific database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseResponse> |
getRelationalDatabase(GetRelationalDatabaseRequest getRelationalDatabaseRequest)
Returns information about a specific database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseBlueprintsResponse> |
getRelationalDatabaseBlueprints()
Returns a list of available database blueprints in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseBlueprintsResponse> |
getRelationalDatabaseBlueprints(Consumer<GetRelationalDatabaseBlueprintsRequest.Builder> getRelationalDatabaseBlueprintsRequest)
Returns a list of available database blueprints in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseBlueprintsResponse> |
getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest getRelationalDatabaseBlueprintsRequest)
Returns a list of available database blueprints in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseBundlesResponse> |
getRelationalDatabaseBundles()
Returns the list of bundles that are available in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseBundlesResponse> |
getRelationalDatabaseBundles(Consumer<GetRelationalDatabaseBundlesRequest.Builder> getRelationalDatabaseBundlesRequest)
Returns the list of bundles that are available in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseBundlesResponse> |
getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest getRelationalDatabaseBundlesRequest)
Returns the list of bundles that are available in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseEventsResponse> |
getRelationalDatabaseEvents(Consumer<GetRelationalDatabaseEventsRequest.Builder> getRelationalDatabaseEventsRequest)
Returns a list of events for a specific database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseEventsResponse> |
getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest getRelationalDatabaseEventsRequest)
Returns a list of events for a specific database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseLogEventsResponse> |
getRelationalDatabaseLogEvents(Consumer<GetRelationalDatabaseLogEventsRequest.Builder> getRelationalDatabaseLogEventsRequest)
Returns a list of log events for a database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseLogEventsResponse> |
getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest getRelationalDatabaseLogEventsRequest)
Returns a list of log events for a database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseLogStreamsResponse> |
getRelationalDatabaseLogStreams(Consumer<GetRelationalDatabaseLogStreamsRequest.Builder> getRelationalDatabaseLogStreamsRequest)
Returns a list of available log streams for a specific database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseLogStreamsResponse> |
getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest getRelationalDatabaseLogStreamsRequest)
Returns a list of available log streams for a specific database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseMasterUserPasswordResponse> |
getRelationalDatabaseMasterUserPassword(Consumer<GetRelationalDatabaseMasterUserPasswordRequest.Builder> getRelationalDatabaseMasterUserPasswordRequest)
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
|
default CompletableFuture<GetRelationalDatabaseMasterUserPasswordResponse> |
getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest getRelationalDatabaseMasterUserPasswordRequest)
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
|
default CompletableFuture<GetRelationalDatabaseMetricDataResponse> |
getRelationalDatabaseMetricData(Consumer<GetRelationalDatabaseMetricDataRequest.Builder> getRelationalDatabaseMetricDataRequest)
Returns the data points of the specified metric for a database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseMetricDataResponse> |
getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest getRelationalDatabaseMetricDataRequest)
Returns the data points of the specified metric for a database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseParametersResponse> |
getRelationalDatabaseParameters(Consumer<GetRelationalDatabaseParametersRequest.Builder> getRelationalDatabaseParametersRequest)
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific
database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseParametersResponse> |
getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest getRelationalDatabaseParametersRequest)
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific
database in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabasesResponse> |
getRelationalDatabases()
Returns information about all of your databases in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabasesResponse> |
getRelationalDatabases(Consumer<GetRelationalDatabasesRequest.Builder> getRelationalDatabasesRequest)
Returns information about all of your databases in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabasesResponse> |
getRelationalDatabases(GetRelationalDatabasesRequest getRelationalDatabasesRequest)
Returns information about all of your databases in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseSnapshotResponse> |
getRelationalDatabaseSnapshot(Consumer<GetRelationalDatabaseSnapshotRequest.Builder> getRelationalDatabaseSnapshotRequest)
Returns information about a specific database snapshot in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseSnapshotResponse> |
getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest getRelationalDatabaseSnapshotRequest)
Returns information about a specific database snapshot in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseSnapshotsResponse> |
getRelationalDatabaseSnapshots()
Returns information about all of your database snapshots in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseSnapshotsResponse> |
getRelationalDatabaseSnapshots(Consumer<GetRelationalDatabaseSnapshotsRequest.Builder> getRelationalDatabaseSnapshotsRequest)
Returns information about all of your database snapshots in Amazon Lightsail.
|
default CompletableFuture<GetRelationalDatabaseSnapshotsResponse> |
getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest getRelationalDatabaseSnapshotsRequest)
Returns information about all of your database snapshots in Amazon Lightsail.
|
default CompletableFuture<GetStaticIpResponse> |
getStaticIp(Consumer<GetStaticIpRequest.Builder> getStaticIpRequest)
Returns information about a specific static IP.
|
default CompletableFuture<GetStaticIpResponse> |
getStaticIp(GetStaticIpRequest getStaticIpRequest)
Returns information about a specific static IP.
|
default CompletableFuture<GetStaticIpsResponse> |
getStaticIps()
Returns information about all static IPs in the user's account.
|
default CompletableFuture<GetStaticIpsResponse> |
getStaticIps(Consumer<GetStaticIpsRequest.Builder> getStaticIpsRequest)
Returns information about all static IPs in the user's account.
|
default CompletableFuture<GetStaticIpsResponse> |
getStaticIps(GetStaticIpsRequest getStaticIpsRequest)
Returns information about all static IPs in the user's account.
|
default CompletableFuture<ImportKeyPairResponse> |
importKeyPair(Consumer<ImportKeyPairRequest.Builder> importKeyPairRequest)
Imports a public SSH key from a specific key pair.
|
default CompletableFuture<ImportKeyPairResponse> |
importKeyPair(ImportKeyPairRequest importKeyPairRequest)
Imports a public SSH key from a specific key pair.
|
default CompletableFuture<IsVpcPeeredResponse> |
isVpcPeered()
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
default CompletableFuture<IsVpcPeeredResponse> |
isVpcPeered(Consumer<IsVpcPeeredRequest.Builder> isVpcPeeredRequest)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
default CompletableFuture<IsVpcPeeredResponse> |
isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
default CompletableFuture<OpenInstancePublicPortsResponse> |
openInstancePublicPorts(Consumer<OpenInstancePublicPortsRequest.Builder> openInstancePublicPortsRequest)
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.
|
default CompletableFuture<OpenInstancePublicPortsResponse> |
openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest)
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.
|
default CompletableFuture<PeerVpcResponse> |
peerVpc()
Tries to peer the Lightsail VPC with the user's default VPC.
|
default CompletableFuture<PeerVpcResponse> |
peerVpc(Consumer<PeerVpcRequest.Builder> peerVpcRequest)
Tries to peer the Lightsail VPC with the user's default VPC.
|
default CompletableFuture<PeerVpcResponse> |
peerVpc(PeerVpcRequest peerVpcRequest)
Tries to peer the Lightsail VPC with the user's default VPC.
|
default CompletableFuture<PutAlarmResponse> |
putAlarm(Consumer<PutAlarmRequest.Builder> putAlarmRequest)
Creates or updates an alarm, and associates it with the specified metric.
|
default CompletableFuture<PutAlarmResponse> |
putAlarm(PutAlarmRequest putAlarmRequest)
Creates or updates an alarm, and associates it with the specified metric.
|
default CompletableFuture<PutInstancePublicPortsResponse> |
putInstancePublicPorts(Consumer<PutInstancePublicPortsRequest.Builder> putInstancePublicPortsRequest)
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.
|
default CompletableFuture<PutInstancePublicPortsResponse> |
putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest)
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.
|
default CompletableFuture<RebootInstanceResponse> |
rebootInstance(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest)
Restarts a specific instance.
|
default CompletableFuture<RebootInstanceResponse> |
rebootInstance(RebootInstanceRequest rebootInstanceRequest)
Restarts a specific instance.
|
default CompletableFuture<RebootRelationalDatabaseResponse> |
rebootRelationalDatabase(Consumer<RebootRelationalDatabaseRequest.Builder> rebootRelationalDatabaseRequest)
Restarts a specific database in Amazon Lightsail.
|
default CompletableFuture<RebootRelationalDatabaseResponse> |
rebootRelationalDatabase(RebootRelationalDatabaseRequest rebootRelationalDatabaseRequest)
Restarts a specific database in Amazon Lightsail.
|
default CompletableFuture<RegisterContainerImageResponse> |
registerContainerImage(Consumer<RegisterContainerImageRequest.Builder> registerContainerImageRequest)
Registers a container image to your Amazon Lightsail container service.
|
default CompletableFuture<RegisterContainerImageResponse> |
registerContainerImage(RegisterContainerImageRequest registerContainerImageRequest)
Registers a container image to your Amazon Lightsail container service.
|
default CompletableFuture<ReleaseStaticIpResponse> |
releaseStaticIp(Consumer<ReleaseStaticIpRequest.Builder> releaseStaticIpRequest)
Deletes a specific static IP from your account.
|
default CompletableFuture<ReleaseStaticIpResponse> |
releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest)
Deletes a specific static IP from your account.
|
default CompletableFuture<ResetDistributionCacheResponse> |
resetDistributionCache(Consumer<ResetDistributionCacheRequest.Builder> resetDistributionCacheRequest)
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<ResetDistributionCacheResponse> |
resetDistributionCache(ResetDistributionCacheRequest resetDistributionCacheRequest)
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<SendContactMethodVerificationResponse> |
sendContactMethodVerification(Consumer<SendContactMethodVerificationRequest.Builder> sendContactMethodVerificationRequest)
Sends a verification request to an email contact method to ensure it's owned by the requester.
|
default CompletableFuture<SendContactMethodVerificationResponse> |
sendContactMethodVerification(SendContactMethodVerificationRequest sendContactMethodVerificationRequest)
Sends a verification request to an email contact method to ensure it's owned by the requester.
|
default CompletableFuture<SetIpAddressTypeResponse> |
setIpAddressType(Consumer<SetIpAddressTypeRequest.Builder> setIpAddressTypeRequest)
Sets the IP address type for an Amazon Lightsail resource.
|
default CompletableFuture<SetIpAddressTypeResponse> |
setIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest)
Sets the IP address type for an Amazon Lightsail resource.
|
default CompletableFuture<StartInstanceResponse> |
startInstance(Consumer<StartInstanceRequest.Builder> startInstanceRequest)
Starts a specific Amazon Lightsail instance from a stopped state.
|
default CompletableFuture<StartInstanceResponse> |
startInstance(StartInstanceRequest startInstanceRequest)
Starts a specific Amazon Lightsail instance from a stopped state.
|
default CompletableFuture<StartRelationalDatabaseResponse> |
startRelationalDatabase(Consumer<StartRelationalDatabaseRequest.Builder> startRelationalDatabaseRequest)
Starts a specific database from a stopped state in Amazon Lightsail.
|
default CompletableFuture<StartRelationalDatabaseResponse> |
startRelationalDatabase(StartRelationalDatabaseRequest startRelationalDatabaseRequest)
Starts a specific database from a stopped state in Amazon Lightsail.
|
default CompletableFuture<StopInstanceResponse> |
stopInstance(Consumer<StopInstanceRequest.Builder> stopInstanceRequest)
Stops a specific Amazon Lightsail instance that is currently running.
|
default CompletableFuture<StopInstanceResponse> |
stopInstance(StopInstanceRequest stopInstanceRequest)
Stops a specific Amazon Lightsail instance that is currently running.
|
default CompletableFuture<StopRelationalDatabaseResponse> |
stopRelationalDatabase(Consumer<StopRelationalDatabaseRequest.Builder> stopRelationalDatabaseRequest)
Stops a specific database that is currently running in Amazon Lightsail.
|
default CompletableFuture<StopRelationalDatabaseResponse> |
stopRelationalDatabase(StopRelationalDatabaseRequest stopRelationalDatabaseRequest)
Stops a specific database that is currently running in Amazon Lightsail.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds one or more tags to the specified Amazon Lightsail resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds one or more tags to the specified Amazon Lightsail resource.
|
default CompletableFuture<TestAlarmResponse> |
testAlarm(Consumer<TestAlarmRequest.Builder> testAlarmRequest)
Tests an alarm by displaying a banner on the Amazon Lightsail console.
|
default CompletableFuture<TestAlarmResponse> |
testAlarm(TestAlarmRequest testAlarmRequest)
Tests an alarm by displaying a banner on the Amazon Lightsail console.
|
default CompletableFuture<UnpeerVpcResponse> |
unpeerVpc()
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
default CompletableFuture<UnpeerVpcResponse> |
unpeerVpc(Consumer<UnpeerVpcRequest.Builder> unpeerVpcRequest)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
default CompletableFuture<UnpeerVpcResponse> |
unpeerVpc(UnpeerVpcRequest unpeerVpcRequest)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
|
default CompletableFuture<UpdateContainerServiceResponse> |
updateContainerService(Consumer<UpdateContainerServiceRequest.Builder> updateContainerServiceRequest)
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain
names.
|
default CompletableFuture<UpdateContainerServiceResponse> |
updateContainerService(UpdateContainerServiceRequest updateContainerServiceRequest)
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain
names.
|
default CompletableFuture<UpdateDistributionResponse> |
updateDistribution(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest)
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<UpdateDistributionResponse> |
updateDistribution(UpdateDistributionRequest updateDistributionRequest)
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<UpdateDistributionBundleResponse> |
updateDistributionBundle(Consumer<UpdateDistributionBundleRequest.Builder> updateDistributionBundleRequest)
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<UpdateDistributionBundleResponse> |
updateDistributionBundle(UpdateDistributionBundleRequest updateDistributionBundleRequest)
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
|
default CompletableFuture<UpdateDomainEntryResponse> |
updateDomainEntry(Consumer<UpdateDomainEntryRequest.Builder> updateDomainEntryRequest)
Updates a domain recordset after it is created.
|
default CompletableFuture<UpdateDomainEntryResponse> |
updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest)
Updates a domain recordset after it is created.
|
default CompletableFuture<UpdateLoadBalancerAttributeResponse> |
updateLoadBalancerAttribute(Consumer<UpdateLoadBalancerAttributeRequest.Builder> updateLoadBalancerAttributeRequest)
Updates the specified attribute for a load balancer.
|
default CompletableFuture<UpdateLoadBalancerAttributeResponse> |
updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest updateLoadBalancerAttributeRequest)
Updates the specified attribute for a load balancer.
|
default CompletableFuture<UpdateRelationalDatabaseResponse> |
updateRelationalDatabase(Consumer<UpdateRelationalDatabaseRequest.Builder> updateRelationalDatabaseRequest)
Allows the update of one or more attributes of a database in Amazon Lightsail.
|
default CompletableFuture<UpdateRelationalDatabaseResponse> |
updateRelationalDatabase(UpdateRelationalDatabaseRequest updateRelationalDatabaseRequest)
Allows the update of one or more attributes of a database in Amazon Lightsail.
|
default CompletableFuture<UpdateRelationalDatabaseParametersResponse> |
updateRelationalDatabaseParameters(Consumer<UpdateRelationalDatabaseParametersRequest.Builder> updateRelationalDatabaseParametersRequest)
Allows the update of one or more parameters of a database in Amazon Lightsail.
|
default CompletableFuture<UpdateRelationalDatabaseParametersResponse> |
updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest updateRelationalDatabaseParametersRequest)
Allows the update of one or more parameters of a database in Amazon Lightsail.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static LightsailAsyncClient create()
LightsailAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static LightsailAsyncClientBuilder builder()
LightsailAsyncClient
.default CompletableFuture<AllocateStaticIpResponse> allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest)
Allocates a static IP address.
allocateStaticIpRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<AllocateStaticIpResponse> allocateStaticIp(Consumer<AllocateStaticIpRequest.Builder> allocateStaticIpRequest)
Allocates a static IP address.
This is a convenience which creates an instance of the AllocateStaticIpRequest.Builder
avoiding the need
to create one manually via AllocateStaticIpRequest.builder()
allocateStaticIpRequest
- A Consumer
that will call methods on AllocateStaticIpRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<AttachCertificateToDistributionResponse> attachCertificateToDistribution(AttachCertificateToDistributionRequest attachCertificateToDistributionRequest)
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.
attachCertificateToDistributionRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<AttachCertificateToDistributionResponse> attachCertificateToDistribution(Consumer<AttachCertificateToDistributionRequest.Builder> attachCertificateToDistributionRequest)
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.
This is a convenience which creates an instance of the AttachCertificateToDistributionRequest.Builder
avoiding the need to create one manually via AttachCertificateToDistributionRequest.builder()
attachCertificateToDistributionRequest
- A Consumer
that will call methods on AttachCertificateToDistributionRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<AttachDiskResponse> attachDisk(AttachDiskRequest attachDiskRequest)
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.
attachDiskRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<AttachDiskResponse> attachDisk(Consumer<AttachDiskRequest.Builder> attachDiskRequest)
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.
This is a convenience which creates an instance of the AttachDiskRequest.Builder
avoiding the need to
create one manually via AttachDiskRequest.builder()
attachDiskRequest
- A Consumer
that will call methods on AttachDiskRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<AttachInstancesToLoadBalancerResponse> attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest attachInstancesToLoadBalancerRequest)
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.
attachInstancesToLoadBalancerRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<AttachInstancesToLoadBalancerResponse> attachInstancesToLoadBalancer(Consumer<AttachInstancesToLoadBalancerRequest.Builder> attachInstancesToLoadBalancerRequest)
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.
This is a convenience which creates an instance of the AttachInstancesToLoadBalancerRequest.Builder
avoiding the need to create one manually via AttachInstancesToLoadBalancerRequest.builder()
attachInstancesToLoadBalancerRequest
- A Consumer
that will call methods on AttachInstancesToLoadBalancerRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<AttachLoadBalancerTlsCertificateResponse> attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest attachLoadBalancerTlsCertificateRequest)
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.
attachLoadBalancerTlsCertificateRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<AttachLoadBalancerTlsCertificateResponse> attachLoadBalancerTlsCertificate(Consumer<AttachLoadBalancerTlsCertificateRequest.Builder> attachLoadBalancerTlsCertificateRequest)
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.
This is a convenience which creates an instance of the AttachLoadBalancerTlsCertificateRequest.Builder
avoiding the need to create one manually via AttachLoadBalancerTlsCertificateRequest.builder()
attachLoadBalancerTlsCertificateRequest
- A Consumer
that will call methods on AttachLoadBalancerTlsCertificateRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<AttachStaticIpResponse> attachStaticIp(AttachStaticIpRequest attachStaticIpRequest)
Attaches a static IP address to a specific Amazon Lightsail instance.
attachStaticIpRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<AttachStaticIpResponse> attachStaticIp(Consumer<AttachStaticIpRequest.Builder> attachStaticIpRequest)
Attaches a static IP address to a specific Amazon Lightsail instance.
This is a convenience which creates an instance of the AttachStaticIpRequest.Builder
avoiding the need to
create one manually via AttachStaticIpRequest.builder()
attachStaticIpRequest
- A Consumer
that will call methods on AttachStaticIpRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CloseInstancePublicPortsResponse> closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest)
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.
closeInstancePublicPortsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CloseInstancePublicPortsResponse> closeInstancePublicPorts(Consumer<CloseInstancePublicPortsRequest.Builder> closeInstancePublicPortsRequest)
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.
This is a convenience which creates an instance of the CloseInstancePublicPortsRequest.Builder
avoiding
the need to create one manually via CloseInstancePublicPortsRequest.builder()
closeInstancePublicPortsRequest
- A Consumer
that will call methods on CloseInstancePublicPortsRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CopySnapshotResponse> copySnapshot(CopySnapshotRequest copySnapshotRequest)
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.
copySnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CopySnapshotResponse> copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest)
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.
This is a convenience which creates an instance of the CopySnapshotRequest.Builder
avoiding the need to
create one manually via CopySnapshotRequest.builder()
copySnapshotRequest
- A Consumer
that will call methods on CopySnapshotRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateCertificateResponse> createCertificate(CreateCertificateRequest createCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
After the certificate is valid, use the AttachCertificateToDistribution
action to use the
certificate and its domains with your distribution. Or use the UpdateContainerService
action to use
the certificate and its domains with your container service.
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.
createCertificateRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateCertificateResponse> createCertificate(Consumer<CreateCertificateRequest.Builder> createCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
After the certificate is valid, use the AttachCertificateToDistribution
action to use the
certificate and its domains with your distribution. Or use the UpdateContainerService
action to use
the certificate and its domains with your container service.
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.
This is a convenience which creates an instance of the CreateCertificateRequest.Builder
avoiding the need
to create one manually via CreateCertificateRequest.builder()
createCertificateRequest
- A Consumer
that will call methods on CreateCertificateRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateCloudFormationStackResponse> createCloudFormationStack(CreateCloudFormationStackRequest createCloudFormationStackRequest)
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.
createCloudFormationStackRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateCloudFormationStackResponse> createCloudFormationStack(Consumer<CreateCloudFormationStackRequest.Builder> createCloudFormationStackRequest)
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.
This is a convenience which creates an instance of the CreateCloudFormationStackRequest.Builder
avoiding
the need to create one manually via CreateCloudFormationStackRequest.builder()
createCloudFormationStackRequest
- A Consumer
that will call methods on CreateCloudFormationStackRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateContactMethodResponse> createContactMethod(CreateContactMethodRequest createContactMethodRequest)
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.
createContactMethodRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateContactMethodResponse> createContactMethod(Consumer<CreateContactMethodRequest.Builder> createContactMethodRequest)
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.
This is a convenience which creates an instance of the CreateContactMethodRequest.Builder
avoiding the
need to create one manually via CreateContactMethodRequest.builder()
createContactMethodRequest
- A Consumer
that will call methods on CreateContactMethodRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateContainerServiceResponse> createContainerService(CreateContainerServiceRequest createContainerServiceRequest)
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.
createContainerServiceRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateContainerServiceResponse> createContainerService(Consumer<CreateContainerServiceRequest.Builder> createContainerServiceRequest)
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.
This is a convenience which creates an instance of the CreateContainerServiceRequest.Builder
avoiding the
need to create one manually via CreateContainerServiceRequest.builder()
createContainerServiceRequest
- A Consumer
that will call methods on CreateContainerServiceRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateContainerServiceDeploymentResponse> createContainerServiceDeployment(CreateContainerServiceDeploymentRequest createContainerServiceDeploymentRequest)
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.
createContainerServiceDeploymentRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateContainerServiceDeploymentResponse> createContainerServiceDeployment(Consumer<CreateContainerServiceDeploymentRequest.Builder> createContainerServiceDeploymentRequest)
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.
This is a convenience which creates an instance of the CreateContainerServiceDeploymentRequest.Builder
avoiding the need to create one manually via CreateContainerServiceDeploymentRequest.builder()
createContainerServiceDeploymentRequest
- A Consumer
that will call methods on CreateContainerServiceDeploymentRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateContainerServiceRegistryLoginResponse> createContainerServiceRegistryLogin(CreateContainerServiceRegistryLoginRequest createContainerServiceRegistryLoginRequest)
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 or perform any other container image management actions on the container service registry.
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.
createContainerServiceRegistryLoginRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateContainerServiceRegistryLoginResponse> createContainerServiceRegistryLogin(Consumer<CreateContainerServiceRegistryLoginRequest.Builder> createContainerServiceRegistryLoginRequest)
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 or perform any other container image management actions on the container service registry.
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.
This is a convenience which creates an instance of the CreateContainerServiceRegistryLoginRequest.Builder
avoiding the need to create one manually via CreateContainerServiceRegistryLoginRequest.builder()
createContainerServiceRegistryLoginRequest
- A Consumer
that will call methods on CreateContainerServiceRegistryLoginRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDiskResponse> createDisk(CreateDiskRequest createDiskRequest)
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.
createDiskRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDiskResponse> createDisk(Consumer<CreateDiskRequest.Builder> createDiskRequest)
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.
This is a convenience which creates an instance of the CreateDiskRequest.Builder
avoiding the need to
create one manually via CreateDiskRequest.builder()
createDiskRequest
- A Consumer
that will call methods on CreateDiskRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDiskFromSnapshotResponse> createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest)
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.
createDiskFromSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDiskFromSnapshotResponse> createDiskFromSnapshot(Consumer<CreateDiskFromSnapshotRequest.Builder> createDiskFromSnapshotRequest)
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.
This is a convenience which creates an instance of the CreateDiskFromSnapshotRequest.Builder
avoiding the
need to create one manually via CreateDiskFromSnapshotRequest.builder()
createDiskFromSnapshotRequest
- A Consumer
that will call methods on CreateDiskFromSnapshotRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDiskSnapshotResponse> createDiskSnapshot(CreateDiskSnapshotRequest createDiskSnapshotRequest)
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.
createDiskSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDiskSnapshotResponse> createDiskSnapshot(Consumer<CreateDiskSnapshotRequest.Builder> createDiskSnapshotRequest)
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.
This is a convenience which creates an instance of the CreateDiskSnapshotRequest.Builder
avoiding the
need to create one manually via CreateDiskSnapshotRequest.builder()
createDiskSnapshotRequest
- A Consumer
that will call methods on CreateDiskSnapshotRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDistributionResponse> createDistribution(CreateDistributionRequest createDistributionRequest)
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.
createDistributionRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDistributionResponse> createDistribution(Consumer<CreateDistributionRequest.Builder> createDistributionRequest)
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.
This is a convenience which creates an instance of the CreateDistributionRequest.Builder
avoiding the
need to create one manually via CreateDistributionRequest.builder()
createDistributionRequest
- A Consumer
that will call methods on CreateDistributionRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDomainResponse> createDomain(CreateDomainRequest createDomainRequest)
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.
createDomainRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)
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.
This is a convenience which creates an instance of the CreateDomainRequest.Builder
avoiding the need to
create one manually via CreateDomainRequest.builder()
createDomainRequest
- A Consumer
that will call methods on CreateDomainRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDomainEntryResponse> createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest)
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.
createDomainEntryRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateDomainEntryResponse> createDomainEntry(Consumer<CreateDomainEntryRequest.Builder> createDomainEntryRequest)
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.
This is a convenience which creates an instance of the CreateDomainEntryRequest.Builder
avoiding the need
to create one manually via CreateDomainEntryRequest.builder()
createDomainEntryRequest
- A Consumer
that will call methods on CreateDomainEntryRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateInstanceSnapshotResponse> createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest)
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.
createInstanceSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateInstanceSnapshotResponse> createInstanceSnapshot(Consumer<CreateInstanceSnapshotRequest.Builder> createInstanceSnapshotRequest)
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.
This is a convenience which creates an instance of the CreateInstanceSnapshotRequest.Builder
avoiding the
need to create one manually via CreateInstanceSnapshotRequest.builder()
createInstanceSnapshotRequest
- A Consumer
that will call methods on CreateInstanceSnapshotRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateInstancesResponse> createInstances(CreateInstancesRequest createInstancesRequest)
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.
createInstancesRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateInstancesResponse> createInstances(Consumer<CreateInstancesRequest.Builder> createInstancesRequest)
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.
This is a convenience which creates an instance of the CreateInstancesRequest.Builder
avoiding the need
to create one manually via CreateInstancesRequest.builder()
createInstancesRequest
- A Consumer
that will call methods on CreateInstancesRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateInstancesFromSnapshotResponse> createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest)
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.
createInstancesFromSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateInstancesFromSnapshotResponse> createInstancesFromSnapshot(Consumer<CreateInstancesFromSnapshotRequest.Builder> createInstancesFromSnapshotRequest)
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.
This is a convenience which creates an instance of the CreateInstancesFromSnapshotRequest.Builder
avoiding the need to create one manually via CreateInstancesFromSnapshotRequest.builder()
createInstancesFromSnapshotRequest
- A Consumer
that will call methods on CreateInstancesFromSnapshotRequest.Builder
to create
a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateKeyPairResponse> createKeyPair(CreateKeyPairRequest createKeyPairRequest)
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.
createKeyPairRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateKeyPairResponse> createKeyPair(Consumer<CreateKeyPairRequest.Builder> createKeyPairRequest)
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.
This is a convenience which creates an instance of the CreateKeyPairRequest.Builder
avoiding the need to
create one manually via CreateKeyPairRequest.builder()
createKeyPairRequest
- A Consumer
that will call methods on CreateKeyPairRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateLoadBalancerResponse> createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
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.
createLoadBalancerRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateLoadBalancerResponse> createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest)
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.
This is a convenience which creates an instance of the CreateLoadBalancerRequest.Builder
avoiding the
need to create one manually via CreateLoadBalancerRequest.builder()
createLoadBalancerRequest
- A Consumer
that will call methods on CreateLoadBalancerRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateLoadBalancerTlsCertificateResponse> createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest createLoadBalancerTlsCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
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.
createLoadBalancerTlsCertificateRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateLoadBalancerTlsCertificateResponse> createLoadBalancerTlsCertificate(Consumer<CreateLoadBalancerTlsCertificateRequest.Builder> createLoadBalancerTlsCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
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.
This is a convenience which creates an instance of the CreateLoadBalancerTlsCertificateRequest.Builder
avoiding the need to create one manually via CreateLoadBalancerTlsCertificateRequest.builder()
createLoadBalancerTlsCertificateRequest
- A Consumer
that will call methods on CreateLoadBalancerTlsCertificateRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateRelationalDatabaseResponse> createRelationalDatabase(CreateRelationalDatabaseRequest createRelationalDatabaseRequest)
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.
createRelationalDatabaseRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateRelationalDatabaseResponse> createRelationalDatabase(Consumer<CreateRelationalDatabaseRequest.Builder> createRelationalDatabaseRequest)
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.
This is a convenience which creates an instance of the CreateRelationalDatabaseRequest.Builder
avoiding
the need to create one manually via CreateRelationalDatabaseRequest.builder()
createRelationalDatabaseRequest
- A Consumer
that will call methods on CreateRelationalDatabaseRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateRelationalDatabaseFromSnapshotResponse> createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest createRelationalDatabaseFromSnapshotRequest)
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.
createRelationalDatabaseFromSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateRelationalDatabaseFromSnapshotResponse> createRelationalDatabaseFromSnapshot(Consumer<CreateRelationalDatabaseFromSnapshotRequest.Builder> createRelationalDatabaseFromSnapshotRequest)
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.
This is a convenience which creates an instance of the
CreateRelationalDatabaseFromSnapshotRequest.Builder
avoiding the need to create one manually via
CreateRelationalDatabaseFromSnapshotRequest.builder()
createRelationalDatabaseFromSnapshotRequest
- A Consumer
that will call methods on CreateRelationalDatabaseFromSnapshotRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateRelationalDatabaseSnapshotResponse> createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest createRelationalDatabaseSnapshotRequest)
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.
createRelationalDatabaseSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<CreateRelationalDatabaseSnapshotResponse> createRelationalDatabaseSnapshot(Consumer<CreateRelationalDatabaseSnapshotRequest.Builder> createRelationalDatabaseSnapshotRequest)
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.
This is a convenience which creates an instance of the CreateRelationalDatabaseSnapshotRequest.Builder
avoiding the need to create one manually via CreateRelationalDatabaseSnapshotRequest.builder()
createRelationalDatabaseSnapshotRequest
- A Consumer
that will call methods on CreateRelationalDatabaseSnapshotRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteAlarmResponse> deleteAlarm(DeleteAlarmRequest deleteAlarmRequest)
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.
deleteAlarmRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteAlarmResponse> deleteAlarm(Consumer<DeleteAlarmRequest.Builder> deleteAlarmRequest)
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.
This is a convenience which creates an instance of the DeleteAlarmRequest.Builder
avoiding the need to
create one manually via DeleteAlarmRequest.builder()
deleteAlarmRequest
- A Consumer
that will call methods on DeleteAlarmRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteAutoSnapshotResponse> deleteAutoSnapshot(DeleteAutoSnapshotRequest deleteAutoSnapshotRequest)
Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
deleteAutoSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteAutoSnapshotResponse> deleteAutoSnapshot(Consumer<DeleteAutoSnapshotRequest.Builder> deleteAutoSnapshotRequest)
Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
This is a convenience which creates an instance of the DeleteAutoSnapshotRequest.Builder
avoiding the
need to create one manually via DeleteAutoSnapshotRequest.builder()
deleteAutoSnapshotRequest
- A Consumer
that will call methods on DeleteAutoSnapshotRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
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.
deleteCertificateRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteCertificateResponse> deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)
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.
This is a convenience which creates an instance of the DeleteCertificateRequest.Builder
avoiding the need
to create one manually via DeleteCertificateRequest.builder()
deleteCertificateRequest
- A Consumer
that will call methods on DeleteCertificateRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteContactMethodResponse> deleteContactMethod(DeleteContactMethodRequest deleteContactMethodRequest)
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.
deleteContactMethodRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteContactMethodResponse> deleteContactMethod(Consumer<DeleteContactMethodRequest.Builder> deleteContactMethodRequest)
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.
This is a convenience which creates an instance of the DeleteContactMethodRequest.Builder
avoiding the
need to create one manually via DeleteContactMethodRequest.builder()
deleteContactMethodRequest
- A Consumer
that will call methods on DeleteContactMethodRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteContainerImageResponse> deleteContainerImage(DeleteContainerImageRequest deleteContainerImageRequest)
Deletes a container image that is registered to your Amazon Lightsail container service.
deleteContainerImageRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteContainerImageResponse> deleteContainerImage(Consumer<DeleteContainerImageRequest.Builder> deleteContainerImageRequest)
Deletes a container image that is registered to your Amazon Lightsail container service.
This is a convenience which creates an instance of the DeleteContainerImageRequest.Builder
avoiding the
need to create one manually via DeleteContainerImageRequest.builder()
deleteContainerImageRequest
- A Consumer
that will call methods on DeleteContainerImageRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteContainerServiceResponse> deleteContainerService(DeleteContainerServiceRequest deleteContainerServiceRequest)
Deletes your Amazon Lightsail container service.
deleteContainerServiceRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteContainerServiceResponse> deleteContainerService(Consumer<DeleteContainerServiceRequest.Builder> deleteContainerServiceRequest)
Deletes your Amazon Lightsail container service.
This is a convenience which creates an instance of the DeleteContainerServiceRequest.Builder
avoiding the
need to create one manually via DeleteContainerServiceRequest.builder()
deleteContainerServiceRequest
- A Consumer
that will call methods on DeleteContainerServiceRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteDiskResponse> deleteDisk(DeleteDiskRequest deleteDiskRequest)
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.
deleteDiskRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteDiskResponse> deleteDisk(Consumer<DeleteDiskRequest.Builder> deleteDiskRequest)
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.
This is a convenience which creates an instance of the DeleteDiskRequest.Builder
avoiding the need to
create one manually via DeleteDiskRequest.builder()
deleteDiskRequest
- A Consumer
that will call methods on DeleteDiskRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteDiskSnapshotResponse> deleteDiskSnapshot(DeleteDiskSnapshotRequest deleteDiskSnapshotRequest)
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.
deleteDiskSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteDiskSnapshotResponse> deleteDiskSnapshot(Consumer<DeleteDiskSnapshotRequest.Builder> deleteDiskSnapshotRequest)
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.
This is a convenience which creates an instance of the DeleteDiskSnapshotRequest.Builder
avoiding the
need to create one manually via DeleteDiskSnapshotRequest.builder()
deleteDiskSnapshotRequest
- A Consumer
that will call methods on DeleteDiskSnapshotRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteDistributionResponse> deleteDistribution(DeleteDistributionRequest deleteDistributionRequest)
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
deleteDistributionRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteDistributionResponse> deleteDistribution(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest)
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
This is a convenience which creates an instance of the DeleteDistributionRequest.Builder
avoiding the
need to create one manually via DeleteDistributionRequest.builder()
deleteDistributionRequest
- A Consumer
that will call methods on DeleteDistributionRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest)
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.
deleteDomainRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)
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.
This is a convenience which creates an instance of the DeleteDomainRequest.Builder
avoiding the need to
create one manually via DeleteDomainRequest.builder()
deleteDomainRequest
- A Consumer
that will call methods on DeleteDomainRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteDomainEntryResponse> deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest)
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.
deleteDomainEntryRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteDomainEntryResponse> deleteDomainEntry(Consumer<DeleteDomainEntryRequest.Builder> deleteDomainEntryRequest)
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.
This is a convenience which creates an instance of the DeleteDomainEntryRequest.Builder
avoiding the need
to create one manually via DeleteDomainEntryRequest.builder()
deleteDomainEntryRequest
- A Consumer
that will call methods on DeleteDomainEntryRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteInstanceResponse> deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
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.
deleteInstanceRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteInstanceResponse> deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest)
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.
This is a convenience which creates an instance of the DeleteInstanceRequest.Builder
avoiding the need to
create one manually via DeleteInstanceRequest.builder()
deleteInstanceRequest
- A Consumer
that will call methods on DeleteInstanceRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteInstanceSnapshotResponse> deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest)
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.
deleteInstanceSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteInstanceSnapshotResponse> deleteInstanceSnapshot(Consumer<DeleteInstanceSnapshotRequest.Builder> deleteInstanceSnapshotRequest)
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.
This is a convenience which creates an instance of the DeleteInstanceSnapshotRequest.Builder
avoiding the
need to create one manually via DeleteInstanceSnapshotRequest.builder()
deleteInstanceSnapshotRequest
- A Consumer
that will call methods on DeleteInstanceSnapshotRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteKeyPairResponse> deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)
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.
deleteKeyPairRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteKeyPairResponse> deleteKeyPair(Consumer<DeleteKeyPairRequest.Builder> deleteKeyPairRequest)
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.
This is a convenience which creates an instance of the DeleteKeyPairRequest.Builder
avoiding the need to
create one manually via DeleteKeyPairRequest.builder()
deleteKeyPairRequest
- A Consumer
that will call methods on DeleteKeyPairRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteKnownHostKeysResponse> deleteKnownHostKeys(DeleteKnownHostKeysRequest deleteKnownHostKeysRequest)
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.
deleteKnownHostKeysRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteKnownHostKeysResponse> deleteKnownHostKeys(Consumer<DeleteKnownHostKeysRequest.Builder> deleteKnownHostKeysRequest)
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.
This is a convenience which creates an instance of the DeleteKnownHostKeysRequest.Builder
avoiding the
need to create one manually via DeleteKnownHostKeysRequest.builder()
deleteKnownHostKeysRequest
- A Consumer
that will call methods on DeleteKnownHostKeysRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteLoadBalancerResponse> deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
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.
deleteLoadBalancerRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteLoadBalancerResponse> deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest)
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.
This is a convenience which creates an instance of the DeleteLoadBalancerRequest.Builder
avoiding the
need to create one manually via DeleteLoadBalancerRequest.builder()
deleteLoadBalancerRequest
- A Consumer
that will call methods on DeleteLoadBalancerRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteLoadBalancerTlsCertificateResponse> deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest deleteLoadBalancerTlsCertificateRequest)
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.
deleteLoadBalancerTlsCertificateRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteLoadBalancerTlsCertificateResponse> deleteLoadBalancerTlsCertificate(Consumer<DeleteLoadBalancerTlsCertificateRequest.Builder> deleteLoadBalancerTlsCertificateRequest)
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.
This is a convenience which creates an instance of the DeleteLoadBalancerTlsCertificateRequest.Builder
avoiding the need to create one manually via DeleteLoadBalancerTlsCertificateRequest.builder()
deleteLoadBalancerTlsCertificateRequest
- A Consumer
that will call methods on DeleteLoadBalancerTlsCertificateRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteRelationalDatabaseResponse> deleteRelationalDatabase(DeleteRelationalDatabaseRequest deleteRelationalDatabaseRequest)
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.
deleteRelationalDatabaseRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteRelationalDatabaseResponse> deleteRelationalDatabase(Consumer<DeleteRelationalDatabaseRequest.Builder> deleteRelationalDatabaseRequest)
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.
This is a convenience which creates an instance of the DeleteRelationalDatabaseRequest.Builder
avoiding
the need to create one manually via DeleteRelationalDatabaseRequest.builder()
deleteRelationalDatabaseRequest
- A Consumer
that will call methods on DeleteRelationalDatabaseRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteRelationalDatabaseSnapshotResponse> deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest deleteRelationalDatabaseSnapshotRequest)
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.
deleteRelationalDatabaseSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DeleteRelationalDatabaseSnapshotResponse> deleteRelationalDatabaseSnapshot(Consumer<DeleteRelationalDatabaseSnapshotRequest.Builder> deleteRelationalDatabaseSnapshotRequest)
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.
This is a convenience which creates an instance of the DeleteRelationalDatabaseSnapshotRequest.Builder
avoiding the need to create one manually via DeleteRelationalDatabaseSnapshotRequest.builder()
deleteRelationalDatabaseSnapshotRequest
- A Consumer
that will call methods on DeleteRelationalDatabaseSnapshotRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DetachCertificateFromDistributionResponse> detachCertificateFromDistribution(DetachCertificateFromDistributionRequest detachCertificateFromDistributionRequest)
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.
detachCertificateFromDistributionRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DetachCertificateFromDistributionResponse> detachCertificateFromDistribution(Consumer<DetachCertificateFromDistributionRequest.Builder> detachCertificateFromDistributionRequest)
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.
This is a convenience which creates an instance of the DetachCertificateFromDistributionRequest.Builder
avoiding the need to create one manually via DetachCertificateFromDistributionRequest.builder()
detachCertificateFromDistributionRequest
- A Consumer
that will call methods on DetachCertificateFromDistributionRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DetachDiskResponse> detachDisk(DetachDiskRequest detachDiskRequest)
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.
detachDiskRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DetachDiskResponse> detachDisk(Consumer<DetachDiskRequest.Builder> detachDiskRequest)
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.
This is a convenience which creates an instance of the DetachDiskRequest.Builder
avoiding the need to
create one manually via DetachDiskRequest.builder()
detachDiskRequest
- A Consumer
that will call methods on DetachDiskRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DetachInstancesFromLoadBalancerResponse> detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest detachInstancesFromLoadBalancerRequest)
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.
detachInstancesFromLoadBalancerRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DetachInstancesFromLoadBalancerResponse> detachInstancesFromLoadBalancer(Consumer<DetachInstancesFromLoadBalancerRequest.Builder> detachInstancesFromLoadBalancerRequest)
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.
This is a convenience which creates an instance of the DetachInstancesFromLoadBalancerRequest.Builder
avoiding the need to create one manually via DetachInstancesFromLoadBalancerRequest.builder()
detachInstancesFromLoadBalancerRequest
- A Consumer
that will call methods on DetachInstancesFromLoadBalancerRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DetachStaticIpResponse> detachStaticIp(DetachStaticIpRequest detachStaticIpRequest)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
detachStaticIpRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DetachStaticIpResponse> detachStaticIp(Consumer<DetachStaticIpRequest.Builder> detachStaticIpRequest)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
This is a convenience which creates an instance of the DetachStaticIpRequest.Builder
avoiding the need to
create one manually via DetachStaticIpRequest.builder()
detachStaticIpRequest
- A Consumer
that will call methods on DetachStaticIpRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DisableAddOnResponse> disableAddOn(DisableAddOnRequest disableAddOnRequest)
Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
disableAddOnRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DisableAddOnResponse> disableAddOn(Consumer<DisableAddOnRequest.Builder> disableAddOnRequest)
Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
This is a convenience which creates an instance of the DisableAddOnRequest.Builder
avoiding the need to
create one manually via DisableAddOnRequest.builder()
disableAddOnRequest
- A Consumer
that will call methods on DisableAddOnRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DownloadDefaultKeyPairResponse> downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest)
Downloads the default SSH key pair from the user's account.
downloadDefaultKeyPairRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DownloadDefaultKeyPairResponse> downloadDefaultKeyPair(Consumer<DownloadDefaultKeyPairRequest.Builder> downloadDefaultKeyPairRequest)
Downloads the default SSH key pair from the user's account.
This is a convenience which creates an instance of the DownloadDefaultKeyPairRequest.Builder
avoiding the
need to create one manually via DownloadDefaultKeyPairRequest.builder()
downloadDefaultKeyPairRequest
- A Consumer
that will call methods on DownloadDefaultKeyPairRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<DownloadDefaultKeyPairResponse> downloadDefaultKeyPair()
Downloads the default SSH key pair from the user's account.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<EnableAddOnResponse> enableAddOn(EnableAddOnRequest enableAddOnRequest)
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
enableAddOnRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<EnableAddOnResponse> enableAddOn(Consumer<EnableAddOnRequest.Builder> enableAddOnRequest)
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
This is a convenience which creates an instance of the EnableAddOnRequest.Builder
avoiding the need to
create one manually via EnableAddOnRequest.builder()
enableAddOnRequest
- A Consumer
that will call methods on EnableAddOnRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<ExportSnapshotResponse> exportSnapshot(ExportSnapshotRequest exportSnapshotRequest)
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.
exportSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<ExportSnapshotResponse> exportSnapshot(Consumer<ExportSnapshotRequest.Builder> exportSnapshotRequest)
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.
This is a convenience which creates an instance of the ExportSnapshotRequest.Builder
avoiding the need to
create one manually via ExportSnapshotRequest.builder()
exportSnapshotRequest
- A Consumer
that will call methods on ExportSnapshotRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetActiveNamesResponse> getActiveNames(GetActiveNamesRequest getActiveNamesRequest)
Returns the names of all active (not deleted) resources.
getActiveNamesRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetActiveNamesResponse> getActiveNames(Consumer<GetActiveNamesRequest.Builder> getActiveNamesRequest)
Returns the names of all active (not deleted) resources.
This is a convenience which creates an instance of the GetActiveNamesRequest.Builder
avoiding the need to
create one manually via GetActiveNamesRequest.builder()
getActiveNamesRequest
- A Consumer
that will call methods on GetActiveNamesRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetActiveNamesResponse> getActiveNames()
Returns the names of all active (not deleted) resources.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetAlarmsResponse> getAlarms(GetAlarmsRequest getAlarmsRequest)
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.
getAlarmsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetAlarmsResponse> getAlarms(Consumer<GetAlarmsRequest.Builder> getAlarmsRequest)
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.
This is a convenience which creates an instance of the GetAlarmsRequest.Builder
avoiding the need to
create one manually via GetAlarmsRequest.builder()
getAlarmsRequest
- A Consumer
that will call methods on GetAlarmsRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetAutoSnapshotsResponse> getAutoSnapshots(GetAutoSnapshotsRequest getAutoSnapshotsRequest)
Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide.
getAutoSnapshotsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetAutoSnapshotsResponse> getAutoSnapshots(Consumer<GetAutoSnapshotsRequest.Builder> getAutoSnapshotsRequest)
Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide.
This is a convenience which creates an instance of the GetAutoSnapshotsRequest.Builder
avoiding the need
to create one manually via GetAutoSnapshotsRequest.builder()
getAutoSnapshotsRequest
- A Consumer
that will call methods on GetAutoSnapshotsRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetBlueprintsResponse> getBlueprints(GetBlueprintsRequest getBlueprintsRequest)
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.
getBlueprintsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetBlueprintsResponse> getBlueprints(Consumer<GetBlueprintsRequest.Builder> getBlueprintsRequest)
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.
This is a convenience which creates an instance of the GetBlueprintsRequest.Builder
avoiding the need to
create one manually via GetBlueprintsRequest.builder()
getBlueprintsRequest
- A Consumer
that will call methods on GetBlueprintsRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetBlueprintsResponse> getBlueprints()
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.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetBundlesResponse> getBundles(GetBundlesRequest getBundlesRequest)
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
getBundlesRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetBundlesResponse> getBundles(Consumer<GetBundlesRequest.Builder> getBundlesRequest)
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
This is a convenience which creates an instance of the GetBundlesRequest.Builder
avoiding the need to
create one manually via GetBundlesRequest.builder()
getBundlesRequest
- A Consumer
that will call methods on GetBundlesRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetBundlesResponse> getBundles()
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetCertificatesResponse> getCertificates(GetCertificatesRequest getCertificatesRequest)
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.
getCertificatesRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetCertificatesResponse> getCertificates(Consumer<GetCertificatesRequest.Builder> getCertificatesRequest)
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.
This is a convenience which creates an instance of the GetCertificatesRequest.Builder
avoiding the need
to create one manually via GetCertificatesRequest.builder()
getCertificatesRequest
- A Consumer
that will call methods on GetCertificatesRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetCloudFormationStackRecordsResponse> getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest getCloudFormationStackRecordsRequest)
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.
getCloudFormationStackRecordsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetCloudFormationStackRecordsResponse> getCloudFormationStackRecords(Consumer<GetCloudFormationStackRecordsRequest.Builder> getCloudFormationStackRecordsRequest)
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.
This is a convenience which creates an instance of the GetCloudFormationStackRecordsRequest.Builder
avoiding the need to create one manually via GetCloudFormationStackRecordsRequest.builder()
getCloudFormationStackRecordsRequest
- A Consumer
that will call methods on GetCloudFormationStackRecordsRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetCloudFormationStackRecordsResponse> getCloudFormationStackRecords()
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.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContactMethodsResponse> getContactMethods(GetContactMethodsRequest getContactMethodsRequest)
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.
getContactMethodsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContactMethodsResponse> getContactMethods(Consumer<GetContactMethodsRequest.Builder> getContactMethodsRequest)
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.
This is a convenience which creates an instance of the GetContactMethodsRequest.Builder
avoiding the need
to create one manually via GetContactMethodsRequest.builder()
getContactMethodsRequest
- A Consumer
that will call methods on GetContactMethodsRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerApiMetadataResponse> getContainerAPIMetadata(GetContainerApiMetadataRequest getContainerApiMetadataRequest)
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
getContainerApiMetadataRequest
- default CompletableFuture<GetContainerApiMetadataResponse> getContainerAPIMetadata(Consumer<GetContainerApiMetadataRequest.Builder> getContainerApiMetadataRequest)
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
This is a convenience which creates an instance of the GetContainerApiMetadataRequest.Builder
avoiding
the need to create one manually via GetContainerApiMetadataRequest.builder()
getContainerApiMetadataRequest
- A Consumer
that will call methods on GetContainerAPIMetadataRequest.Builder
to create a
request.default CompletableFuture<GetContainerImagesResponse> getContainerImages(GetContainerImagesRequest getContainerImagesRequest)
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.
getContainerImagesRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerImagesResponse> getContainerImages(Consumer<GetContainerImagesRequest.Builder> getContainerImagesRequest)
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.
This is a convenience which creates an instance of the GetContainerImagesRequest.Builder
avoiding the
need to create one manually via GetContainerImagesRequest.builder()
getContainerImagesRequest
- A Consumer
that will call methods on GetContainerImagesRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerLogResponse> getContainerLog(GetContainerLogRequest getContainerLogRequest)
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.
getContainerLogRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerLogResponse> getContainerLog(Consumer<GetContainerLogRequest.Builder> getContainerLogRequest)
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.
This is a convenience which creates an instance of the GetContainerLogRequest.Builder
avoiding the need
to create one manually via GetContainerLogRequest.builder()
getContainerLogRequest
- A Consumer
that will call methods on GetContainerLogRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerServiceDeploymentsResponse> getContainerServiceDeployments(GetContainerServiceDeploymentsRequest getContainerServiceDeploymentsRequest)
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.
getContainerServiceDeploymentsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerServiceDeploymentsResponse> getContainerServiceDeployments(Consumer<GetContainerServiceDeploymentsRequest.Builder> getContainerServiceDeploymentsRequest)
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.
This is a convenience which creates an instance of the GetContainerServiceDeploymentsRequest.Builder
avoiding the need to create one manually via GetContainerServiceDeploymentsRequest.builder()
getContainerServiceDeploymentsRequest
- A Consumer
that will call methods on GetContainerServiceDeploymentsRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerServiceMetricDataResponse> getContainerServiceMetricData(GetContainerServiceMetricDataRequest getContainerServiceMetricDataRequest)
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.
getContainerServiceMetricDataRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerServiceMetricDataResponse> getContainerServiceMetricData(Consumer<GetContainerServiceMetricDataRequest.Builder> getContainerServiceMetricDataRequest)
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.
This is a convenience which creates an instance of the GetContainerServiceMetricDataRequest.Builder
avoiding the need to create one manually via GetContainerServiceMetricDataRequest.builder()
getContainerServiceMetricDataRequest
- A Consumer
that will call methods on GetContainerServiceMetricDataRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerServicePowersResponse> getContainerServicePowers(GetContainerServicePowersRequest getContainerServicePowersRequest)
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.
getContainerServicePowersRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerServicePowersResponse> getContainerServicePowers(Consumer<GetContainerServicePowersRequest.Builder> getContainerServicePowersRequest)
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.
This is a convenience which creates an instance of the GetContainerServicePowersRequest.Builder
avoiding
the need to create one manually via GetContainerServicePowersRequest.builder()
getContainerServicePowersRequest
- A Consumer
that will call methods on GetContainerServicePowersRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerServicesResponse> getContainerServices(GetContainerServicesRequest getContainerServicesRequest)
Returns information about one or more of your Amazon Lightsail container services.
getContainerServicesRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetContainerServicesResponse> getContainerServices(Consumer<GetContainerServicesRequest.Builder> getContainerServicesRequest)
Returns information about one or more of your Amazon Lightsail container services.
This is a convenience which creates an instance of the GetContainerServicesRequest.Builder
avoiding the
need to create one manually via GetContainerServicesRequest.builder()
getContainerServicesRequest
- A Consumer
that will call methods on GetContainerServicesRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDiskResponse> getDisk(GetDiskRequest getDiskRequest)
Returns information about a specific block storage disk.
getDiskRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDiskResponse> getDisk(Consumer<GetDiskRequest.Builder> getDiskRequest)
Returns information about a specific block storage disk.
This is a convenience which creates an instance of the GetDiskRequest.Builder
avoiding the need to create
one manually via GetDiskRequest.builder()
getDiskRequest
- A Consumer
that will call methods on GetDiskRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDiskSnapshotResponse> getDiskSnapshot(GetDiskSnapshotRequest getDiskSnapshotRequest)
Returns information about a specific block storage disk snapshot.
getDiskSnapshotRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDiskSnapshotResponse> getDiskSnapshot(Consumer<GetDiskSnapshotRequest.Builder> getDiskSnapshotRequest)
Returns information about a specific block storage disk snapshot.
This is a convenience which creates an instance of the GetDiskSnapshotRequest.Builder
avoiding the need
to create one manually via GetDiskSnapshotRequest.builder()
getDiskSnapshotRequest
- A Consumer
that will call methods on GetDiskSnapshotRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDiskSnapshotsResponse> getDiskSnapshots(GetDiskSnapshotsRequest getDiskSnapshotsRequest)
Returns information about all block storage disk snapshots in your AWS account and region.
getDiskSnapshotsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDiskSnapshotsResponse> getDiskSnapshots(Consumer<GetDiskSnapshotsRequest.Builder> getDiskSnapshotsRequest)
Returns information about all block storage disk snapshots in your AWS account and region.
This is a convenience which creates an instance of the GetDiskSnapshotsRequest.Builder
avoiding the need
to create one manually via GetDiskSnapshotsRequest.builder()
getDiskSnapshotsRequest
- A Consumer
that will call methods on GetDiskSnapshotsRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDiskSnapshotsResponse> getDiskSnapshots()
Returns information about all block storage disk snapshots in your AWS account and region.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDisksResponse> getDisks(GetDisksRequest getDisksRequest)
Returns information about all block storage disks in your AWS account and region.
getDisksRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDisksResponse> getDisks(Consumer<GetDisksRequest.Builder> getDisksRequest)
Returns information about all block storage disks in your AWS account and region.
This is a convenience which creates an instance of the GetDisksRequest.Builder
avoiding the need to
create one manually via GetDisksRequest.builder()
getDisksRequest
- A Consumer
that will call methods on GetDisksRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDisksResponse> getDisks()
Returns information about all block storage disks in your AWS account and region.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDistributionBundlesResponse> getDistributionBundles(GetDistributionBundlesRequest getDistributionBundlesRequest)
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.
getDistributionBundlesRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDistributionBundlesResponse> getDistributionBundles(Consumer<GetDistributionBundlesRequest.Builder> getDistributionBundlesRequest)
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.
This is a convenience which creates an instance of the GetDistributionBundlesRequest.Builder
avoiding the
need to create one manually via GetDistributionBundlesRequest.builder()
getDistributionBundlesRequest
- A Consumer
that will call methods on GetDistributionBundlesRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDistributionLatestCacheResetResponse> getDistributionLatestCacheReset(GetDistributionLatestCacheResetRequest getDistributionLatestCacheResetRequest)
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
getDistributionLatestCacheResetRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDistributionLatestCacheResetResponse> getDistributionLatestCacheReset(Consumer<GetDistributionLatestCacheResetRequest.Builder> getDistributionLatestCacheResetRequest)
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
This is a convenience which creates an instance of the GetDistributionLatestCacheResetRequest.Builder
avoiding the need to create one manually via GetDistributionLatestCacheResetRequest.builder()
getDistributionLatestCacheResetRequest
- A Consumer
that will call methods on GetDistributionLatestCacheResetRequest.Builder
to
create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDistributionMetricDataResponse> getDistributionMetricData(GetDistributionMetricDataRequest getDistributionMetricDataRequest)
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.
getDistributionMetricDataRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDistributionMetricDataResponse> getDistributionMetricData(Consumer<GetDistributionMetricDataRequest.Builder> getDistributionMetricDataRequest)
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.
This is a convenience which creates an instance of the GetDistributionMetricDataRequest.Builder
avoiding
the need to create one manually via GetDistributionMetricDataRequest.builder()
getDistributionMetricDataRequest
- A Consumer
that will call methods on GetDistributionMetricDataRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDistributionsResponse> getDistributions(GetDistributionsRequest getDistributionsRequest)
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
getDistributionsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDistributionsResponse> getDistributions(Consumer<GetDistributionsRequest.Builder> getDistributionsRequest)
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
This is a convenience which creates an instance of the GetDistributionsRequest.Builder
avoiding the need
to create one manually via GetDistributionsRequest.builder()
getDistributionsRequest
- A Consumer
that will call methods on GetDistributionsRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDomainResponse> getDomain(GetDomainRequest getDomainRequest)
Returns information about a specific domain recordset.
getDomainRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDomainResponse> getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)
Returns information about a specific domain recordset.
This is a convenience which creates an instance of the GetDomainRequest.Builder
avoiding the need to
create one manually via GetDomainRequest.builder()
getDomainRequest
- A Consumer
that will call methods on GetDomainRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDomainsResponse> getDomains(GetDomainsRequest getDomainsRequest)
Returns a list of all domains in the user's account.
getDomainsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDomainsResponse> getDomains(Consumer<GetDomainsRequest.Builder> getDomainsRequest)
Returns a list of all domains in the user's account.
This is a convenience which creates an instance of the GetDomainsRequest.Builder
avoiding the need to
create one manually via GetDomainsRequest.builder()
getDomainsRequest
- A Consumer
that will call methods on GetDomainsRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetDomainsResponse> getDomains()
Returns a list of all domains in the user's account.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetExportSnapshotRecordsResponse> getExportSnapshotRecords(GetExportSnapshotRecordsRequest getExportSnapshotRecordsRequest)
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.
getExportSnapshotRecordsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetExportSnapshotRecordsResponse> getExportSnapshotRecords(Consumer<GetExportSnapshotRecordsRequest.Builder> getExportSnapshotRecordsRequest)
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.
This is a convenience which creates an instance of the GetExportSnapshotRecordsRequest.Builder
avoiding
the need to create one manually via GetExportSnapshotRecordsRequest.builder()
getExportSnapshotRecordsRequest
- A Consumer
that will call methods on GetExportSnapshotRecordsRequest.Builder
to create a
request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetExportSnapshotRecordsResponse> getExportSnapshotRecords()
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.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetInstanceResponse> getInstance(GetInstanceRequest getInstanceRequest)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
getInstanceRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetInstanceResponse> getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
This is a convenience which creates an instance of the GetInstanceRequest.Builder
avoiding the need to
create one manually via GetInstanceRequest.builder()
getInstanceRequest
- A Consumer
that will call methods on GetInstanceRequest.Builder
to create a request.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetInstanceAccessDetailsResponse> getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest)
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.
getInstanceAccessDetailsRequest
-
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) AWS Region.
Please set your AWS Region configuration to us-east-1
to create, view, or edit these
resources.
default CompletableFuture<GetInstanceAccessDetailsResponse> getInstanceAccessDetails(Consumer<GetInstanceAccessDetailsRequest.Builder> getInstanceAccessDetailsRequest)
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.
This is a convenience which creates an instance of the GetInstanceAccessDetailsRequest.Builder
avoiding
the need to create one manually via GetInstanceAccessDetailsRequest.builder()
getInstanceAccessDetailsRequest
- A Consumer
that will call methods on GetInstanceAccessDetailsRequest.Builder
to create a
request.