Interface LightsailClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) 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, storage buckets, 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, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer 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 Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AllocateStaticIpResponse
allocateStaticIp
(Consumer<AllocateStaticIpRequest.Builder> allocateStaticIpRequest) Allocates a static IP address.default AllocateStaticIpResponse
allocateStaticIp
(AllocateStaticIpRequest allocateStaticIpRequest) Allocates a static IP address.attachCertificateToDistribution
(Consumer<AttachCertificateToDistributionRequest.Builder> attachCertificateToDistributionRequest) Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.attachCertificateToDistribution
(AttachCertificateToDistributionRequest attachCertificateToDistributionRequest) Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.default 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 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.attachInstancesToLoadBalancer
(Consumer<AttachInstancesToLoadBalancerRequest.Builder> attachInstancesToLoadBalancerRequest) Attaches one or more Lightsail instances to a load balancer.attachInstancesToLoadBalancer
(AttachInstancesToLoadBalancerRequest attachInstancesToLoadBalancerRequest) Attaches one or more Lightsail instances to a load balancer.attachLoadBalancerTlsCertificate
(Consumer<AttachLoadBalancerTlsCertificateRequest.Builder> attachLoadBalancerTlsCertificateRequest) Attaches a Transport Layer Security (TLS) certificate to your load balancer.attachLoadBalancerTlsCertificate
(AttachLoadBalancerTlsCertificateRequest attachLoadBalancerTlsCertificateRequest) Attaches a Transport Layer Security (TLS) certificate to your load balancer.default AttachStaticIpResponse
attachStaticIp
(Consumer<AttachStaticIpRequest.Builder> attachStaticIpRequest) Attaches a static IP address to a specific Amazon Lightsail instance.default AttachStaticIpResponse
attachStaticIp
(AttachStaticIpRequest attachStaticIpRequest) Attaches a static IP address to a specific Amazon Lightsail instance.static LightsailClientBuilder
builder()
Create a builder that can be used to configure and create aLightsailClient
.default CloseInstancePublicPortsResponse
closeInstancePublicPorts
(Consumer<CloseInstancePublicPortsRequest.Builder> closeInstancePublicPortsRequest) Closes ports for a specific Amazon Lightsail instance.default CloseInstancePublicPortsResponse
closeInstancePublicPorts
(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest) Closes ports for a specific Amazon Lightsail instance.default 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 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 LightsailClient
create()
Create aLightsailClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateBucketResponse
createBucket
(Consumer<CreateBucketRequest.Builder> createBucketRequest) Creates an Amazon Lightsail bucket.default CreateBucketResponse
createBucket
(CreateBucketRequest createBucketRequest) Creates an Amazon Lightsail bucket.default CreateBucketAccessKeyResponse
createBucketAccessKey
(Consumer<CreateBucketAccessKeyRequest.Builder> createBucketAccessKeyRequest) Creates a new access key for the specified Amazon Lightsail bucket.default CreateBucketAccessKeyResponse
createBucketAccessKey
(CreateBucketAccessKeyRequest createBucketAccessKeyRequest) Creates a new access key for the specified Amazon Lightsail bucket.default 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 CreateCertificateResponse
createCertificate
(CreateCertificateRequest createCertificateRequest) Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.createCloudFormationStack
(Consumer<CreateCloudFormationStackRequest.Builder> createCloudFormationStackRequest) Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot.createCloudFormationStack
(CreateCloudFormationStackRequest createCloudFormationStackRequest) Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot.default CreateContactMethodResponse
createContactMethod
(Consumer<CreateContactMethodRequest.Builder> createContactMethodRequest) Creates an email or SMS text message contact method.default CreateContactMethodResponse
createContactMethod
(CreateContactMethodRequest createContactMethodRequest) Creates an email or SMS text message contact method.default CreateContainerServiceResponse
createContainerService
(Consumer<CreateContainerServiceRequest.Builder> createContainerServiceRequest) Creates an Amazon Lightsail container service.default CreateContainerServiceResponse
createContainerService
(CreateContainerServiceRequest createContainerServiceRequest) Creates an Amazon Lightsail container service.createContainerServiceDeployment
(Consumer<CreateContainerServiceDeploymentRequest.Builder> createContainerServiceDeploymentRequest) Creates a deployment for your Amazon Lightsail container service.createContainerServiceDeployment
(CreateContainerServiceDeploymentRequest createContainerServiceDeploymentRequest) Creates a deployment for your Amazon Lightsail container service.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.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 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 (us-east-2a
).default CreateDiskResponse
createDisk
(CreateDiskRequest createDiskRequest) Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a
).default CreateDiskFromSnapshotResponse
createDiskFromSnapshot
(Consumer<CreateDiskFromSnapshotRequest.Builder> createDiskFromSnapshotRequest) Creates a block storage disk from a manual or automatic snapshot of a disk.default CreateDiskFromSnapshotResponse
createDiskFromSnapshot
(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest) Creates a block storage disk from a manual or automatic snapshot of a disk.default CreateDiskSnapshotResponse
createDiskSnapshot
(Consumer<CreateDiskSnapshotRequest.Builder> createDiskSnapshotRequest) Creates a snapshot of a block storage disk.default CreateDiskSnapshotResponse
createDiskSnapshot
(CreateDiskSnapshotRequest createDiskSnapshotRequest) Creates a snapshot of a block storage disk.default CreateDistributionResponse
createDistribution
(Consumer<CreateDistributionRequest.Builder> createDistributionRequest) Creates an Amazon Lightsail content delivery network (CDN) distribution.default CreateDistributionResponse
createDistribution
(CreateDistributionRequest createDistributionRequest) Creates an Amazon Lightsail content delivery network (CDN) distribution.default CreateDomainResponse
createDomain
(Consumer<CreateDomainRequest.Builder> createDomainRequest) Creates a domain resource for the specified domain (example.com).default CreateDomainResponse
createDomain
(CreateDomainRequest createDomainRequest) Creates a domain resource for the specified domain (example.com).default 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 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).createGUISessionAccessDetails
(Consumer<CreateGuiSessionAccessDetailsRequest.Builder> createGuiSessionAccessDetailsRequest) Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session.createGUISessionAccessDetails
(CreateGuiSessionAccessDetailsRequest createGuiSessionAccessDetailsRequest) Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session.default CreateInstancesResponse
createInstances
(Consumer<CreateInstancesRequest.Builder> createInstancesRequest) Creates one or more Amazon Lightsail instances.default CreateInstancesResponse
createInstances
(CreateInstancesRequest createInstancesRequest) Creates one or more Amazon Lightsail instances.createInstancesFromSnapshot
(Consumer<CreateInstancesFromSnapshotRequest.Builder> createInstancesFromSnapshotRequest) Creates one or more new instances from a manual or automatic snapshot of an instance.createInstancesFromSnapshot
(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest) Creates one or more new instances from a manual or automatic snapshot of an instance.default CreateInstanceSnapshotResponse
createInstanceSnapshot
(Consumer<CreateInstanceSnapshotRequest.Builder> createInstanceSnapshotRequest) Creates a snapshot of a specific virtual private server, or instance.default CreateInstanceSnapshotResponse
createInstanceSnapshot
(CreateInstanceSnapshotRequest createInstanceSnapshotRequest) Creates a snapshot of a specific virtual private server, or instance.default CreateKeyPairResponse
createKeyPair
(Consumer<CreateKeyPairRequest.Builder> createKeyPairRequest) Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.default CreateKeyPairResponse
createKeyPair
(CreateKeyPairRequest createKeyPairRequest) Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.default CreateLoadBalancerResponse
createLoadBalancer
(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest) Creates a Lightsail load balancer.default CreateLoadBalancerResponse
createLoadBalancer
(CreateLoadBalancerRequest createLoadBalancerRequest) Creates a Lightsail load balancer.createLoadBalancerTlsCertificate
(Consumer<CreateLoadBalancerTlsCertificateRequest.Builder> createLoadBalancerTlsCertificateRequest) Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.createLoadBalancerTlsCertificate
(CreateLoadBalancerTlsCertificateRequest createLoadBalancerTlsCertificateRequest) Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.default CreateRelationalDatabaseResponse
createRelationalDatabase
(Consumer<CreateRelationalDatabaseRequest.Builder> createRelationalDatabaseRequest) Creates a new database in Amazon Lightsail.default CreateRelationalDatabaseResponse
createRelationalDatabase
(CreateRelationalDatabaseRequest createRelationalDatabaseRequest) Creates a new database in Amazon Lightsail.createRelationalDatabaseFromSnapshot
(Consumer<CreateRelationalDatabaseFromSnapshotRequest.Builder> createRelationalDatabaseFromSnapshotRequest) Creates a new database from an existing database snapshot in Amazon Lightsail.createRelationalDatabaseFromSnapshot
(CreateRelationalDatabaseFromSnapshotRequest createRelationalDatabaseFromSnapshotRequest) Creates a new database from an existing database snapshot in Amazon Lightsail.createRelationalDatabaseSnapshot
(Consumer<CreateRelationalDatabaseSnapshotRequest.Builder> createRelationalDatabaseSnapshotRequest) Creates a snapshot of your database in Amazon Lightsail.createRelationalDatabaseSnapshot
(CreateRelationalDatabaseSnapshotRequest createRelationalDatabaseSnapshotRequest) Creates a snapshot of your database in Amazon Lightsail.default DeleteAlarmResponse
deleteAlarm
(Consumer<DeleteAlarmRequest.Builder> deleteAlarmRequest) Deletes an alarm.default DeleteAlarmResponse
deleteAlarm
(DeleteAlarmRequest deleteAlarmRequest) Deletes an alarm.default DeleteAutoSnapshotResponse
deleteAutoSnapshot
(Consumer<DeleteAutoSnapshotRequest.Builder> deleteAutoSnapshotRequest) Deletes an automatic snapshot of an instance or disk.default DeleteAutoSnapshotResponse
deleteAutoSnapshot
(DeleteAutoSnapshotRequest deleteAutoSnapshotRequest) Deletes an automatic snapshot of an instance or disk.default DeleteBucketResponse
deleteBucket
(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest) Deletes a Amazon Lightsail bucket.default DeleteBucketResponse
deleteBucket
(DeleteBucketRequest deleteBucketRequest) Deletes a Amazon Lightsail bucket.default DeleteBucketAccessKeyResponse
deleteBucketAccessKey
(Consumer<DeleteBucketAccessKeyRequest.Builder> deleteBucketAccessKeyRequest) Deletes an access key for the specified Amazon Lightsail bucket.default DeleteBucketAccessKeyResponse
deleteBucketAccessKey
(DeleteBucketAccessKeyRequest deleteBucketAccessKeyRequest) Deletes an access key for the specified Amazon Lightsail bucket.default DeleteCertificateResponse
deleteCertificate
(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.default DeleteCertificateResponse
deleteCertificate
(DeleteCertificateRequest deleteCertificateRequest) Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.default DeleteContactMethodResponse
deleteContactMethod
(Consumer<DeleteContactMethodRequest.Builder> deleteContactMethodRequest) Deletes a contact method.default DeleteContactMethodResponse
deleteContactMethod
(DeleteContactMethodRequest deleteContactMethodRequest) Deletes a contact method.default DeleteContainerImageResponse
deleteContainerImage
(Consumer<DeleteContainerImageRequest.Builder> deleteContainerImageRequest) Deletes a container image that is registered to your Amazon Lightsail container service.default DeleteContainerImageResponse
deleteContainerImage
(DeleteContainerImageRequest deleteContainerImageRequest) Deletes a container image that is registered to your Amazon Lightsail container service.default DeleteContainerServiceResponse
deleteContainerService
(Consumer<DeleteContainerServiceRequest.Builder> deleteContainerServiceRequest) Deletes your Amazon Lightsail container service.default DeleteContainerServiceResponse
deleteContainerService
(DeleteContainerServiceRequest deleteContainerServiceRequest) Deletes your Amazon Lightsail container service.default DeleteDiskResponse
deleteDisk
(Consumer<DeleteDiskRequest.Builder> deleteDiskRequest) Deletes the specified block storage disk.default DeleteDiskResponse
deleteDisk
(DeleteDiskRequest deleteDiskRequest) Deletes the specified block storage disk.default DeleteDiskSnapshotResponse
deleteDiskSnapshot
(Consumer<DeleteDiskSnapshotRequest.Builder> deleteDiskSnapshotRequest) Deletes the specified disk snapshot.default DeleteDiskSnapshotResponse
deleteDiskSnapshot
(DeleteDiskSnapshotRequest deleteDiskSnapshotRequest) Deletes the specified disk snapshot.default DeleteDistributionResponse
deleteDistribution
(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest) Deletes your Amazon Lightsail content delivery network (CDN) distribution.default DeleteDistributionResponse
deleteDistribution
(DeleteDistributionRequest deleteDistributionRequest) Deletes your Amazon Lightsail content delivery network (CDN) distribution.default DeleteDomainResponse
deleteDomain
(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) Deletes the specified domain recordset and all of its domain records.default DeleteDomainResponse
deleteDomain
(DeleteDomainRequest deleteDomainRequest) Deletes the specified domain recordset and all of its domain records.default DeleteDomainEntryResponse
deleteDomainEntry
(Consumer<DeleteDomainEntryRequest.Builder> deleteDomainEntryRequest) Deletes a specific domain entry.default DeleteDomainEntryResponse
deleteDomainEntry
(DeleteDomainEntryRequest deleteDomainEntryRequest) Deletes a specific domain entry.default DeleteInstanceResponse
deleteInstance
(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) Deletes an Amazon Lightsail instance.default DeleteInstanceResponse
deleteInstance
(DeleteInstanceRequest deleteInstanceRequest) Deletes an Amazon Lightsail instance.default DeleteInstanceSnapshotResponse
deleteInstanceSnapshot
(Consumer<DeleteInstanceSnapshotRequest.Builder> deleteInstanceSnapshotRequest) Deletes a specific snapshot of a virtual private server (or instance).default DeleteInstanceSnapshotResponse
deleteInstanceSnapshot
(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest) Deletes a specific snapshot of a virtual private server (or instance).default DeleteKeyPairResponse
deleteKeyPair
(Consumer<DeleteKeyPairRequest.Builder> deleteKeyPairRequest) Deletes the specified key pair by removing the public key from Amazon Lightsail.default DeleteKeyPairResponse
deleteKeyPair
(DeleteKeyPairRequest deleteKeyPairRequest) Deletes the specified key pair by removing the public key from Amazon Lightsail.default 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 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 DeleteLoadBalancerResponse
deleteLoadBalancer
(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest) Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.default DeleteLoadBalancerResponse
deleteLoadBalancer
(DeleteLoadBalancerRequest deleteLoadBalancerRequest) Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.deleteLoadBalancerTlsCertificate
(Consumer<DeleteLoadBalancerTlsCertificateRequest.Builder> deleteLoadBalancerTlsCertificateRequest) Deletes an SSL/TLS certificate associated with a Lightsail load balancer.deleteLoadBalancerTlsCertificate
(DeleteLoadBalancerTlsCertificateRequest deleteLoadBalancerTlsCertificateRequest) Deletes an SSL/TLS certificate associated with a Lightsail load balancer.default DeleteRelationalDatabaseResponse
deleteRelationalDatabase
(Consumer<DeleteRelationalDatabaseRequest.Builder> deleteRelationalDatabaseRequest) Deletes a database in Amazon Lightsail.default DeleteRelationalDatabaseResponse
deleteRelationalDatabase
(DeleteRelationalDatabaseRequest deleteRelationalDatabaseRequest) Deletes a database in Amazon Lightsail.deleteRelationalDatabaseSnapshot
(Consumer<DeleteRelationalDatabaseSnapshotRequest.Builder> deleteRelationalDatabaseSnapshotRequest) Deletes a database snapshot in Amazon Lightsail.deleteRelationalDatabaseSnapshot
(DeleteRelationalDatabaseSnapshotRequest deleteRelationalDatabaseSnapshotRequest) Deletes a database snapshot in Amazon Lightsail.detachCertificateFromDistribution
(Consumer<DetachCertificateFromDistributionRequest.Builder> detachCertificateFromDistributionRequest) Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.detachCertificateFromDistribution
(DetachCertificateFromDistributionRequest detachCertificateFromDistributionRequest) Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.default DetachDiskResponse
detachDisk
(Consumer<DetachDiskRequest.Builder> detachDiskRequest) Detaches a stopped block storage disk from a Lightsail instance.default DetachDiskResponse
detachDisk
(DetachDiskRequest detachDiskRequest) Detaches a stopped block storage disk from a Lightsail instance.detachInstancesFromLoadBalancer
(Consumer<DetachInstancesFromLoadBalancerRequest.Builder> detachInstancesFromLoadBalancerRequest) Detaches the specified instances from a Lightsail load balancer.detachInstancesFromLoadBalancer
(DetachInstancesFromLoadBalancerRequest detachInstancesFromLoadBalancerRequest) Detaches the specified instances from a Lightsail load balancer.default DetachStaticIpResponse
detachStaticIp
(Consumer<DetachStaticIpRequest.Builder> detachStaticIpRequest) Detaches a static IP from the Amazon Lightsail instance to which it is attached.default DetachStaticIpResponse
detachStaticIp
(DetachStaticIpRequest detachStaticIpRequest) Detaches a static IP from the Amazon Lightsail instance to which it is attached.default DisableAddOnResponse
disableAddOn
(Consumer<DisableAddOnRequest.Builder> disableAddOnRequest) Disables an add-on for an Amazon Lightsail resource.default DisableAddOnResponse
disableAddOn
(DisableAddOnRequest disableAddOnRequest) Disables an add-on for an Amazon Lightsail resource.default DownloadDefaultKeyPairResponse
Downloads the regional Amazon Lightsail default key pair.default DownloadDefaultKeyPairResponse
downloadDefaultKeyPair
(Consumer<DownloadDefaultKeyPairRequest.Builder> downloadDefaultKeyPairRequest) Downloads the regional Amazon Lightsail default key pair.default DownloadDefaultKeyPairResponse
downloadDefaultKeyPair
(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest) Downloads the regional Amazon Lightsail default key pair.default EnableAddOnResponse
enableAddOn
(Consumer<EnableAddOnRequest.Builder> enableAddOnRequest) Enables or modifies an add-on for an Amazon Lightsail resource.default EnableAddOnResponse
enableAddOn
(EnableAddOnRequest enableAddOnRequest) Enables or modifies an add-on for an Amazon Lightsail resource.default ExportSnapshotResponse
exportSnapshot
(Consumer<ExportSnapshotRequest.Builder> exportSnapshotRequest) Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).default ExportSnapshotResponse
exportSnapshot
(ExportSnapshotRequest exportSnapshotRequest) Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).default GetActiveNamesResponse
Returns the names of all active (not deleted) resources.default GetActiveNamesResponse
getActiveNames
(Consumer<GetActiveNamesRequest.Builder> getActiveNamesRequest) Returns the names of all active (not deleted) resources.default GetActiveNamesResponse
getActiveNames
(GetActiveNamesRequest getActiveNamesRequest) Returns the names of all active (not deleted) resources.default GetAlarmsResponse
getAlarms
(Consumer<GetAlarmsRequest.Builder> getAlarmsRequest) Returns information about the configured alarms.default GetAlarmsResponse
getAlarms
(GetAlarmsRequest getAlarmsRequest) Returns information about the configured alarms.default GetAutoSnapshotsResponse
getAutoSnapshots
(Consumer<GetAutoSnapshotsRequest.Builder> getAutoSnapshotsRequest) Returns the available automatic snapshots for an instance or disk.default GetAutoSnapshotsResponse
getAutoSnapshots
(GetAutoSnapshotsRequest getAutoSnapshotsRequest) Returns the available automatic snapshots for an instance or disk.default GetBlueprintsResponse
Returns the list of available instance images, or blueprints.default GetBlueprintsResponse
getBlueprints
(Consumer<GetBlueprintsRequest.Builder> getBlueprintsRequest) Returns the list of available instance images, or blueprints.default GetBlueprintsResponse
getBlueprints
(GetBlueprintsRequest getBlueprintsRequest) Returns the list of available instance images, or blueprints.default GetBucketAccessKeysResponse
getBucketAccessKeys
(Consumer<GetBucketAccessKeysRequest.Builder> getBucketAccessKeysRequest) Returns the existing access key IDs for the specified Amazon Lightsail bucket.default GetBucketAccessKeysResponse
getBucketAccessKeys
(GetBucketAccessKeysRequest getBucketAccessKeysRequest) Returns the existing access key IDs for the specified Amazon Lightsail bucket.default GetBucketBundlesResponse
getBucketBundles
(Consumer<GetBucketBundlesRequest.Builder> getBucketBundlesRequest) Returns the bundles that you can apply to a Amazon Lightsail bucket.default GetBucketBundlesResponse
getBucketBundles
(GetBucketBundlesRequest getBucketBundlesRequest) Returns the bundles that you can apply to a Amazon Lightsail bucket.default GetBucketMetricDataResponse
getBucketMetricData
(Consumer<GetBucketMetricDataRequest.Builder> getBucketMetricDataRequest) Returns the data points of a specific metric for an Amazon Lightsail bucket.default GetBucketMetricDataResponse
getBucketMetricData
(GetBucketMetricDataRequest getBucketMetricDataRequest) Returns the data points of a specific metric for an Amazon Lightsail bucket.default GetBucketsResponse
getBuckets
(Consumer<GetBucketsRequest.Builder> getBucketsRequest) Returns information about one or more Amazon Lightsail buckets.default GetBucketsResponse
getBuckets
(GetBucketsRequest getBucketsRequest) Returns information about one or more Amazon Lightsail buckets.default GetBundlesResponse
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.default GetBundlesResponse
getBundles
(Consumer<GetBundlesRequest.Builder> getBundlesRequest) Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.default GetBundlesResponse
getBundles
(GetBundlesRequest getBundlesRequest) Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.default GetCertificatesResponse
getCertificates
(Consumer<GetCertificatesRequest.Builder> getCertificatesRequest) Returns information about one or more Amazon Lightsail SSL/TLS certificates.default GetCertificatesResponse
getCertificates
(GetCertificatesRequest getCertificatesRequest) Returns information about one or more Amazon Lightsail SSL/TLS certificates.Returns the CloudFormation stack record created as a result of thecreate cloud formation stack
operation.getCloudFormationStackRecords
(Consumer<GetCloudFormationStackRecordsRequest.Builder> getCloudFormationStackRecordsRequest) Returns the CloudFormation stack record created as a result of thecreate cloud formation stack
operation.getCloudFormationStackRecords
(GetCloudFormationStackRecordsRequest getCloudFormationStackRecordsRequest) Returns the CloudFormation stack record created as a result of thecreate cloud formation stack
operation.default GetContactMethodsResponse
getContactMethods
(Consumer<GetContactMethodsRequest.Builder> getContactMethodsRequest) Returns information about the configured contact methods.default GetContactMethodsResponse
getContactMethods
(GetContactMethodsRequest getContactMethodsRequest) Returns information about the configured contact methods.default GetContainerApiMetadataResponse
getContainerAPIMetadata
(Consumer<GetContainerApiMetadataRequest.Builder> getContainerApiMetadataRequest) Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.default GetContainerApiMetadataResponse
getContainerAPIMetadata
(GetContainerApiMetadataRequest getContainerApiMetadataRequest) Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.default GetContainerImagesResponse
getContainerImages
(Consumer<GetContainerImagesRequest.Builder> getContainerImagesRequest) Returns the container images that are registered to your Amazon Lightsail container service.default GetContainerImagesResponse
getContainerImages
(GetContainerImagesRequest getContainerImagesRequest) Returns the container images that are registered to your Amazon Lightsail container service.default GetContainerLogResponse
getContainerLog
(Consumer<GetContainerLogRequest.Builder> getContainerLogRequest) Returns the log events of a container of your Amazon Lightsail container service.default GetContainerLogResponse
getContainerLog
(GetContainerLogRequest getContainerLogRequest) Returns the log events of a container of your Amazon Lightsail container service.getContainerServiceDeployments
(Consumer<GetContainerServiceDeploymentsRequest.Builder> getContainerServiceDeploymentsRequest) Returns the deployments for your Amazon Lightsail container servicegetContainerServiceDeployments
(GetContainerServiceDeploymentsRequest getContainerServiceDeploymentsRequest) Returns the deployments for your Amazon Lightsail container servicegetContainerServiceMetricData
(Consumer<GetContainerServiceMetricDataRequest.Builder> getContainerServiceMetricDataRequest) Returns the data points of a specific metric of your Amazon Lightsail container service.getContainerServiceMetricData
(GetContainerServiceMetricDataRequest getContainerServiceMetricDataRequest) Returns the data points of a specific metric of your Amazon Lightsail container service.getContainerServicePowers
(Consumer<GetContainerServicePowersRequest.Builder> getContainerServicePowersRequest) Returns the list of powers that can be specified for your Amazon Lightsail container services.getContainerServicePowers
(GetContainerServicePowersRequest getContainerServicePowersRequest) Returns the list of powers that can be specified for your Amazon Lightsail container services.default GetContainerServicesResponse
getContainerServices
(Consumer<GetContainerServicesRequest.Builder> getContainerServicesRequest) Returns information about one or more of your Amazon Lightsail container services.default GetContainerServicesResponse
getContainerServices
(GetContainerServicesRequest getContainerServicesRequest) Returns information about one or more of your Amazon Lightsail container services.default GetCostEstimateResponse
getCostEstimate
(Consumer<GetCostEstimateRequest.Builder> getCostEstimateRequest) Retrieves information about the cost estimate for a specified resource.default GetCostEstimateResponse
getCostEstimate
(GetCostEstimateRequest getCostEstimateRequest) Retrieves information about the cost estimate for a specified resource.default GetDiskResponse
getDisk
(Consumer<GetDiskRequest.Builder> getDiskRequest) Returns information about a specific block storage disk.default GetDiskResponse
getDisk
(GetDiskRequest getDiskRequest) Returns information about a specific block storage disk.default GetDisksResponse
getDisks()
Returns information about all block storage disks in your AWS account and region.default GetDisksResponse
getDisks
(Consumer<GetDisksRequest.Builder> getDisksRequest) Returns information about all block storage disks in your AWS account and region.default GetDisksResponse
getDisks
(GetDisksRequest getDisksRequest) Returns information about all block storage disks in your AWS account and region.default GetDiskSnapshotResponse
getDiskSnapshot
(Consumer<GetDiskSnapshotRequest.Builder> getDiskSnapshotRequest) Returns information about a specific block storage disk snapshot.default GetDiskSnapshotResponse
getDiskSnapshot
(GetDiskSnapshotRequest getDiskSnapshotRequest) Returns information about a specific block storage disk snapshot.default GetDiskSnapshotsResponse
Returns information about all block storage disk snapshots in your AWS account and region.default GetDiskSnapshotsResponse
getDiskSnapshots
(Consumer<GetDiskSnapshotsRequest.Builder> getDiskSnapshotsRequest) Returns information about all block storage disk snapshots in your AWS account and region.default GetDiskSnapshotsResponse
getDiskSnapshots
(GetDiskSnapshotsRequest getDiskSnapshotsRequest) Returns information about all block storage disk snapshots in your AWS account and region.default GetDistributionBundlesResponse
getDistributionBundles
(Consumer<GetDistributionBundlesRequest.Builder> getDistributionBundlesRequest) Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.default GetDistributionBundlesResponse
getDistributionBundles
(GetDistributionBundlesRequest getDistributionBundlesRequest) Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.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.getDistributionLatestCacheReset
(GetDistributionLatestCacheResetRequest getDistributionLatestCacheResetRequest) Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.getDistributionMetricData
(Consumer<GetDistributionMetricDataRequest.Builder> getDistributionMetricDataRequest) Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.getDistributionMetricData
(GetDistributionMetricDataRequest getDistributionMetricDataRequest) Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.default GetDistributionsResponse
getDistributions
(Consumer<GetDistributionsRequest.Builder> getDistributionsRequest) Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.default GetDistributionsResponse
getDistributions
(GetDistributionsRequest getDistributionsRequest) Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.default GetDomainResponse
getDomain
(Consumer<GetDomainRequest.Builder> getDomainRequest) Returns information about a specific domain recordset.default GetDomainResponse
getDomain
(GetDomainRequest getDomainRequest) Returns information about a specific domain recordset.default GetDomainsResponse
Returns a list of all domains in the user's account.default GetDomainsResponse
getDomains
(Consumer<GetDomainsRequest.Builder> getDomainsRequest) Returns a list of all domains in the user's account.default GetDomainsResponse
getDomains
(GetDomainsRequest getDomainsRequest) Returns a list of all domains in the user's account.default GetExportSnapshotRecordsResponse
Returns all export snapshot records created as a result of theexport snapshot
operation.default GetExportSnapshotRecordsResponse
getExportSnapshotRecords
(Consumer<GetExportSnapshotRecordsRequest.Builder> getExportSnapshotRecordsRequest) Returns all export snapshot records created as a result of theexport snapshot
operation.default GetExportSnapshotRecordsResponse
getExportSnapshotRecords
(GetExportSnapshotRecordsRequest getExportSnapshotRecordsRequest) Returns all export snapshot records created as a result of theexport snapshot
operation.default GetInstanceResponse
getInstance
(Consumer<GetInstanceRequest.Builder> getInstanceRequest) Returns information about a specific Amazon Lightsail instance, which is a virtual private server.default GetInstanceResponse
getInstance
(GetInstanceRequest getInstanceRequest) Returns information about a specific Amazon Lightsail instance, which is a virtual private server.default GetInstanceAccessDetailsResponse
getInstanceAccessDetails
(Consumer<GetInstanceAccessDetailsRequest.Builder> getInstanceAccessDetailsRequest) Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.default GetInstanceAccessDetailsResponse
getInstanceAccessDetails
(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest) Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.default GetInstanceMetricDataResponse
getInstanceMetricData
(Consumer<GetInstanceMetricDataRequest.Builder> getInstanceMetricDataRequest) Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.default GetInstanceMetricDataResponse
getInstanceMetricData
(GetInstanceMetricDataRequest getInstanceMetricDataRequest) Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.default 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 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 GetInstancesResponse
Returns information about all Amazon Lightsail virtual private servers, or instances.default GetInstancesResponse
getInstances
(Consumer<GetInstancesRequest.Builder> getInstancesRequest) Returns information about all Amazon Lightsail virtual private servers, or instances.default GetInstancesResponse
getInstances
(GetInstancesRequest getInstancesRequest) Returns information about all Amazon Lightsail virtual private servers, or instances.default GetInstanceSnapshotResponse
getInstanceSnapshot
(Consumer<GetInstanceSnapshotRequest.Builder> getInstanceSnapshotRequest) Returns information about a specific instance snapshot.default GetInstanceSnapshotResponse
getInstanceSnapshot
(GetInstanceSnapshotRequest getInstanceSnapshotRequest) Returns information about a specific instance snapshot.default GetInstanceSnapshotsResponse
Returns all instance snapshots for the user's account.default GetInstanceSnapshotsResponse
getInstanceSnapshots
(Consumer<GetInstanceSnapshotsRequest.Builder> getInstanceSnapshotsRequest) Returns all instance snapshots for the user's account.default GetInstanceSnapshotsResponse
getInstanceSnapshots
(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest) Returns all instance snapshots for the user's account.default GetInstanceStateResponse
getInstanceState
(Consumer<GetInstanceStateRequest.Builder> getInstanceStateRequest) Returns the state of a specific instance.default GetInstanceStateResponse
getInstanceState
(GetInstanceStateRequest getInstanceStateRequest) Returns the state of a specific instance.default GetKeyPairResponse
getKeyPair
(Consumer<GetKeyPairRequest.Builder> getKeyPairRequest) Returns information about a specific key pair.default GetKeyPairResponse
getKeyPair
(GetKeyPairRequest getKeyPairRequest) Returns information about a specific key pair.default GetKeyPairsResponse
Returns information about all key pairs in the user's account.default GetKeyPairsResponse
getKeyPairs
(Consumer<GetKeyPairsRequest.Builder> getKeyPairsRequest) Returns information about all key pairs in the user's account.default GetKeyPairsResponse
getKeyPairs
(GetKeyPairsRequest getKeyPairsRequest) Returns information about all key pairs in the user's account.default GetLoadBalancerResponse
getLoadBalancer
(Consumer<GetLoadBalancerRequest.Builder> getLoadBalancerRequest) Returns information about the specified Lightsail load balancer.default GetLoadBalancerResponse
getLoadBalancer
(GetLoadBalancerRequest getLoadBalancerRequest) Returns information about the specified Lightsail load balancer.getLoadBalancerMetricData
(Consumer<GetLoadBalancerMetricDataRequest.Builder> getLoadBalancerMetricDataRequest) Returns information about health metrics for your Lightsail load balancer.getLoadBalancerMetricData
(GetLoadBalancerMetricDataRequest getLoadBalancerMetricDataRequest) Returns information about health metrics for your Lightsail load balancer.default GetLoadBalancersResponse
Returns information about all load balancers in an account.default GetLoadBalancersResponse
getLoadBalancers
(Consumer<GetLoadBalancersRequest.Builder> getLoadBalancersRequest) Returns information about all load balancers in an account.default GetLoadBalancersResponse
getLoadBalancers
(GetLoadBalancersRequest getLoadBalancersRequest) Returns information about all load balancers in an account.getLoadBalancerTlsCertificates
(Consumer<GetLoadBalancerTlsCertificatesRequest.Builder> getLoadBalancerTlsCertificatesRequest) Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.getLoadBalancerTlsCertificates
(GetLoadBalancerTlsCertificatesRequest getLoadBalancerTlsCertificatesRequest) Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.getLoadBalancerTlsPolicies
(Consumer<GetLoadBalancerTlsPoliciesRequest.Builder> getLoadBalancerTlsPoliciesRequest) Returns a list of TLS security policies that you can apply to Lightsail load balancers.getLoadBalancerTlsPolicies
(GetLoadBalancerTlsPoliciesRequest getLoadBalancerTlsPoliciesRequest) Returns a list of TLS security policies that you can apply to Lightsail load balancers.default GetOperationResponse
getOperation
(Consumer<GetOperationRequest.Builder> getOperationRequest) Returns information about a specific operation.default GetOperationResponse
getOperation
(GetOperationRequest getOperationRequest) Returns information about a specific operation.default GetOperationsResponse
Returns information about all operations.default GetOperationsResponse
getOperations
(Consumer<GetOperationsRequest.Builder> getOperationsRequest) Returns information about all operations.default GetOperationsResponse
getOperations
(GetOperationsRequest getOperationsRequest) Returns information about all operations.default GetOperationsForResourceResponse
getOperationsForResource
(Consumer<GetOperationsForResourceRequest.Builder> getOperationsForResourceRequest) Gets operations for a specific resource (an instance or a static IP).default GetOperationsForResourceResponse
getOperationsForResource
(GetOperationsForResourceRequest getOperationsForResourceRequest) Gets operations for a specific resource (an instance or a static IP).default GetRegionsResponse
Returns a list of all valid regions for Amazon Lightsail.default GetRegionsResponse
getRegions
(Consumer<GetRegionsRequest.Builder> getRegionsRequest) Returns a list of all valid regions for Amazon Lightsail.default GetRegionsResponse
getRegions
(GetRegionsRequest getRegionsRequest) Returns a list of all valid regions for Amazon Lightsail.default GetRelationalDatabaseResponse
getRelationalDatabase
(Consumer<GetRelationalDatabaseRequest.Builder> getRelationalDatabaseRequest) Returns information about a specific database in Amazon Lightsail.default GetRelationalDatabaseResponse
getRelationalDatabase
(GetRelationalDatabaseRequest getRelationalDatabaseRequest) Returns information about a specific database in Amazon Lightsail.Returns a list of available database blueprints in Amazon Lightsail.getRelationalDatabaseBlueprints
(Consumer<GetRelationalDatabaseBlueprintsRequest.Builder> getRelationalDatabaseBlueprintsRequest) Returns a list of available database blueprints in Amazon Lightsail.getRelationalDatabaseBlueprints
(GetRelationalDatabaseBlueprintsRequest getRelationalDatabaseBlueprintsRequest) Returns a list of available database blueprints in Amazon Lightsail.Returns the list of bundles that are available in Amazon Lightsail.getRelationalDatabaseBundles
(Consumer<GetRelationalDatabaseBundlesRequest.Builder> getRelationalDatabaseBundlesRequest) Returns the list of bundles that are available in Amazon Lightsail.getRelationalDatabaseBundles
(GetRelationalDatabaseBundlesRequest getRelationalDatabaseBundlesRequest) Returns the list of bundles that are available in Amazon Lightsail.getRelationalDatabaseEvents
(Consumer<GetRelationalDatabaseEventsRequest.Builder> getRelationalDatabaseEventsRequest) Returns a list of events for a specific database in Amazon Lightsail.getRelationalDatabaseEvents
(GetRelationalDatabaseEventsRequest getRelationalDatabaseEventsRequest) Returns a list of events for a specific database in Amazon Lightsail.getRelationalDatabaseLogEvents
(Consumer<GetRelationalDatabaseLogEventsRequest.Builder> getRelationalDatabaseLogEventsRequest) Returns a list of log events for a database in Amazon Lightsail.getRelationalDatabaseLogEvents
(GetRelationalDatabaseLogEventsRequest getRelationalDatabaseLogEventsRequest) Returns a list of log events for a database in Amazon Lightsail.getRelationalDatabaseLogStreams
(Consumer<GetRelationalDatabaseLogStreamsRequest.Builder> getRelationalDatabaseLogStreamsRequest) Returns a list of available log streams for a specific database in Amazon Lightsail.getRelationalDatabaseLogStreams
(GetRelationalDatabaseLogStreamsRequest getRelationalDatabaseLogStreamsRequest) Returns a list of available log streams for a specific database in Amazon Lightsail.getRelationalDatabaseMasterUserPassword
(Consumer<GetRelationalDatabaseMasterUserPasswordRequest.Builder> getRelationalDatabaseMasterUserPasswordRequest) Returns the current, previous, or pending versions of the master user password for a Lightsail database.getRelationalDatabaseMasterUserPassword
(GetRelationalDatabaseMasterUserPasswordRequest getRelationalDatabaseMasterUserPasswordRequest) Returns the current, previous, or pending versions of the master user password for a Lightsail database.getRelationalDatabaseMetricData
(Consumer<GetRelationalDatabaseMetricDataRequest.Builder> getRelationalDatabaseMetricDataRequest) Returns the data points of the specified metric for a database in Amazon Lightsail.getRelationalDatabaseMetricData
(GetRelationalDatabaseMetricDataRequest getRelationalDatabaseMetricDataRequest) Returns the data points of the specified metric for a database in Amazon Lightsail.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.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 GetRelationalDatabasesResponse
Returns information about all of your databases in Amazon Lightsail.default GetRelationalDatabasesResponse
getRelationalDatabases
(Consumer<GetRelationalDatabasesRequest.Builder> getRelationalDatabasesRequest) Returns information about all of your databases in Amazon Lightsail.default GetRelationalDatabasesResponse
getRelationalDatabases
(GetRelationalDatabasesRequest getRelationalDatabasesRequest) Returns information about all of your databases in Amazon Lightsail.getRelationalDatabaseSnapshot
(Consumer<GetRelationalDatabaseSnapshotRequest.Builder> getRelationalDatabaseSnapshotRequest) Returns information about a specific database snapshot in Amazon Lightsail.getRelationalDatabaseSnapshot
(GetRelationalDatabaseSnapshotRequest getRelationalDatabaseSnapshotRequest) Returns information about a specific database snapshot in Amazon Lightsail.Returns information about all of your database snapshots in Amazon Lightsail.getRelationalDatabaseSnapshots
(Consumer<GetRelationalDatabaseSnapshotsRequest.Builder> getRelationalDatabaseSnapshotsRequest) Returns information about all of your database snapshots in Amazon Lightsail.getRelationalDatabaseSnapshots
(GetRelationalDatabaseSnapshotsRequest getRelationalDatabaseSnapshotsRequest) Returns information about all of your database snapshots in Amazon Lightsail.default GetSetupHistoryResponse
getSetupHistory
(Consumer<GetSetupHistoryRequest.Builder> getSetupHistoryRequest) Returns detailed information for five of the most recentSetupInstanceHttps
requests that were ran on the target instance.default GetSetupHistoryResponse
getSetupHistory
(GetSetupHistoryRequest getSetupHistoryRequest) Returns detailed information for five of the most recentSetupInstanceHttps
requests that were ran on the target instance.default GetStaticIpResponse
getStaticIp
(Consumer<GetStaticIpRequest.Builder> getStaticIpRequest) Returns information about an Amazon Lightsail static IP.default GetStaticIpResponse
getStaticIp
(GetStaticIpRequest getStaticIpRequest) Returns information about an Amazon Lightsail static IP.default GetStaticIpsResponse
Returns information about all static IPs in the user's account.default GetStaticIpsResponse
getStaticIps
(Consumer<GetStaticIpsRequest.Builder> getStaticIpsRequest) Returns information about all static IPs in the user's account.default GetStaticIpsResponse
getStaticIps
(GetStaticIpsRequest getStaticIpsRequest) Returns information about all static IPs in the user's account.default ImportKeyPairResponse
importKeyPair
(Consumer<ImportKeyPairRequest.Builder> importKeyPairRequest) Imports a public SSH key from a specific key pair.default ImportKeyPairResponse
importKeyPair
(ImportKeyPairRequest importKeyPairRequest) Imports a public SSH key from a specific key pair.default IsVpcPeeredResponse
Returns a Boolean value indicating whether your Lightsail VPC is peered.default IsVpcPeeredResponse
isVpcPeered
(Consumer<IsVpcPeeredRequest.Builder> isVpcPeeredRequest) Returns a Boolean value indicating whether your Lightsail VPC is peered.default IsVpcPeeredResponse
isVpcPeered
(IsVpcPeeredRequest isVpcPeeredRequest) Returns a Boolean value indicating whether your Lightsail VPC is peered.default 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 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 PeerVpcResponse
peerVpc()
Peers the Lightsail VPC with the user's default VPC.default PeerVpcResponse
peerVpc
(Consumer<PeerVpcRequest.Builder> peerVpcRequest) Peers the Lightsail VPC with the user's default VPC.default PeerVpcResponse
peerVpc
(PeerVpcRequest peerVpcRequest) Peers the Lightsail VPC with the user's default VPC.default PutAlarmResponse
putAlarm
(Consumer<PutAlarmRequest.Builder> putAlarmRequest) Creates or updates an alarm, and associates it with the specified metric.default PutAlarmResponse
putAlarm
(PutAlarmRequest putAlarmRequest) Creates or updates an alarm, and associates it with the specified metric.default 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 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 RebootInstanceResponse
rebootInstance
(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest) Restarts a specific instance.default RebootInstanceResponse
rebootInstance
(RebootInstanceRequest rebootInstanceRequest) Restarts a specific instance.default RebootRelationalDatabaseResponse
rebootRelationalDatabase
(Consumer<RebootRelationalDatabaseRequest.Builder> rebootRelationalDatabaseRequest) Restarts a specific database in Amazon Lightsail.default RebootRelationalDatabaseResponse
rebootRelationalDatabase
(RebootRelationalDatabaseRequest rebootRelationalDatabaseRequest) Restarts a specific database in Amazon Lightsail.default RegisterContainerImageResponse
registerContainerImage
(Consumer<RegisterContainerImageRequest.Builder> registerContainerImageRequest) Registers a container image to your Amazon Lightsail container service.default RegisterContainerImageResponse
registerContainerImage
(RegisterContainerImageRequest registerContainerImageRequest) Registers a container image to your Amazon Lightsail container service.default ReleaseStaticIpResponse
releaseStaticIp
(Consumer<ReleaseStaticIpRequest.Builder> releaseStaticIpRequest) Deletes a specific static IP from your account.default ReleaseStaticIpResponse
releaseStaticIp
(ReleaseStaticIpRequest releaseStaticIpRequest) Deletes a specific static IP from your account.default ResetDistributionCacheResponse
resetDistributionCache
(Consumer<ResetDistributionCacheRequest.Builder> resetDistributionCacheRequest) Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.default ResetDistributionCacheResponse
resetDistributionCache
(ResetDistributionCacheRequest resetDistributionCacheRequest) Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.sendContactMethodVerification
(Consumer<SendContactMethodVerificationRequest.Builder> sendContactMethodVerificationRequest) Sends a verification request to an email contact method to ensure it's owned by the requester.sendContactMethodVerification
(SendContactMethodVerificationRequest sendContactMethodVerificationRequest) Sends a verification request to an email contact method to ensure it's owned by the requester.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default SetIpAddressTypeResponse
setIpAddressType
(Consumer<SetIpAddressTypeRequest.Builder> setIpAddressTypeRequest) Sets the IP address type for an Amazon Lightsail resource.default SetIpAddressTypeResponse
setIpAddressType
(SetIpAddressTypeRequest setIpAddressTypeRequest) Sets the IP address type for an Amazon Lightsail resource.setResourceAccessForBucket
(Consumer<SetResourceAccessForBucketRequest.Builder> setResourceAccessForBucketRequest) Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.setResourceAccessForBucket
(SetResourceAccessForBucketRequest setResourceAccessForBucketRequest) Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.default SetupInstanceHttpsResponse
setupInstanceHttps
(Consumer<SetupInstanceHttpsRequest.Builder> setupInstanceHttpsRequest) Creates an SSL/TLS certificate that secures traffic for your website.default SetupInstanceHttpsResponse
setupInstanceHttps
(SetupInstanceHttpsRequest setupInstanceHttpsRequest) Creates an SSL/TLS certificate that secures traffic for your website.default StartGuiSessionResponse
startGUISession
(Consumer<StartGuiSessionRequest.Builder> startGuiSessionRequest) Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application.default StartGuiSessionResponse
startGUISession
(StartGuiSessionRequest startGuiSessionRequest) Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application.default StartInstanceResponse
startInstance
(Consumer<StartInstanceRequest.Builder> startInstanceRequest) Starts a specific Amazon Lightsail instance from a stopped state.default StartInstanceResponse
startInstance
(StartInstanceRequest startInstanceRequest) Starts a specific Amazon Lightsail instance from a stopped state.default StartRelationalDatabaseResponse
startRelationalDatabase
(Consumer<StartRelationalDatabaseRequest.Builder> startRelationalDatabaseRequest) Starts a specific database from a stopped state in Amazon Lightsail.default StartRelationalDatabaseResponse
startRelationalDatabase
(StartRelationalDatabaseRequest startRelationalDatabaseRequest) Starts a specific database from a stopped state in Amazon Lightsail.default StopGuiSessionResponse
stopGUISession
(Consumer<StopGuiSessionRequest.Builder> stopGuiSessionRequest) Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application.default StopGuiSessionResponse
stopGUISession
(StopGuiSessionRequest stopGuiSessionRequest) Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application.default StopInstanceResponse
stopInstance
(Consumer<StopInstanceRequest.Builder> stopInstanceRequest) Stops a specific Amazon Lightsail instance that is currently running.default StopInstanceResponse
stopInstance
(StopInstanceRequest stopInstanceRequest) Stops a specific Amazon Lightsail instance that is currently running.default StopRelationalDatabaseResponse
stopRelationalDatabase
(Consumer<StopRelationalDatabaseRequest.Builder> stopRelationalDatabaseRequest) Stops a specific database that is currently running in Amazon Lightsail.default StopRelationalDatabaseResponse
stopRelationalDatabase
(StopRelationalDatabaseRequest stopRelationalDatabaseRequest) Stops a specific database that is currently running in Amazon Lightsail.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to the specified Amazon Lightsail resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds one or more tags to the specified Amazon Lightsail resource.default TestAlarmResponse
testAlarm
(Consumer<TestAlarmRequest.Builder> testAlarmRequest) Tests an alarm by displaying a banner on the Amazon Lightsail console.default TestAlarmResponse
testAlarm
(TestAlarmRequest testAlarmRequest) Tests an alarm by displaying a banner on the Amazon Lightsail console.default UnpeerVpcResponse
Unpeers the Lightsail VPC from the user's default VPC.default UnpeerVpcResponse
unpeerVpc
(Consumer<UnpeerVpcRequest.Builder> unpeerVpcRequest) Unpeers the Lightsail VPC from the user's default VPC.default UnpeerVpcResponse
unpeerVpc
(UnpeerVpcRequest unpeerVpcRequest) Unpeers the Lightsail VPC from the user's default VPC.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.default UpdateBucketResponse
updateBucket
(Consumer<UpdateBucketRequest.Builder> updateBucketRequest) Updates an existing Amazon Lightsail bucket.default UpdateBucketResponse
updateBucket
(UpdateBucketRequest updateBucketRequest) Updates an existing Amazon Lightsail bucket.default UpdateBucketBundleResponse
updateBucketBundle
(Consumer<UpdateBucketBundleRequest.Builder> updateBucketBundleRequest) Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.default UpdateBucketBundleResponse
updateBucketBundle
(UpdateBucketBundleRequest updateBucketBundleRequest) Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.default 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 UpdateContainerServiceResponse
updateContainerService
(UpdateContainerServiceRequest updateContainerServiceRequest) Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.default UpdateDistributionResponse
updateDistribution
(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest) Updates an existing Amazon Lightsail content delivery network (CDN) distribution.default UpdateDistributionResponse
updateDistribution
(UpdateDistributionRequest updateDistributionRequest) Updates an existing Amazon Lightsail content delivery network (CDN) distribution.default UpdateDistributionBundleResponse
updateDistributionBundle
(Consumer<UpdateDistributionBundleRequest.Builder> updateDistributionBundleRequest) Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.default UpdateDistributionBundleResponse
updateDistributionBundle
(UpdateDistributionBundleRequest updateDistributionBundleRequest) Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.default UpdateDomainEntryResponse
updateDomainEntry
(Consumer<UpdateDomainEntryRequest.Builder> updateDomainEntryRequest) Updates a domain recordset after it is created.default UpdateDomainEntryResponse
updateDomainEntry
(UpdateDomainEntryRequest updateDomainEntryRequest) Updates a domain recordset after it is created.updateInstanceMetadataOptions
(Consumer<UpdateInstanceMetadataOptionsRequest.Builder> updateInstanceMetadataOptionsRequest) Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance.updateInstanceMetadataOptions
(UpdateInstanceMetadataOptionsRequest updateInstanceMetadataOptionsRequest) Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance.updateLoadBalancerAttribute
(Consumer<UpdateLoadBalancerAttributeRequest.Builder> updateLoadBalancerAttributeRequest) Updates the specified attribute for a load balancer.updateLoadBalancerAttribute
(UpdateLoadBalancerAttributeRequest updateLoadBalancerAttributeRequest) Updates the specified attribute for a load balancer.default UpdateRelationalDatabaseResponse
updateRelationalDatabase
(Consumer<UpdateRelationalDatabaseRequest.Builder> updateRelationalDatabaseRequest) Allows the update of one or more attributes of a database in Amazon Lightsail.default UpdateRelationalDatabaseResponse
updateRelationalDatabase
(UpdateRelationalDatabaseRequest updateRelationalDatabaseRequest) Allows the update of one or more attributes of a database in Amazon Lightsail.updateRelationalDatabaseParameters
(Consumer<UpdateRelationalDatabaseParametersRequest.Builder> updateRelationalDatabaseParametersRequest) Allows the update of one or more parameters of a database in Amazon Lightsail.updateRelationalDatabaseParameters
(UpdateRelationalDatabaseParametersRequest updateRelationalDatabaseParametersRequest) Allows the update of one or more parameters of a database in Amazon Lightsail.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
allocateStaticIp
default AllocateStaticIpResponse allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Allocates a static IP address.
- Parameters:
allocateStaticIpRequest
-- Returns:
- Result of the AllocateStaticIp operation returned by the service.
- See Also:
-
allocateStaticIp
default AllocateStaticIpResponse allocateStaticIp(Consumer<AllocateStaticIpRequest.Builder> allocateStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Allocates a static IP address.
This is a convenience which creates an instance of the
AllocateStaticIpRequest.Builder
avoiding the need to create one manually viaAllocateStaticIpRequest.builder()
- Parameters:
allocateStaticIpRequest
- AConsumer
that will call methods onAllocateStaticIpRequest.Builder
to create a request.- Returns:
- Result of the AllocateStaticIp operation returned by the service.
- See Also:
-
attachCertificateToDistribution
default AttachCertificateToDistributionResponse attachCertificateToDistribution(AttachCertificateToDistributionRequest attachCertificateToDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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
Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in theus-east-1
Region.- Parameters:
attachCertificateToDistributionRequest
-- Returns:
- Result of the AttachCertificateToDistribution operation returned by the service.
- See Also:
-
attachCertificateToDistribution
default AttachCertificateToDistributionResponse attachCertificateToDistribution(Consumer<AttachCertificateToDistributionRequest.Builder> attachCertificateToDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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
Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in theus-east-1
Region.
This is a convenience which creates an instance of the
AttachCertificateToDistributionRequest.Builder
avoiding the need to create one manually viaAttachCertificateToDistributionRequest.builder()
- Parameters:
attachCertificateToDistributionRequest
- AConsumer
that will call methods onAttachCertificateToDistributionRequest.Builder
to create a request.- Returns:
- Result of the AttachCertificateToDistribution operation returned by the service.
- See Also:
-
attachDisk
default AttachDiskResponse attachDisk(AttachDiskRequest attachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydisk name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
attachDiskRequest
-- Returns:
- Result of the AttachDisk operation returned by the service.
- See Also:
-
attachDisk
default AttachDiskResponse attachDisk(Consumer<AttachDiskRequest.Builder> attachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydisk name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
AttachDiskRequest.Builder
avoiding the need to create one manually viaAttachDiskRequest.builder()
- Parameters:
attachDiskRequest
- AConsumer
that will call methods onAttachDiskRequest.Builder
to create a request.- Returns:
- Result of the AttachDisk operation returned by the service.
- See Also:
-
attachInstancesToLoadBalancer
default AttachInstancesToLoadBalancerResponse attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest attachInstancesToLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Lightsail Developer Guide.- Parameters:
attachInstancesToLoadBalancerRequest
-- Returns:
- Result of the AttachInstancesToLoadBalancer operation returned by the service.
- See Also:
-
attachInstancesToLoadBalancer
default AttachInstancesToLoadBalancerResponse attachInstancesToLoadBalancer(Consumer<AttachInstancesToLoadBalancerRequest.Builder> attachInstancesToLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Lightsail Developer Guide.
This is a convenience which creates an instance of the
AttachInstancesToLoadBalancerRequest.Builder
avoiding the need to create one manually viaAttachInstancesToLoadBalancerRequest.builder()
- Parameters:
attachInstancesToLoadBalancerRequest
- AConsumer
that will call methods onAttachInstancesToLoadBalancerRequest.Builder
to create a request.- Returns:
- Result of the AttachInstancesToLoadBalancer operation returned by the service.
- See Also:
-
attachLoadBalancerTlsCertificate
default AttachLoadBalancerTlsCertificateResponse attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest attachLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
attachLoadBalancerTlsCertificateRequest
-- Returns:
- Result of the AttachLoadBalancerTlsCertificate operation returned by the service.
- See Also:
-
attachLoadBalancerTlsCertificate
default AttachLoadBalancerTlsCertificateResponse attachLoadBalancerTlsCertificate(Consumer<AttachLoadBalancerTlsCertificateRequest.Builder> attachLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
AttachLoadBalancerTlsCertificateRequest.Builder
avoiding the need to create one manually viaAttachLoadBalancerTlsCertificateRequest.builder()
- Parameters:
attachLoadBalancerTlsCertificateRequest
- AConsumer
that will call methods onAttachLoadBalancerTlsCertificateRequest.Builder
to create a request.- Returns:
- Result of the AttachLoadBalancerTlsCertificate operation returned by the service.
- See Also:
-
attachStaticIp
default AttachStaticIpResponse attachStaticIp(AttachStaticIpRequest attachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Attaches a static IP address to a specific Amazon Lightsail instance.
- Parameters:
attachStaticIpRequest
-- Returns:
- Result of the AttachStaticIp operation returned by the service.
- See Also:
-
attachStaticIp
default AttachStaticIpResponse attachStaticIp(Consumer<AttachStaticIpRequest.Builder> attachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaAttachStaticIpRequest.builder()
- Parameters:
attachStaticIpRequest
- AConsumer
that will call methods onAttachStaticIpRequest.Builder
to create a request.- Returns:
- Result of the AttachStaticIp operation returned by the service.
- See Also:
-
closeInstancePublicPorts
default CloseInstancePublicPortsResponse closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Closes ports for a specific Amazon Lightsail instance.
The
CloseInstancePublicPorts
action supports tag-based access control via resource tags applied to the resource identified byinstanceName
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
closeInstancePublicPortsRequest
-- Returns:
- Result of the CloseInstancePublicPorts operation returned by the service.
- See Also:
-
closeInstancePublicPorts
default CloseInstancePublicPortsResponse closeInstancePublicPorts(Consumer<CloseInstancePublicPortsRequest.Builder> closeInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Closes ports for a specific Amazon Lightsail instance.
The
CloseInstancePublicPorts
action supports tag-based access control via resource tags applied to the resource identified byinstanceName
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CloseInstancePublicPortsRequest.Builder
avoiding the need to create one manually viaCloseInstancePublicPortsRequest.builder()
- Parameters:
closeInstancePublicPortsRequest
- AConsumer
that will call methods onCloseInstancePublicPortsRequest.Builder
to create a request.- Returns:
- Result of the CloseInstancePublicPorts operation returned by the service.
- See Also:
-
copySnapshot
default CopySnapshotResponse copySnapshot(CopySnapshotRequest copySnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services Region to another in Amazon Lightsail.
When copying a manual snapshot, be sure to define the
source region
,source snapshot name
, andtarget snapshot name
parameters.When copying an automatic snapshot, be sure to define the
source region
,source resource name
,target snapshot name
, and either therestore date
or theuse latest restorable auto snapshot
parameters.- Parameters:
copySnapshotRequest
-- Returns:
- Result of the CopySnapshot operation returned by the service.
- See Also:
-
copySnapshot
default CopySnapshotResponse copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services Region to another in Amazon Lightsail.
When copying a manual snapshot, be sure to define the
source region
,source snapshot name
, andtarget snapshot name
parameters.When copying an automatic snapshot, be sure to define the
source region
,source resource name
,target snapshot name
, and either therestore date
or theuse latest restorable auto snapshot
parameters.
This is a convenience which creates an instance of the
CopySnapshotRequest.Builder
avoiding the need to create one manually viaCopySnapshotRequest.builder()
- Parameters:
copySnapshotRequest
- AConsumer
that will call methods onCopySnapshotRequest.Builder
to create a request.- Returns:
- Result of the CopySnapshot operation returned by the service.
- See Also:
-
createBucket
default CreateBucketResponse createBucket(CreateBucketRequest createBucketRequest) throws AccessDeniedException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates an Amazon Lightsail bucket.
A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
- Parameters:
createBucketRequest
-- Returns:
- Result of the CreateBucket operation returned by the service.
- See Also:
-
createBucket
default CreateBucketResponse createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest) throws AccessDeniedException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates an Amazon Lightsail bucket.
A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateBucketRequest.Builder
avoiding the need to create one manually viaCreateBucketRequest.builder()
- Parameters:
createBucketRequest
- AConsumer
that will call methods onCreateBucketRequest.Builder
to create a request.- Returns:
- Result of the CreateBucket operation returned by the service.
- See Also:
-
createBucketAccessKey
default CreateBucketAccessKeyResponse createBucketAccessKey(CreateBucketAccessKeyRequest createBucketAccessKeyRequest) throws AccessDeniedException, NotFoundException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
The
secretAccessKey
value is returned only in response to theCreateBucketAccessKey
action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.- Parameters:
createBucketAccessKeyRequest
-- Returns:
- Result of the CreateBucketAccessKey operation returned by the service.
- See Also:
-
createBucketAccessKey
default CreateBucketAccessKeyResponse createBucketAccessKey(Consumer<CreateBucketAccessKeyRequest.Builder> createBucketAccessKeyRequest) throws AccessDeniedException, NotFoundException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
The
secretAccessKey
value is returned only in response to theCreateBucketAccessKey
action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.
This is a convenience which creates an instance of the
CreateBucketAccessKeyRequest.Builder
avoiding the need to create one manually viaCreateBucketAccessKeyRequest.builder()
- Parameters:
createBucketAccessKeyRequest
- AConsumer
that will call methods onCreateBucketAccessKeyRequest.Builder
to create a request.- Returns:
- Result of the CreateBucketAccessKey operation returned by the service.
- See Also:
-
createCertificate
default CreateCertificateResponse createCertificate(CreateCertificateRequest createCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 theUpdateContainerService
action to use the certificate and its domains with your container service.Only certificates created in the
us-east-1
Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in theus-east-1
Region.- Parameters:
createCertificateRequest
-- Returns:
- Result of the CreateCertificate operation returned by the service.
- See Also:
-
createCertificate
default CreateCertificateResponse createCertificate(Consumer<CreateCertificateRequest.Builder> createCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 theUpdateContainerService
action to use the certificate and its domains with your container service.Only certificates created in the
us-east-1
Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in theus-east-1
Region.
This is a convenience which creates an instance of the
CreateCertificateRequest.Builder
avoiding the need to create one manually viaCreateCertificateRequest.builder()
- Parameters:
createCertificateRequest
- AConsumer
that will call methods onCreateCertificateRequest.Builder
to create a request.- Returns:
- Result of the CreateCertificate operation returned by the service.
- See Also:
-
createCloudFormationStack
default CreateCloudFormationStackResponse createCloudFormationStack(CreateCloudFormationStackRequest createCloudFormationStackRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.- Parameters:
createCloudFormationStackRequest
-- Returns:
- Result of the CreateCloudFormationStack operation returned by the service.
- See Also:
-
createCloudFormationStack
default CreateCloudFormationStackResponse createCloudFormationStack(Consumer<CreateCloudFormationStackRequest.Builder> createCloudFormationStackRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaCreateCloudFormationStackRequest.builder()
- Parameters:
createCloudFormationStackRequest
- AConsumer
that will call methods onCreateCloudFormationStackRequest.Builder
to create a request.- Returns:
- Result of the CreateCloudFormationStack operation returned by the service.
- See Also:
-
createContactMethod
default CreateContactMethodResponse createContactMethod(CreateContactMethodRequest createContactMethodRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
- Parameters:
createContactMethodRequest
-- Returns:
- Result of the CreateContactMethod operation returned by the service.
- See Also:
-
createContactMethod
default CreateContactMethodResponse createContactMethod(Consumer<CreateContactMethodRequest.Builder> createContactMethodRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services 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 viaCreateContactMethodRequest.builder()
- Parameters:
createContactMethodRequest
- AConsumer
that will call methods onCreateContactMethodRequest.Builder
to create a request.- Returns:
- Result of the CreateContactMethod operation returned by the service.
- See Also:
-
createContainerService
default CreateContainerServiceResponse createContainerService(CreateContainerServiceRequest createContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
createContainerServiceRequest
-- Returns:
- Result of the CreateContainerService operation returned by the service.
- See Also:
-
createContainerService
default CreateContainerServiceResponse createContainerService(Consumer<CreateContainerServiceRequest.Builder> createContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaCreateContainerServiceRequest.builder()
- Parameters:
createContainerServiceRequest
- AConsumer
that will call methods onCreateContainerServiceRequest.Builder
to create a request.- Returns:
- Result of the CreateContainerService operation returned by the service.
- See Also:
-
createContainerServiceDeployment
default CreateContainerServiceDeploymentResponse createContainerServiceDeployment(CreateContainerServiceDeploymentRequest createContainerServiceDeploymentRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
- Parameters:
createContainerServiceDeploymentRequest
-- Returns:
- Result of the CreateContainerServiceDeployment operation returned by the service.
- See Also:
-
createContainerServiceDeployment
default CreateContainerServiceDeploymentResponse createContainerServiceDeployment(Consumer<CreateContainerServiceDeploymentRequest.Builder> createContainerServiceDeploymentRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateContainerServiceDeploymentRequest.Builder
avoiding the need to create one manually viaCreateContainerServiceDeploymentRequest.builder()
- Parameters:
createContainerServiceDeploymentRequest
- AConsumer
that will call methods onCreateContainerServiceDeploymentRequest.Builder
to create a request.- Returns:
- Result of the CreateContainerServiceDeployment operation returned by the service.
- See Also:
-
createContainerServiceRegistryLogin
default CreateContainerServiceRegistryLoginResponse createContainerServiceRegistryLogin(CreateContainerServiceRegistryLoginRequest createContainerServiceRegistryLoginRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.
- Parameters:
createContainerServiceRegistryLoginRequest
-- Returns:
- Result of the CreateContainerServiceRegistryLogin operation returned by the service.
- See Also:
-
createContainerServiceRegistryLogin
default CreateContainerServiceRegistryLoginResponse createContainerServiceRegistryLogin(Consumer<CreateContainerServiceRegistryLoginRequest.Builder> createContainerServiceRegistryLoginRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateContainerServiceRegistryLoginRequest.Builder
avoiding the need to create one manually viaCreateContainerServiceRegistryLoginRequest.builder()
- Parameters:
createContainerServiceRegistryLoginRequest
- AConsumer
that will call methods onCreateContainerServiceRegistryLoginRequest.Builder
to create a request.- Returns:
- Result of the CreateContainerServiceRegistryLogin operation returned by the service.
- See Also:
-
createDisk
default CreateDiskResponse createDisk(CreateDiskRequest createDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (
us-east-2a
).The
create disk
operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
createDiskRequest
-- Returns:
- Result of the CreateDisk operation returned by the service.
- See Also:
-
createDisk
default CreateDiskResponse createDisk(Consumer<CreateDiskRequest.Builder> createDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (
us-east-2a
).The
create disk
operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateDiskRequest.Builder
avoiding the need to create one manually viaCreateDiskRequest.builder()
- Parameters:
createDiskRequest
- AConsumer
that will call methods onCreateDiskRequest.Builder
to create a request.- Returns:
- Result of the CreateDisk operation returned by the service.
- See Also:
-
createDiskFromSnapshot
default CreateDiskFromSnapshotResponse createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 (
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 bydisk snapshot name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
createDiskFromSnapshotRequest
-- Returns:
- Result of the CreateDiskFromSnapshot operation returned by the service.
- See Also:
-
createDiskFromSnapshot
default CreateDiskFromSnapshotResponse createDiskFromSnapshot(Consumer<CreateDiskFromSnapshotRequest.Builder> createDiskFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 (
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 bydisk snapshot name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateDiskFromSnapshotRequest.Builder
avoiding the need to create one manually viaCreateDiskFromSnapshotRequest.builder()
- Parameters:
createDiskFromSnapshotRequest
- AConsumer
that will call methods onCreateDiskFromSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CreateDiskFromSnapshot operation returned by the service.
- See Also:
-
createDiskSnapshot
default CreateDiskSnapshotResponse createDiskSnapshot(CreateDiskSnapshotRequest createDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.- Parameters:
createDiskSnapshotRequest
-- Returns:
- Result of the CreateDiskSnapshot operation returned by the service.
- See Also:
-
createDiskSnapshot
default CreateDiskSnapshotResponse createDiskSnapshot(Consumer<CreateDiskSnapshotRequest.Builder> createDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateDiskSnapshotRequest.Builder
avoiding the need to create one manually viaCreateDiskSnapshotRequest.builder()
- Parameters:
createDiskSnapshotRequest
- AConsumer
that will call methods onCreateDiskSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CreateDiskSnapshot operation returned by the service.
- See Also:
-
createDistribution
default CreateDistributionResponse createDistribution(CreateDistributionRequest createDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
createDistributionRequest
-- Returns:
- Result of the CreateDistribution operation returned by the service.
- See Also:
-
createDistribution
default CreateDistributionResponse createDistribution(Consumer<CreateDistributionRequest.Builder> createDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaCreateDistributionRequest.builder()
- Parameters:
createDistributionRequest
- AConsumer
that will call methods onCreateDistributionRequest.Builder
to create a request.- Returns:
- Result of the CreateDistribution operation returned by the service.
- See Also:
-
createDomain
default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates a domain resource for the specified domain (example.com).
The
create domain
operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
createDomainRequest
-- Returns:
- Result of the CreateDomain operation returned by the service.
- See Also:
-
createDomain
default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates a domain resource for the specified domain (example.com).
The
create domain
operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateDomainRequest.Builder
avoiding the need to create one manually viaCreateDomainRequest.builder()
- Parameters:
createDomainRequest
- AConsumer
that will call methods onCreateDomainRequest.Builder
to create a request.- Returns:
- Result of the CreateDomain operation returned by the service.
- See Also:
-
createDomainEntry
default CreateDomainEntryResponse createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydomain name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
createDomainEntryRequest
-- Returns:
- Result of the CreateDomainEntry operation returned by the service.
- See Also:
-
createDomainEntry
default CreateDomainEntryResponse createDomainEntry(Consumer<CreateDomainEntryRequest.Builder> createDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydomain name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateDomainEntryRequest.Builder
avoiding the need to create one manually viaCreateDomainEntryRequest.builder()
- Parameters:
createDomainEntryRequest
- AConsumer
that will call methods onCreateDomainEntryRequest.Builder
to create a request.- Returns:
- Result of the CreateDomainEntry operation returned by the service.
- See Also:
-
createGUISessionAccessDetails
default CreateGuiSessionAccessDetailsResponse createGUISessionAccessDetails(CreateGuiSessionAccessDetailsRequest createGuiSessionAccessDetailsRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.
Use
StartGUISession
to open the session.- Parameters:
createGuiSessionAccessDetailsRequest
-- Returns:
- Result of the CreateGUISessionAccessDetails operation returned by the service.
- See Also:
-
createGUISessionAccessDetails
default CreateGuiSessionAccessDetailsResponse createGUISessionAccessDetails(Consumer<CreateGuiSessionAccessDetailsRequest.Builder> createGuiSessionAccessDetailsRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.
Use
StartGUISession
to open the session.
This is a convenience which creates an instance of the
CreateGuiSessionAccessDetailsRequest.Builder
avoiding the need to create one manually viaCreateGuiSessionAccessDetailsRequest.builder()
- Parameters:
createGuiSessionAccessDetailsRequest
- AConsumer
that will call methods onCreateGuiSessionAccessDetailsRequest.Builder
to create a request.- Returns:
- Result of the CreateGUISessionAccessDetails operation returned by the service.
- See Also:
-
createInstanceSnapshot
default CreateInstanceSnapshotResponse createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.- Parameters:
createInstanceSnapshotRequest
-- Returns:
- Result of the CreateInstanceSnapshot operation returned by the service.
- See Also:
-
createInstanceSnapshot
default CreateInstanceSnapshotResponse createInstanceSnapshot(Consumer<CreateInstanceSnapshotRequest.Builder> createInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateInstanceSnapshotRequest.Builder
avoiding the need to create one manually viaCreateInstanceSnapshotRequest.builder()
- Parameters:
createInstanceSnapshotRequest
- AConsumer
that will call methods onCreateInstanceSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CreateInstanceSnapshot operation returned by the service.
- See Also:
-
createInstances
default CreateInstancesResponse createInstances(CreateInstancesRequest createInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Developer Guide.- Parameters:
createInstancesRequest
-- Returns:
- Result of the CreateInstances operation returned by the service.
- See Also:
-
createInstances
default CreateInstancesResponse createInstances(Consumer<CreateInstancesRequest.Builder> createInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Developer Guide.
This is a convenience which creates an instance of the
CreateInstancesRequest.Builder
avoiding the need to create one manually viaCreateInstancesRequest.builder()
- Parameters:
createInstancesRequest
- AConsumer
that will call methods onCreateInstancesRequest.Builder
to create a request.- Returns:
- Result of the CreateInstances operation returned by the service.
- See Also:
-
createInstancesFromSnapshot
default CreateInstancesFromSnapshotResponse createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byinstance snapshot name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
createInstancesFromSnapshotRequest
-- Returns:
- Result of the CreateInstancesFromSnapshot operation returned by the service.
- See Also:
-
createInstancesFromSnapshot
default CreateInstancesFromSnapshotResponse createInstancesFromSnapshot(Consumer<CreateInstancesFromSnapshotRequest.Builder> createInstancesFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byinstance snapshot name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateInstancesFromSnapshotRequest.Builder
avoiding the need to create one manually viaCreateInstancesFromSnapshotRequest.builder()
- Parameters:
createInstancesFromSnapshotRequest
- AConsumer
that will call methods onCreateInstancesFromSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CreateInstancesFromSnapshot operation returned by the service.
- See Also:
-
createKeyPair
default CreateKeyPairResponse createKeyPair(CreateKeyPairRequest createKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.
The
create key pair
operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
createKeyPairRequest
-- Returns:
- Result of the CreateKeyPair operation returned by the service.
- See Also:
-
createKeyPair
default CreateKeyPairResponse createKeyPair(Consumer<CreateKeyPairRequest.Builder> createKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.
The
create key pair
operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateKeyPairRequest.Builder
avoiding the need to create one manually viaCreateKeyPairRequest.builder()
- Parameters:
createKeyPairRequest
- AConsumer
that will call methods onCreateKeyPairRequest.Builder
to create a request.- Returns:
- Result of the CreateKeyPair operation returned by the service.
- See Also:
-
createLoadBalancer
default CreateLoadBalancerResponse createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.- Parameters:
createLoadBalancerRequest
-- Returns:
- Result of the CreateLoadBalancer operation returned by the service.
- See Also:
-
createLoadBalancer
default CreateLoadBalancerResponse createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateLoadBalancerRequest.Builder
avoiding the need to create one manually viaCreateLoadBalancerRequest.builder()
- Parameters:
createLoadBalancerRequest
- AConsumer
that will call methods onCreateLoadBalancerRequest.Builder
to create a request.- Returns:
- Result of the CreateLoadBalancer operation returned by the service.
- See Also:
-
createLoadBalancerTlsCertificate
default CreateLoadBalancerTlsCertificateResponse createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest createLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
createLoadBalancerTlsCertificateRequest
-- Returns:
- Result of the CreateLoadBalancerTlsCertificate operation returned by the service.
- See Also:
-
createLoadBalancerTlsCertificate
default CreateLoadBalancerTlsCertificateResponse createLoadBalancerTlsCertificate(Consumer<CreateLoadBalancerTlsCertificateRequest.Builder> createLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateLoadBalancerTlsCertificateRequest.Builder
avoiding the need to create one manually viaCreateLoadBalancerTlsCertificateRequest.builder()
- Parameters:
createLoadBalancerTlsCertificateRequest
- AConsumer
that will call methods onCreateLoadBalancerTlsCertificateRequest.Builder
to create a request.- Returns:
- Result of the CreateLoadBalancerTlsCertificate operation returned by the service.
- See Also:
-
createRelationalDatabase
default CreateRelationalDatabaseResponse createRelationalDatabase(CreateRelationalDatabaseRequest createRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.- Parameters:
createRelationalDatabaseRequest
-- Returns:
- Result of the CreateRelationalDatabase operation returned by the service.
- See Also:
-
createRelationalDatabase
default CreateRelationalDatabaseResponse createRelationalDatabase(Consumer<CreateRelationalDatabaseRequest.Builder> createRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateRelationalDatabaseRequest.Builder
avoiding the need to create one manually viaCreateRelationalDatabaseRequest.builder()
- Parameters:
createRelationalDatabaseRequest
- AConsumer
that will call methods onCreateRelationalDatabaseRequest.Builder
to create a request.- Returns:
- Result of the CreateRelationalDatabase operation returned by the service.
- See Also:
-
createRelationalDatabaseFromSnapshot
default CreateRelationalDatabaseFromSnapshotResponse createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest createRelationalDatabaseFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.- Parameters:
createRelationalDatabaseFromSnapshotRequest
-- Returns:
- Result of the CreateRelationalDatabaseFromSnapshot operation returned by the service.
- See Also:
-
createRelationalDatabaseFromSnapshot
default CreateRelationalDatabaseFromSnapshotResponse createRelationalDatabaseFromSnapshot(Consumer<CreateRelationalDatabaseFromSnapshotRequest.Builder> createRelationalDatabaseFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateRelationalDatabaseFromSnapshotRequest.Builder
avoiding the need to create one manually viaCreateRelationalDatabaseFromSnapshotRequest.builder()
- Parameters:
createRelationalDatabaseFromSnapshotRequest
- AConsumer
that will call methods onCreateRelationalDatabaseFromSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CreateRelationalDatabaseFromSnapshot operation returned by the service.
- See Also:
-
createRelationalDatabaseSnapshot
default CreateRelationalDatabaseSnapshotResponse createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest createRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.- Parameters:
createRelationalDatabaseSnapshotRequest
-- Returns:
- Result of the CreateRelationalDatabaseSnapshot operation returned by the service.
- See Also:
-
createRelationalDatabaseSnapshot
default CreateRelationalDatabaseSnapshotResponse createRelationalDatabaseSnapshot(Consumer<CreateRelationalDatabaseSnapshotRequest.Builder> createRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateRelationalDatabaseSnapshotRequest.Builder
avoiding the need to create one manually viaCreateRelationalDatabaseSnapshotRequest.builder()
- Parameters:
createRelationalDatabaseSnapshotRequest
- AConsumer
that will call methods onCreateRelationalDatabaseSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CreateRelationalDatabaseSnapshot operation returned by the service.
- See Also:
-
deleteAlarm
default DeleteAlarmResponse deleteAlarm(DeleteAlarmRequest deleteAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
deleteAlarmRequest
-- Returns:
- Result of the DeleteAlarm operation returned by the service.
- See Also:
-
deleteAlarm
default DeleteAlarmResponse deleteAlarm(Consumer<DeleteAlarmRequest.Builder> deleteAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException 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 viaDeleteAlarmRequest.builder()
- Parameters:
deleteAlarmRequest
- AConsumer
that will call methods onDeleteAlarmRequest.Builder
to create a request.- Returns:
- Result of the DeleteAlarm operation returned by the service.
- See Also:
-
deleteAutoSnapshot
default DeleteAutoSnapshotResponse deleteAutoSnapshot(DeleteAutoSnapshotRequest deleteAutoSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
- Parameters:
deleteAutoSnapshotRequest
-- Returns:
- Result of the DeleteAutoSnapshot operation returned by the service.
- See Also:
-
deleteAutoSnapshot
default DeleteAutoSnapshotResponse deleteAutoSnapshot(Consumer<DeleteAutoSnapshotRequest.Builder> deleteAutoSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteAutoSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteAutoSnapshotRequest.builder()
- Parameters:
deleteAutoSnapshotRequest
- AConsumer
that will call methods onDeleteAutoSnapshotRequest.Builder
to create a request.- Returns:
- Result of the DeleteAutoSnapshot operation returned by the service.
- See Also:
-
deleteBucket
default DeleteBucketResponse deleteBucket(DeleteBucketRequest deleteBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes a Amazon Lightsail bucket.
When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account.
- Parameters:
deleteBucketRequest
-- Returns:
- Result of the DeleteBucket operation returned by the service.
- See Also:
-
deleteBucket
default DeleteBucketResponse deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes a Amazon Lightsail bucket.
When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account.
This is a convenience which creates an instance of the
DeleteBucketRequest.Builder
avoiding the need to create one manually viaDeleteBucketRequest.builder()
- Parameters:
deleteBucketRequest
- AConsumer
that will call methods onDeleteBucketRequest.Builder
to create a request.- Returns:
- Result of the DeleteBucket operation returned by the service.
- See Also:
-
deleteBucketAccessKey
default DeleteBucketAccessKeyResponse deleteBucketAccessKey(DeleteBucketAccessKeyRequest deleteBucketAccessKeyRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes an access key for the specified Amazon Lightsail bucket.
We recommend that you delete an access key if the secret access key is compromised.
For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
- Parameters:
deleteBucketAccessKeyRequest
-- Returns:
- Result of the DeleteBucketAccessKey operation returned by the service.
- See Also:
-
deleteBucketAccessKey
default DeleteBucketAccessKeyResponse deleteBucketAccessKey(Consumer<DeleteBucketAccessKeyRequest.Builder> deleteBucketAccessKeyRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes an access key for the specified Amazon Lightsail bucket.
We recommend that you delete an access key if the secret access key is compromised.
For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteBucketAccessKeyRequest.Builder
avoiding the need to create one manually viaDeleteBucketAccessKeyRequest.builder()
- Parameters:
deleteBucketAccessKeyRequest
- AConsumer
that will call methods onDeleteBucketAccessKeyRequest.Builder
to create a request.- Returns:
- Result of the DeleteBucketAccessKey operation returned by the service.
- See Also:
-
deleteCertificate
default DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws ServiceException, InvalidInputException, AccessDeniedException, NotFoundException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.- Parameters:
deleteCertificateRequest
-- Returns:
- Result of the DeleteCertificate operation returned by the service.
- See Also:
-
deleteCertificate
default DeleteCertificateResponse deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) throws ServiceException, InvalidInputException, AccessDeniedException, NotFoundException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaDeleteCertificateRequest.builder()
- Parameters:
deleteCertificateRequest
- AConsumer
that will call methods onDeleteCertificateRequest.Builder
to create a request.- Returns:
- Result of the DeleteCertificate operation returned by the service.
- See Also:
-
deleteContactMethod
default DeleteContactMethodResponse deleteContactMethod(DeleteContactMethodRequest deleteContactMethodRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
- Parameters:
deleteContactMethodRequest
-- Returns:
- Result of the DeleteContactMethod operation returned by the service.
- See Also:
-
deleteContactMethod
default DeleteContactMethodResponse deleteContactMethod(Consumer<DeleteContactMethodRequest.Builder> deleteContactMethodRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services 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 viaDeleteContactMethodRequest.builder()
- Parameters:
deleteContactMethodRequest
- AConsumer
that will call methods onDeleteContactMethodRequest.Builder
to create a request.- Returns:
- Result of the DeleteContactMethod operation returned by the service.
- See Also:
-
deleteContainerImage
default DeleteContainerImageResponse deleteContainerImage(DeleteContainerImageRequest deleteContainerImageRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes a container image that is registered to your Amazon Lightsail container service.
- Parameters:
deleteContainerImageRequest
-- Returns:
- Result of the DeleteContainerImage operation returned by the service.
- See Also:
-
deleteContainerImage
default DeleteContainerImageResponse deleteContainerImage(Consumer<DeleteContainerImageRequest.Builder> deleteContainerImageRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaDeleteContainerImageRequest.builder()
- Parameters:
deleteContainerImageRequest
- AConsumer
that will call methods onDeleteContainerImageRequest.Builder
to create a request.- Returns:
- Result of the DeleteContainerImage operation returned by the service.
- See Also:
-
deleteContainerService
default DeleteContainerServiceResponse deleteContainerService(DeleteContainerServiceRequest deleteContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes your Amazon Lightsail container service.
- Parameters:
deleteContainerServiceRequest
-- Returns:
- Result of the DeleteContainerService operation returned by the service.
- See Also:
-
deleteContainerService
default DeleteContainerServiceResponse deleteContainerService(Consumer<DeleteContainerServiceRequest.Builder> deleteContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaDeleteContainerServiceRequest.builder()
- Parameters:
deleteContainerServiceRequest
- AConsumer
that will call methods onDeleteContainerServiceRequest.Builder
to create a request.- Returns:
- Result of the DeleteContainerService operation returned by the service.
- See Also:
-
deleteDisk
default DeleteDiskResponse deleteDisk(DeleteDiskRequest deleteDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydisk name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
deleteDiskRequest
-- Returns:
- Result of the DeleteDisk operation returned by the service.
- See Also:
-
deleteDisk
default DeleteDiskResponse deleteDisk(Consumer<DeleteDiskRequest.Builder> deleteDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydisk name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteDiskRequest.Builder
avoiding the need to create one manually viaDeleteDiskRequest.builder()
- Parameters:
deleteDiskRequest
- AConsumer
that will call methods onDeleteDiskRequest.Builder
to create a request.- Returns:
- Result of the DeleteDisk operation returned by the service.
- See Also:
-
deleteDiskSnapshot
default DeleteDiskSnapshotResponse deleteDiskSnapshot(DeleteDiskSnapshotRequest deleteDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydisk snapshot name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
deleteDiskSnapshotRequest
-- Returns:
- Result of the DeleteDiskSnapshot operation returned by the service.
- See Also:
-
deleteDiskSnapshot
default DeleteDiskSnapshotResponse deleteDiskSnapshot(Consumer<DeleteDiskSnapshotRequest.Builder> deleteDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydisk snapshot name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteDiskSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteDiskSnapshotRequest.builder()
- Parameters:
deleteDiskSnapshotRequest
- AConsumer
that will call methods onDeleteDiskSnapshotRequest.Builder
to create a request.- Returns:
- Result of the DeleteDiskSnapshot operation returned by the service.
- See Also:
-
deleteDistribution
default DeleteDistributionResponse deleteDistribution(DeleteDistributionRequest deleteDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes your Amazon Lightsail content delivery network (CDN) distribution.
- Parameters:
deleteDistributionRequest
-- Returns:
- Result of the DeleteDistribution operation returned by the service.
- See Also:
-
deleteDistribution
default DeleteDistributionResponse deleteDistribution(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaDeleteDistributionRequest.builder()
- Parameters:
deleteDistributionRequest
- AConsumer
that will call methods onDeleteDistributionRequest.Builder
to create a request.- Returns:
- Result of the DeleteDistribution operation returned by the service.
- See Also:
-
deleteDomain
default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydomain name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
deleteDomainRequest
-- Returns:
- Result of the DeleteDomain operation returned by the service.
- See Also:
-
deleteDomain
default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydomain name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteDomainRequest.Builder
avoiding the need to create one manually viaDeleteDomainRequest.builder()
- Parameters:
deleteDomainRequest
- AConsumer
that will call methods onDeleteDomainRequest.Builder
to create a request.- Returns:
- Result of the DeleteDomain operation returned by the service.
- See Also:
-
deleteDomainEntry
default DeleteDomainEntryResponse deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes a specific domain entry.
The
delete domain entry
operation supports tag-based access control via resource tags applied to the resource identified bydomain name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
deleteDomainEntryRequest
-- Returns:
- Result of the DeleteDomainEntry operation returned by the service.
- See Also:
-
deleteDomainEntry
default DeleteDomainEntryResponse deleteDomainEntry(Consumer<DeleteDomainEntryRequest.Builder> deleteDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes a specific domain entry.
The
delete domain entry
operation supports tag-based access control via resource tags applied to the resource identified bydomain name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteDomainEntryRequest.Builder
avoiding the need to create one manually viaDeleteDomainEntryRequest.builder()
- Parameters:
deleteDomainEntryRequest
- AConsumer
that will call methods onDeleteDomainEntryRequest.Builder
to create a request.- Returns:
- Result of the DeleteDomainEntry operation returned by the service.
- See Also:
-
deleteInstance
default DeleteInstanceResponse deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes an Amazon Lightsail instance.
The
delete instance
operation supports tag-based access control via resource tags applied to the resource identified byinstance name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
deleteInstanceRequest
-- Returns:
- Result of the DeleteInstance operation returned by the service.
- See Also:
-
deleteInstance
default DeleteInstanceResponse deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes an Amazon Lightsail instance.
The
delete instance
operation supports tag-based access control via resource tags applied to the resource identified byinstance name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteInstanceRequest.Builder
avoiding the need to create one manually viaDeleteInstanceRequest.builder()
- Parameters:
deleteInstanceRequest
- AConsumer
that will call methods onDeleteInstanceRequest.Builder
to create a request.- Returns:
- Result of the DeleteInstance operation returned by the service.
- See Also:
-
deleteInstanceSnapshot
default DeleteInstanceSnapshotResponse deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byinstance snapshot name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
deleteInstanceSnapshotRequest
-- Returns:
- Result of the DeleteInstanceSnapshot operation returned by the service.
- See Also:
-
deleteInstanceSnapshot
default DeleteInstanceSnapshotResponse deleteInstanceSnapshot(Consumer<DeleteInstanceSnapshotRequest.Builder> deleteInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byinstance snapshot name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteInstanceSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteInstanceSnapshotRequest.builder()
- Parameters:
deleteInstanceSnapshotRequest
- AConsumer
that will call methods onDeleteInstanceSnapshotRequest.Builder
to create a request.- Returns:
- Result of the DeleteInstanceSnapshot operation returned by the service.
- See Also:
-
deleteKeyPair
default DeleteKeyPairResponse deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes the specified key pair by removing the public key from Amazon Lightsail.
You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.
The
delete key pair
operation supports tag-based access control via resource tags applied to the resource identified bykey pair name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
deleteKeyPairRequest
-- Returns:
- Result of the DeleteKeyPair operation returned by the service.
- See Also:
-
deleteKeyPair
default DeleteKeyPairResponse deleteKeyPair(Consumer<DeleteKeyPairRequest.Builder> deleteKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes the specified key pair by removing the public key from Amazon Lightsail.
You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.
The
delete key pair
operation supports tag-based access control via resource tags applied to the resource identified bykey pair name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteKeyPairRequest.Builder
avoiding the need to create one manually viaDeleteKeyPairRequest.builder()
- Parameters:
deleteKeyPairRequest
- AConsumer
that will call methods onDeleteKeyPairRequest.Builder
to create a request.- Returns:
- Result of the DeleteKeyPair operation returned by the service.
- See Also:
-
deleteKnownHostKeys
default DeleteKnownHostKeysResponse deleteKnownHostKeys(DeleteKnownHostKeysRequest deleteKnownHostKeysRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
deleteKnownHostKeysRequest
-- Returns:
- Result of the DeleteKnownHostKeys operation returned by the service.
- See Also:
-
deleteKnownHostKeys
default DeleteKnownHostKeysResponse deleteKnownHostKeys(Consumer<DeleteKnownHostKeysRequest.Builder> deleteKnownHostKeysRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaDeleteKnownHostKeysRequest.builder()
- Parameters:
deleteKnownHostKeysRequest
- AConsumer
that will call methods onDeleteKnownHostKeysRequest.Builder
to create a request.- Returns:
- Result of the DeleteKnownHostKeys operation returned by the service.
- See Also:
-
deleteLoadBalancer
default DeleteLoadBalancerResponse deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
deleteLoadBalancerRequest
-- Returns:
- Result of the DeleteLoadBalancer operation returned by the service.
- See Also:
-
deleteLoadBalancer
default DeleteLoadBalancerResponse deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteLoadBalancerRequest.Builder
avoiding the need to create one manually viaDeleteLoadBalancerRequest.builder()
- Parameters:
deleteLoadBalancerRequest
- AConsumer
that will call methods onDeleteLoadBalancerRequest.Builder
to create a request.- Returns:
- Result of the DeleteLoadBalancer operation returned by the service.
- See Also:
-
deleteLoadBalancerTlsCertificate
default DeleteLoadBalancerTlsCertificateResponse deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest deleteLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
deleteLoadBalancerTlsCertificateRequest
-- Returns:
- Result of the DeleteLoadBalancerTlsCertificate operation returned by the service.
- See Also:
-
deleteLoadBalancerTlsCertificate
default DeleteLoadBalancerTlsCertificateResponse deleteLoadBalancerTlsCertificate(Consumer<DeleteLoadBalancerTlsCertificateRequest.Builder> deleteLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteLoadBalancerTlsCertificateRequest.Builder
avoiding the need to create one manually viaDeleteLoadBalancerTlsCertificateRequest.builder()
- Parameters:
deleteLoadBalancerTlsCertificateRequest
- AConsumer
that will call methods onDeleteLoadBalancerTlsCertificateRequest.Builder
to create a request.- Returns:
- Result of the DeleteLoadBalancerTlsCertificate operation returned by the service.
- See Also:
-
deleteRelationalDatabase
default DeleteRelationalDatabaseResponse deleteRelationalDatabase(DeleteRelationalDatabaseRequest deleteRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.- Parameters:
deleteRelationalDatabaseRequest
-- Returns:
- Result of the DeleteRelationalDatabase operation returned by the service.
- See Also:
-
deleteRelationalDatabase
default DeleteRelationalDatabaseResponse deleteRelationalDatabase(Consumer<DeleteRelationalDatabaseRequest.Builder> deleteRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteRelationalDatabaseRequest.Builder
avoiding the need to create one manually viaDeleteRelationalDatabaseRequest.builder()
- Parameters:
deleteRelationalDatabaseRequest
- AConsumer
that will call methods onDeleteRelationalDatabaseRequest.Builder
to create a request.- Returns:
- Result of the DeleteRelationalDatabase operation returned by the service.
- See Also:
-
deleteRelationalDatabaseSnapshot
default DeleteRelationalDatabaseSnapshotResponse deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest deleteRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.- Parameters:
deleteRelationalDatabaseSnapshotRequest
-- Returns:
- Result of the DeleteRelationalDatabaseSnapshot operation returned by the service.
- See Also:
-
deleteRelationalDatabaseSnapshot
default DeleteRelationalDatabaseSnapshotResponse deleteRelationalDatabaseSnapshot(Consumer<DeleteRelationalDatabaseSnapshotRequest.Builder> deleteRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DeleteRelationalDatabaseSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteRelationalDatabaseSnapshotRequest.builder()
- Parameters:
deleteRelationalDatabaseSnapshotRequest
- AConsumer
that will call methods onDeleteRelationalDatabaseSnapshotRequest.Builder
to create a request.- Returns:
- Result of the DeleteRelationalDatabaseSnapshot operation returned by the service.
- See Also:
-
detachCertificateFromDistribution
default DetachCertificateFromDistributionResponse detachCertificateFromDistribution(DetachCertificateFromDistributionRequest detachCertificateFromDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
detachCertificateFromDistributionRequest
-- Returns:
- Result of the DetachCertificateFromDistribution operation returned by the service.
- See Also:
-
detachCertificateFromDistribution
default DetachCertificateFromDistributionResponse detachCertificateFromDistribution(Consumer<DetachCertificateFromDistributionRequest.Builder> detachCertificateFromDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaDetachCertificateFromDistributionRequest.builder()
- Parameters:
detachCertificateFromDistributionRequest
- AConsumer
that will call methods onDetachCertificateFromDistributionRequest.Builder
to create a request.- Returns:
- Result of the DetachCertificateFromDistribution operation returned by the service.
- See Also:
-
detachDisk
default DetachDiskResponse detachDisk(DetachDiskRequest detachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydisk name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
detachDiskRequest
-- Returns:
- Result of the DetachDisk operation returned by the service.
- See Also:
-
detachDisk
default DetachDiskResponse detachDisk(Consumer<DetachDiskRequest.Builder> detachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bydisk name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DetachDiskRequest.Builder
avoiding the need to create one manually viaDetachDiskRequest.builder()
- Parameters:
detachDiskRequest
- AConsumer
that will call methods onDetachDiskRequest.Builder
to create a request.- Returns:
- Result of the DetachDisk operation returned by the service.
- See Also:
-
detachInstancesFromLoadBalancer
default DetachInstancesFromLoadBalancerResponse detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest detachInstancesFromLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
detachInstancesFromLoadBalancerRequest
-- Returns:
- Result of the DetachInstancesFromLoadBalancer operation returned by the service.
- See Also:
-
detachInstancesFromLoadBalancer
default DetachInstancesFromLoadBalancerResponse detachInstancesFromLoadBalancer(Consumer<DetachInstancesFromLoadBalancerRequest.Builder> detachInstancesFromLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DetachInstancesFromLoadBalancerRequest.Builder
avoiding the need to create one manually viaDetachInstancesFromLoadBalancerRequest.builder()
- Parameters:
detachInstancesFromLoadBalancerRequest
- AConsumer
that will call methods onDetachInstancesFromLoadBalancerRequest.Builder
to create a request.- Returns:
- Result of the DetachInstancesFromLoadBalancer operation returned by the service.
- See Also:
-
detachStaticIp
default DetachStaticIpResponse detachStaticIp(DetachStaticIpRequest detachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Detaches a static IP from the Amazon Lightsail instance to which it is attached.
- Parameters:
detachStaticIpRequest
-- Returns:
- Result of the DetachStaticIp operation returned by the service.
- See Also:
-
detachStaticIp
default DetachStaticIpResponse detachStaticIp(Consumer<DetachStaticIpRequest.Builder> detachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaDetachStaticIpRequest.builder()
- Parameters:
detachStaticIpRequest
- AConsumer
that will call methods onDetachStaticIpRequest.Builder
to create a request.- Returns:
- Result of the DetachStaticIp operation returned by the service.
- See Also:
-
disableAddOn
default DisableAddOnResponse disableAddOn(DisableAddOnRequest disableAddOnRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
- Parameters:
disableAddOnRequest
-- Returns:
- Result of the DisableAddOn operation returned by the service.
- See Also:
-
disableAddOn
default DisableAddOnResponse disableAddOn(Consumer<DisableAddOnRequest.Builder> disableAddOnRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
DisableAddOnRequest.Builder
avoiding the need to create one manually viaDisableAddOnRequest.builder()
- Parameters:
disableAddOnRequest
- AConsumer
that will call methods onDisableAddOnRequest.Builder
to create a request.- Returns:
- Result of the DisableAddOn operation returned by the service.
- See Also:
-
downloadDefaultKeyPair
default DownloadDefaultKeyPairResponse downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Downloads the regional Amazon Lightsail default key pair.
This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.
- Parameters:
downloadDefaultKeyPairRequest
-- Returns:
- Result of the DownloadDefaultKeyPair operation returned by the service.
- See Also:
-
downloadDefaultKeyPair
default DownloadDefaultKeyPairResponse downloadDefaultKeyPair(Consumer<DownloadDefaultKeyPairRequest.Builder> downloadDefaultKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Downloads the regional Amazon Lightsail default key pair.
This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.
This is a convenience which creates an instance of the
DownloadDefaultKeyPairRequest.Builder
avoiding the need to create one manually viaDownloadDefaultKeyPairRequest.builder()
- Parameters:
downloadDefaultKeyPairRequest
- AConsumer
that will call methods onDownloadDefaultKeyPairRequest.Builder
to create a request.- Returns:
- Result of the DownloadDefaultKeyPair operation returned by the service.
- See Also:
-
downloadDefaultKeyPair
default DownloadDefaultKeyPairResponse downloadDefaultKeyPair() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionDownloads the regional Amazon Lightsail default key pair.
This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.
- Returns:
- Result of the DownloadDefaultKeyPair operation returned by the service.
- See Also:
-
enableAddOn
default EnableAddOnResponse enableAddOn(EnableAddOnRequest enableAddOnRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
- Parameters:
enableAddOnRequest
-- Returns:
- Result of the EnableAddOn operation returned by the service.
- See Also:
-
enableAddOn
default EnableAddOnResponse enableAddOn(Consumer<EnableAddOnRequest.Builder> enableAddOnRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
EnableAddOnRequest.Builder
avoiding the need to create one manually viaEnableAddOnRequest.builder()
- Parameters:
enableAddOnRequest
- AConsumer
that will call methods onEnableAddOnRequest.Builder
to create a request.- Returns:
- Result of the EnableAddOn operation returned by the service.
- See Also:
-
exportSnapshot
default ExportSnapshotResponse exportSnapshot(ExportSnapshotRequest exportSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bysource snapshot name
. For more information, see the Amazon Lightsail Developer Guide.Use the
get instance snapshots
orget disk snapshots
operations to get a list of snapshots that you can export to Amazon EC2.- Parameters:
exportSnapshotRequest
-- Returns:
- Result of the ExportSnapshot operation returned by the service.
- See Also:
-
exportSnapshot
default ExportSnapshotResponse exportSnapshot(Consumer<ExportSnapshotRequest.Builder> exportSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 bysource snapshot name
. For more information, see the Amazon Lightsail Developer Guide.Use the
get instance snapshots
orget 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 viaExportSnapshotRequest.builder()
- Parameters:
exportSnapshotRequest
- AConsumer
that will call methods onExportSnapshotRequest.Builder
to create a request.- Returns:
- Result of the ExportSnapshot operation returned by the service.
- See Also:
-
getActiveNames
default GetActiveNamesResponse getActiveNames(GetActiveNamesRequest getActiveNamesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the names of all active (not deleted) resources.
- Parameters:
getActiveNamesRequest
-- Returns:
- Result of the GetActiveNames operation returned by the service.
- See Also:
-
getActiveNames
default GetActiveNamesResponse getActiveNames(Consumer<GetActiveNamesRequest.Builder> getActiveNamesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetActiveNamesRequest.builder()
- Parameters:
getActiveNamesRequest
- AConsumer
that will call methods onGetActiveNamesRequest.Builder
to create a request.- Returns:
- Result of the GetActiveNames operation returned by the service.
- See Also:
-
getActiveNames
default GetActiveNamesResponse getActiveNames() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns the names of all active (not deleted) resources.
- Returns:
- Result of the GetActiveNames operation returned by the service.
- See Also:
-
getAlarms
default GetAlarmsResponse getAlarms(GetAlarmsRequest getAlarmsRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
getAlarmsRequest
-- Returns:
- Result of the GetAlarms operation returned by the service.
- See Also:
-
getAlarms
default GetAlarmsResponse getAlarms(Consumer<GetAlarmsRequest.Builder> getAlarmsRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException 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 viaGetAlarmsRequest.builder()
- Parameters:
getAlarmsRequest
- AConsumer
that will call methods onGetAlarmsRequest.Builder
to create a request.- Returns:
- Result of the GetAlarms operation returned by the service.
- See Also:
-
getAutoSnapshots
default GetAutoSnapshotsResponse getAutoSnapshots(GetAutoSnapshotsRequest getAutoSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
- Parameters:
getAutoSnapshotsRequest
-- Returns:
- Result of the GetAutoSnapshots operation returned by the service.
- See Also:
-
getAutoSnapshots
default GetAutoSnapshotsResponse getAutoSnapshots(Consumer<GetAutoSnapshotsRequest.Builder> getAutoSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
GetAutoSnapshotsRequest.Builder
avoiding the need to create one manually viaGetAutoSnapshotsRequest.builder()
- Parameters:
getAutoSnapshotsRequest
- AConsumer
that will call methods onGetAutoSnapshotsRequest.Builder
to create a request.- Returns:
- Result of the GetAutoSnapshots operation returned by the service.
- See Also:
-
getBlueprints
default GetBlueprintsResponse getBlueprints(GetBlueprintsRequest getBlueprintsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
getBlueprintsRequest
-- Returns:
- Result of the GetBlueprints operation returned by the service.
- See Also:
-
getBlueprints
default GetBlueprintsResponse getBlueprints(Consumer<GetBlueprintsRequest.Builder> getBlueprintsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetBlueprintsRequest.builder()
- Parameters:
getBlueprintsRequest
- AConsumer
that will call methods onGetBlueprintsRequest.Builder
to create a request.- Returns:
- Result of the GetBlueprints operation returned by the service.
- See Also:
-
getBlueprints
default GetBlueprintsResponse getBlueprints() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns 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.
- Returns:
- Result of the GetBlueprints operation returned by the service.
- See Also:
-
getBucketAccessKeys
default GetBucketAccessKeysResponse getBucketAccessKeys(GetBucketAccessKeysRequest getBucketAccessKeysRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the existing access key IDs for the specified Amazon Lightsail bucket.
This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key.
- Parameters:
getBucketAccessKeysRequest
-- Returns:
- Result of the GetBucketAccessKeys operation returned by the service.
- See Also:
-
getBucketAccessKeys
default GetBucketAccessKeysResponse getBucketAccessKeys(Consumer<GetBucketAccessKeysRequest.Builder> getBucketAccessKeysRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the existing access key IDs for the specified Amazon Lightsail bucket.
This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key.
This is a convenience which creates an instance of the
GetBucketAccessKeysRequest.Builder
avoiding the need to create one manually viaGetBucketAccessKeysRequest.builder()
- Parameters:
getBucketAccessKeysRequest
- AConsumer
that will call methods onGetBucketAccessKeysRequest.Builder
to create a request.- Returns:
- Result of the GetBucketAccessKeys operation returned by the service.
- See Also:
-
getBucketBundles
default GetBucketBundlesResponse getBucketBundles(GetBucketBundlesRequest getBucketBundlesRequest) throws AccessDeniedException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the bundles that you can apply to a Amazon Lightsail bucket.
The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.
Use the UpdateBucketBundle action to update the bundle for a bucket.
- Parameters:
getBucketBundlesRequest
-- Returns:
- Result of the GetBucketBundles operation returned by the service.
- See Also:
-
getBucketBundles
default GetBucketBundlesResponse getBucketBundles(Consumer<GetBucketBundlesRequest.Builder> getBucketBundlesRequest) throws AccessDeniedException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the bundles that you can apply to a Amazon Lightsail bucket.
The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.
Use the UpdateBucketBundle action to update the bundle for a bucket.
This is a convenience which creates an instance of the
GetBucketBundlesRequest.Builder
avoiding the need to create one manually viaGetBucketBundlesRequest.builder()
- Parameters:
getBucketBundlesRequest
- AConsumer
that will call methods onGetBucketBundlesRequest.Builder
to create a request.- Returns:
- Result of the GetBucketBundles operation returned by the service.
- See Also:
-
getBucketMetricData
default GetBucketMetricDataResponse getBucketMetricData(GetBucketMetricDataRequest getBucketMetricDataRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the data points of a specific metric for an Amazon Lightsail bucket.
Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.
- Parameters:
getBucketMetricDataRequest
-- Returns:
- Result of the GetBucketMetricData operation returned by the service.
- See Also:
-
getBucketMetricData
default GetBucketMetricDataResponse getBucketMetricData(Consumer<GetBucketMetricDataRequest.Builder> getBucketMetricDataRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the data points of a specific metric for an Amazon Lightsail bucket.
Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.
This is a convenience which creates an instance of the
GetBucketMetricDataRequest.Builder
avoiding the need to create one manually viaGetBucketMetricDataRequest.builder()
- Parameters:
getBucketMetricDataRequest
- AConsumer
that will call methods onGetBucketMetricDataRequest.Builder
to create a request.- Returns:
- Result of the GetBucketMetricData operation returned by the service.
- See Also:
-
getBuckets
default GetBucketsResponse getBuckets(GetBucketsRequest getBucketsRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.
For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
- Parameters:
getBucketsRequest
-- Returns:
- Result of the GetBuckets operation returned by the service.
- See Also:
-
getBuckets
default GetBucketsResponse getBuckets(Consumer<GetBucketsRequest.Builder> getBucketsRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.
For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
GetBucketsRequest.Builder
avoiding the need to create one manually viaGetBucketsRequest.builder()
- Parameters:
getBucketsRequest
- AConsumer
that will call methods onGetBucketsRequest.Builder
to create a request.- Returns:
- Result of the GetBuckets operation returned by the service.
- See Also:
-
getBundles
default GetBundlesResponse getBundles(GetBundlesRequest getBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.
Bundles are referred to as instance plans in the Lightsail console.
- Parameters:
getBundlesRequest
-- Returns:
- Result of the GetBundles operation returned by the service.
- See Also:
-
getBundles
default GetBundlesResponse getBundles(Consumer<GetBundlesRequest.Builder> getBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.
Bundles are referred to as instance plans in the Lightsail console.
This is a convenience which creates an instance of the
GetBundlesRequest.Builder
avoiding the need to create one manually viaGetBundlesRequest.builder()
- Parameters:
getBundlesRequest
- AConsumer
that will call methods onGetBundlesRequest.Builder
to create a request.- Returns:
- Result of the GetBundles operation returned by the service.
- See Also:
-
getBundles
default GetBundlesResponse getBundles() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns the bundles that you can apply to an Amazon Lightsail instance when you create it.
A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.
Bundles are referred to as instance plans in the Lightsail console.
- Returns:
- Result of the GetBundles operation returned by the service.
- See Also:
-
getCertificates
default GetCertificatesResponse getCertificates(GetCertificatesRequest getCertificatesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about one or more Amazon Lightsail SSL/TLS certificates.
To get a summary of a certificate, omit
includeCertificateDetails
from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.- Parameters:
getCertificatesRequest
-- Returns:
- Result of the GetCertificates operation returned by the service.
- See Also:
-
getCertificates
default GetCertificatesResponse getCertificates(Consumer<GetCertificatesRequest.Builder> getCertificatesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about one or more Amazon Lightsail SSL/TLS certificates.
To get a summary of a certificate, omit
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 viaGetCertificatesRequest.builder()
- Parameters:
getCertificatesRequest
- AConsumer
that will call methods onGetCertificatesRequest.Builder
to create a request.- Returns:
- Result of the GetCertificates operation returned by the service.
- See Also:
-
getCloudFormationStackRecords
default GetCloudFormationStackRecordsResponse getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest getCloudFormationStackRecordsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
getCloudFormationStackRecordsRequest
-- Returns:
- Result of the GetCloudFormationStackRecords operation returned by the service.
- See Also:
-
getCloudFormationStackRecords
default GetCloudFormationStackRecordsResponse getCloudFormationStackRecords(Consumer<GetCloudFormationStackRecordsRequest.Builder> getCloudFormationStackRecordsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetCloudFormationStackRecordsRequest.builder()
- Parameters:
getCloudFormationStackRecordsRequest
- AConsumer
that will call methods onGetCloudFormationStackRecordsRequest.Builder
to create a request.- Returns:
- Result of the GetCloudFormationStackRecords operation returned by the service.
- See Also:
-
getCloudFormationStackRecords
default GetCloudFormationStackRecordsResponse getCloudFormationStackRecords() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns 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.
- Returns:
- Result of the GetCloudFormationStackRecords operation returned by the service.
- See Also:
-
getContactMethods
default GetContactMethodsResponse getContactMethods(GetContactMethodsRequest getContactMethodsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
- Parameters:
getContactMethodsRequest
-- Returns:
- Result of the GetContactMethods operation returned by the service.
- See Also:
-
getContactMethods
default GetContactMethodsResponse getContactMethods(Consumer<GetContactMethodsRequest.Builder> getContactMethodsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services 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 viaGetContactMethodsRequest.builder()
- Parameters:
getContactMethodsRequest
- AConsumer
that will call methods onGetContactMethodsRequest.Builder
to create a request.- Returns:
- Result of the GetContactMethods operation returned by the service.
- See Also:
-
getContainerAPIMetadata
default GetContainerApiMetadataResponse getContainerAPIMetadata(GetContainerApiMetadataRequest getContainerApiMetadataRequest) throws ServiceException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
- Parameters:
getContainerApiMetadataRequest
-- Returns:
- Result of the GetContainerAPIMetadata operation returned by the service.
- See Also:
-
getContainerAPIMetadata
default GetContainerApiMetadataResponse getContainerAPIMetadata(Consumer<GetContainerApiMetadataRequest.Builder> getContainerApiMetadataRequest) throws ServiceException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetContainerApiMetadataRequest.builder()
- Parameters:
getContainerApiMetadataRequest
- AConsumer
that will call methods onGetContainerApiMetadataRequest.Builder
to create a request.- Returns:
- Result of the GetContainerAPIMetadata operation returned by the service.
- See Also:
-
getContainerImages
default GetContainerImagesResponse getContainerImages(GetContainerImagesRequest getContainerImagesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
getContainerImagesRequest
-- Returns:
- Result of the GetContainerImages operation returned by the service.
- See Also:
-
getContainerImages
default GetContainerImagesResponse getContainerImages(Consumer<GetContainerImagesRequest.Builder> getContainerImagesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetContainerImagesRequest.builder()
- Parameters:
getContainerImagesRequest
- AConsumer
that will call methods onGetContainerImagesRequest.Builder
to create a request.- Returns:
- Result of the GetContainerImages operation returned by the service.
- See Also:
-
getContainerLog
default GetContainerLogResponse getContainerLog(GetContainerLogRequest getContainerLogRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services General Reference.
- Parameters:
getContainerLogRequest
-- Returns:
- Result of the GetContainerLog operation returned by the service.
- See Also:
-
getContainerLog
default GetContainerLogResponse getContainerLog(Consumer<GetContainerLogRequest.Builder> getContainerLogRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services General Reference.
This is a convenience which creates an instance of the
GetContainerLogRequest.Builder
avoiding the need to create one manually viaGetContainerLogRequest.builder()
- Parameters:
getContainerLogRequest
- AConsumer
that will call methods onGetContainerLogRequest.Builder
to create a request.- Returns:
- Result of the GetContainerLog operation returned by the service.
- See Also:
-
getContainerServiceDeployments
default GetContainerServiceDeploymentsResponse getContainerServiceDeployments(GetContainerServiceDeploymentsRequest getContainerServiceDeploymentsRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services General Reference.
- Parameters:
getContainerServiceDeploymentsRequest
-- Returns:
- Result of the GetContainerServiceDeployments operation returned by the service.
- See Also:
-
getContainerServiceDeployments
default GetContainerServiceDeploymentsResponse getContainerServiceDeployments(Consumer<GetContainerServiceDeploymentsRequest.Builder> getContainerServiceDeploymentsRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 Amazon Web Services General Reference.
This is a convenience which creates an instance of the
GetContainerServiceDeploymentsRequest.Builder
avoiding the need to create one manually viaGetContainerServiceDeploymentsRequest.builder()
- Parameters:
getContainerServiceDeploymentsRequest
- AConsumer
that will call methods onGetContainerServiceDeploymentsRequest.Builder
to create a request.- Returns:
- Result of the GetContainerServiceDeployments operation returned by the service.
- See Also:
-
getContainerServiceMetricData
default GetContainerServiceMetricDataResponse getContainerServiceMetricData(GetContainerServiceMetricDataRequest getContainerServiceMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
getContainerServiceMetricDataRequest
-- Returns:
- Result of the GetContainerServiceMetricData operation returned by the service.
- See Also:
-
getContainerServiceMetricData
default GetContainerServiceMetricDataResponse getContainerServiceMetricData(Consumer<GetContainerServiceMetricDataRequest.Builder> getContainerServiceMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetContainerServiceMetricDataRequest.builder()
- Parameters:
getContainerServiceMetricDataRequest
- AConsumer
that will call methods onGetContainerServiceMetricDataRequest.Builder
to create a request.- Returns:
- Result of the GetContainerServiceMetricData operation returned by the service.
- See Also:
-
getContainerServicePowers
default GetContainerServicePowersResponse getContainerServicePowers(GetContainerServicePowersRequest getContainerServicePowersRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
getContainerServicePowersRequest
-- Returns:
- Result of the GetContainerServicePowers operation returned by the service.
- See Also:
-
getContainerServicePowers
default GetContainerServicePowersResponse getContainerServicePowers(Consumer<GetContainerServicePowersRequest.Builder> getContainerServicePowersRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetContainerServicePowersRequest.builder()
- Parameters:
getContainerServicePowersRequest
- AConsumer
that will call methods onGetContainerServicePowersRequest.Builder
to create a request.- Returns:
- Result of the GetContainerServicePowers operation returned by the service.
- See Also:
-
getContainerServices
default GetContainerServicesResponse getContainerServices(GetContainerServicesRequest getContainerServicesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about one or more of your Amazon Lightsail container services.
- Parameters:
getContainerServicesRequest
-- Returns:
- Result of the GetContainerServices operation returned by the service.
- See Also:
-
getContainerServices
default GetContainerServicesResponse getContainerServices(Consumer<GetContainerServicesRequest.Builder> getContainerServicesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetContainerServicesRequest.builder()
- Parameters:
getContainerServicesRequest
- AConsumer
that will call methods onGetContainerServicesRequest.Builder
to create a request.- Returns:
- Result of the GetContainerServices operation returned by the service.
- See Also:
-
getCostEstimate
default GetCostEstimateResponse getCostEstimate(GetCostEstimateRequest getCostEstimateRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.
- Parameters:
getCostEstimateRequest
-- Returns:
- Result of the GetCostEstimate operation returned by the service.
- See Also:
-
getCostEstimate
default GetCostEstimateResponse getCostEstimate(Consumer<GetCostEstimateRequest.Builder> getCostEstimateRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.
This is a convenience which creates an instance of the
GetCostEstimateRequest.Builder
avoiding the need to create one manually viaGetCostEstimateRequest.builder()
- Parameters:
getCostEstimateRequest
- AConsumer
that will call methods onGetCostEstimateRequest.Builder
to create a request.- Returns:
- Result of the GetCostEstimate operation returned by the service.
- See Also:
-
getDisk
default GetDiskResponse getDisk(GetDiskRequest getDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific block storage disk.
- Parameters:
getDiskRequest
-- Returns:
- Result of the GetDisk operation returned by the service.
- See Also:
-
getDisk
default GetDiskResponse getDisk(Consumer<GetDiskRequest.Builder> getDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetDiskRequest.builder()
- Parameters:
getDiskRequest
- AConsumer
that will call methods onGetDiskRequest.Builder
to create a request.- Returns:
- Result of the GetDisk operation returned by the service.
- See Also:
-
getDiskSnapshot
default GetDiskSnapshotResponse getDiskSnapshot(GetDiskSnapshotRequest getDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific block storage disk snapshot.
- Parameters:
getDiskSnapshotRequest
-- Returns:
- Result of the GetDiskSnapshot operation returned by the service.
- See Also:
-
getDiskSnapshot
default GetDiskSnapshotResponse getDiskSnapshot(Consumer<GetDiskSnapshotRequest.Builder> getDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetDiskSnapshotRequest.builder()
- Parameters:
getDiskSnapshotRequest
- AConsumer
that will call methods onGetDiskSnapshotRequest.Builder
to create a request.- Returns:
- Result of the GetDiskSnapshot operation returned by the service.
- See Also:
-
getDiskSnapshots
default GetDiskSnapshotsResponse getDiskSnapshots(GetDiskSnapshotsRequest getDiskSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all block storage disk snapshots in your AWS account and region.
- Parameters:
getDiskSnapshotsRequest
-- Returns:
- Result of the GetDiskSnapshots operation returned by the service.
- See Also:
-
getDiskSnapshots
default GetDiskSnapshotsResponse getDiskSnapshots(Consumer<GetDiskSnapshotsRequest.Builder> getDiskSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetDiskSnapshotsRequest.builder()
- Parameters:
getDiskSnapshotsRequest
- AConsumer
that will call methods onGetDiskSnapshotsRequest.Builder
to create a request.- Returns:
- Result of the GetDiskSnapshots operation returned by the service.
- See Also:
-
getDiskSnapshots
default GetDiskSnapshotsResponse getDiskSnapshots() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns information about all block storage disk snapshots in your AWS account and region.
- Returns:
- Result of the GetDiskSnapshots operation returned by the service.
- See Also:
-
getDisks
default GetDisksResponse getDisks(GetDisksRequest getDisksRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all block storage disks in your AWS account and region.
- Parameters:
getDisksRequest
-- Returns:
- Result of the GetDisks operation returned by the service.
- See Also:
-
getDisks
default GetDisksResponse getDisks(Consumer<GetDisksRequest.Builder> getDisksRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetDisksRequest.builder()
- Parameters:
getDisksRequest
- AConsumer
that will call methods onGetDisksRequest.Builder
to create a request.- Returns:
- Result of the GetDisks operation returned by the service.
- See Also:
-
getDisks
default GetDisksResponse getDisks() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns information about all block storage disks in your AWS account and region.
- Returns:
- Result of the GetDisks operation returned by the service.
- See Also:
-
getDistributionBundles
default GetDistributionBundlesResponse getDistributionBundles(GetDistributionBundlesRequest getDistributionBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
- Parameters:
getDistributionBundlesRequest
-- Returns:
- Result of the GetDistributionBundles operation returned by the service.
- See Also:
-
getDistributionBundles
default GetDistributionBundlesResponse getDistributionBundles(Consumer<GetDistributionBundlesRequest.Builder> getDistributionBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
This is a convenience which creates an instance of the
GetDistributionBundlesRequest.Builder
avoiding the need to create one manually viaGetDistributionBundlesRequest.builder()
- Parameters:
getDistributionBundlesRequest
- AConsumer
that will call methods onGetDistributionBundlesRequest.Builder
to create a request.- Returns:
- Result of the GetDistributionBundles operation returned by the service.
- See Also:
-
getDistributionLatestCacheReset
default GetDistributionLatestCacheResetResponse getDistributionLatestCacheReset(GetDistributionLatestCacheResetRequest getDistributionLatestCacheResetRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
- Parameters:
getDistributionLatestCacheResetRequest
-- Returns:
- Result of the GetDistributionLatestCacheReset operation returned by the service.
- See Also:
-
getDistributionLatestCacheReset
default GetDistributionLatestCacheResetResponse getDistributionLatestCacheReset(Consumer<GetDistributionLatestCacheResetRequest.Builder> getDistributionLatestCacheResetRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetDistributionLatestCacheResetRequest.builder()
- Parameters:
getDistributionLatestCacheResetRequest
- AConsumer
that will call methods onGetDistributionLatestCacheResetRequest.Builder
to create a request.- Returns:
- Result of the GetDistributionLatestCacheReset operation returned by the service.
- See Also:
-
getDistributionMetricData
default GetDistributionMetricDataResponse getDistributionMetricData(GetDistributionMetricDataRequest getDistributionMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
getDistributionMetricDataRequest
-- Returns:
- Result of the GetDistributionMetricData operation returned by the service.
- See Also:
-
getDistributionMetricData
default GetDistributionMetricDataResponse getDistributionMetricData(Consumer<GetDistributionMetricDataRequest.Builder> getDistributionMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetDistributionMetricDataRequest.builder()
- Parameters:
getDistributionMetricDataRequest
- AConsumer
that will call methods onGetDistributionMetricDataRequest.Builder
to create a request.- Returns:
- Result of the GetDistributionMetricData operation returned by the service.
- See Also:
-
getDistributions
default GetDistributionsResponse getDistributions(GetDistributionsRequest getDistributionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
- Parameters:
getDistributionsRequest
-- Returns:
- Result of the GetDistributions operation returned by the service.
- See Also:
-
getDistributions
default GetDistributionsResponse getDistributions(Consumer<GetDistributionsRequest.Builder> getDistributionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetDistributionsRequest.builder()
- Parameters:
getDistributionsRequest
- AConsumer
that will call methods onGetDistributionsRequest.Builder
to create a request.- Returns:
- Result of the GetDistributions operation returned by the service.
- See Also:
-
getDomain
default GetDomainResponse getDomain(GetDomainRequest getDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific domain recordset.
- Parameters:
getDomainRequest
-- Returns:
- Result of the GetDomain operation returned by the service.
- See Also:
-
getDomain
default GetDomainResponse getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetDomainRequest.builder()
- Parameters:
getDomainRequest
- AConsumer
that will call methods onGetDomainRequest.Builder
to create a request.- Returns:
- Result of the GetDomain operation returned by the service.
- See Also:
-
getDomains
default GetDomainsResponse getDomains(GetDomainsRequest getDomainsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a list of all domains in the user's account.
- Parameters:
getDomainsRequest
-- Returns:
- Result of the GetDomains operation returned by the service.
- See Also:
-
getDomains
default GetDomainsResponse getDomains(Consumer<GetDomainsRequest.Builder> getDomainsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetDomainsRequest.builder()
- Parameters:
getDomainsRequest
- AConsumer
that will call methods onGetDomainsRequest.Builder
to create a request.- Returns:
- Result of the GetDomains operation returned by the service.
- See Also:
-
getDomains
default GetDomainsResponse getDomains() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns a list of all domains in the user's account.
- Returns:
- Result of the GetDomains operation returned by the service.
- See Also:
-
getExportSnapshotRecords
default GetExportSnapshotRecordsResponse getExportSnapshotRecords(GetExportSnapshotRecordsRequest getExportSnapshotRecordsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns all export snapshot records 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 CreateCloudFormationStack action.
- Parameters:
getExportSnapshotRecordsRequest
-- Returns:
- Result of the GetExportSnapshotRecords operation returned by the service.
- See Also:
-
getExportSnapshotRecords
default GetExportSnapshotRecordsResponse getExportSnapshotRecords(Consumer<GetExportSnapshotRecordsRequest.Builder> getExportSnapshotRecordsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns all export snapshot records 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 CreateCloudFormationStack action.
This is a convenience which creates an instance of the
GetExportSnapshotRecordsRequest.Builder
avoiding the need to create one manually viaGetExportSnapshotRecordsRequest.builder()
- Parameters:
getExportSnapshotRecordsRequest
- AConsumer
that will call methods onGetExportSnapshotRecordsRequest.Builder
to create a request.- Returns:
- Result of the GetExportSnapshotRecords operation returned by the service.
- See Also:
-
getExportSnapshotRecords
default GetExportSnapshotRecordsResponse getExportSnapshotRecords() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns all export snapshot records 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 CreateCloudFormationStack action.
- Returns:
- Result of the GetExportSnapshotRecords operation returned by the service.
- See Also:
-
getInstance
default GetInstanceResponse getInstance(GetInstanceRequest getInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
- Parameters:
getInstanceRequest
-- Returns:
- Result of the GetInstance operation returned by the service.
- See Also:
-
getInstance
default GetInstanceResponse getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 viaGetInstanceRequest.builder()
- Parameters:
getInstanceRequest
- AConsumer
that will call methods onGetInstanceRequest.Builder
to create a request.- Returns:
- Result of the GetInstance operation returned by the service.
- See Also:
-
getInstanceAccessDetails
default GetInstanceAccessDetailsResponse getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byinstance name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
getInstanceAccessDetailsRequest
-- Returns:
- Result of the GetInstanceAccessDetails operation returned by the service.
- See Also:
-
getInstanceAccessDetails
default GetInstanceAccessDetailsResponse getInstanceAccessDetails(Consumer<GetInstanceAccessDetailsRequest.Builder> getInstanceAccessDetailsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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 byinstance name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
GetInstanceAccessDetailsRequest.Builder
avoiding the need to create one manually viaGetInstanceAccessDetailsRequest.builder()
- Parameters:
getInstanceAccessDetailsRequest
- AConsumer
that will call methods onGetInstanceAccessDetailsRequest.Builder
to create a request.- Returns:
- Result of the GetInstanceAccessDetails operation returned by the service.
- See Also:
-
getInstanceMetricData
default GetInstanceMetricDataResponse getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
- Parameters:
getInstanceMetricDataRequest
-- Returns:
- Result of the GetInstanceMetricData operation returned by the service.
- See Also:
-
getInstanceMetricData
default GetInstanceMetricDataResponse getInstanceMetricData(Consumer<GetInstanceMetricDataRequest.Builder> getInstanceMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
This is a convenience which creates an instance of the
GetInstanceMetricDataRequest.Builder
avoiding the need to create one manually viaGetInstanceMetricDataRequest.builder()
- Parameters:
getInstanceMetricDataRequest
- AConsumer
that will call methods onGetInstanceMetricDataRequest.Builder
to create a request.- Returns:
- Result of the GetInstanceMetricData operation returned by the service.
- See Also:
-
getInstancePortStates
default GetInstancePortStatesResponse getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
- Parameters:
getInstancePortStatesRequest
-- Returns:
- Result of the GetInstancePortStates operation returned by the service.
- See Also:
-
getInstancePortStates
default GetInstancePortStatesResponse getInstancePortStates(Consumer<GetInstancePortStatesRequest.Builder> getInstancePortStatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException 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.
This is a convenience which creates an instance of the
GetInstancePortStatesRequest.Builder
avoiding the need to create one manually viaGetInstancePortStatesRequest.builder()
- Parameters:
getInstancePortStatesRequest
- AConsumer
that will call methods onGetInstancePortStatesRequest.Builder
to create a request.- Returns:
- Result of the GetInstancePortStates operation returned by the service.
- See Also:
-
getInstanceSnapshot
default GetInstanceSnapshotResponse getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific instance snapshot.
- Parameters:
getInstanceSnapshotRequest
-- Returns:
- Result of the GetInstanceSnapshot operation returned by the service.
- See Also:
-
getInstanceSnapshot
default GetInstanceSnapshotResponse getInstanceSnapshot(Consumer<GetInstanceSnapshotRequest.Builder> getInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific instance snapshot.
This is a convenience which creates an instance of the
GetInstanceSnapshotRequest.Builder
avoiding the need to create one manually viaGetInstanceSnapshotRequest.builder()
- Parameters:
getInstanceSnapshotRequest
- AConsumer
that will call methods onGetInstanceSnapshotRequest.Builder
to create a request.- Returns:
- Result of the GetInstanceSnapshot operation returned by the service.
- See Also:
-
getInstanceSnapshots
default GetInstanceSnapshotsResponse getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns all instance snapshots for the user's account.
- Parameters:
getInstanceSnapshotsRequest
-- Returns:
- Result of the GetInstanceSnapshots operation returned by the service.
- See Also:
-
getInstanceSnapshots
default GetInstanceSnapshotsResponse getInstanceSnapshots(Consumer<GetInstanceSnapshotsRequest.Builder> getInstanceSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns all instance snapshots for the user's account.
This is a convenience which creates an instance of the
GetInstanceSnapshotsRequest.Builder
avoiding the need to create one manually viaGetInstanceSnapshotsRequest.builder()
- Parameters:
getInstanceSnapshotsRequest
- AConsumer
that will call methods onGetInstanceSnapshotsRequest.Builder
to create a request.- Returns:
- Result of the GetInstanceSnapshots operation returned by the service.
- See Also:
-
getInstanceSnapshots
default GetInstanceSnapshotsResponse getInstanceSnapshots() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns all instance snapshots for the user's account.
- Returns:
- Result of the GetInstanceSnapshots operation returned by the service.
- See Also:
-
getInstanceState
default GetInstanceStateResponse getInstanceState(GetInstanceStateRequest getInstanceStateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the state of a specific instance. Works on one instance at a time.
- Parameters:
getInstanceStateRequest
-- Returns:
- Result of the GetInstanceState operation returned by the service.
- See Also:
-
getInstanceState
default GetInstanceStateResponse getInstanceState(Consumer<GetInstanceStateRequest.Builder> getInstanceStateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the state of a specific instance. Works on one instance at a time.
This is a convenience which creates an instance of the
GetInstanceStateRequest.Builder
avoiding the need to create one manually viaGetInstanceStateRequest.builder()
- Parameters:
getInstanceStateRequest
- AConsumer
that will call methods onGetInstanceStateRequest.Builder
to create a request.- Returns:
- Result of the GetInstanceState operation returned by the service.
- See Also:
-
getInstances
default GetInstancesResponse getInstances(GetInstancesRequest getInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all Amazon Lightsail virtual private servers, or instances.
- Parameters:
getInstancesRequest
-- Returns:
- Result of the GetInstances operation returned by the service.
- See Also:
-
getInstances
default GetInstancesResponse getInstances(Consumer<GetInstancesRequest.Builder> getInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all Amazon Lightsail virtual private servers, or instances.
This is a convenience which creates an instance of the
GetInstancesRequest.Builder
avoiding the need to create one manually viaGetInstancesRequest.builder()
- Parameters:
getInstancesRequest
- AConsumer
that will call methods onGetInstancesRequest.Builder
to create a request.- Returns:
- Result of the GetInstances operation returned by the service.
- See Also:
-
getInstances
default GetInstancesResponse getInstances() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns information about all Amazon Lightsail virtual private servers, or instances.
- Returns:
- Result of the GetInstances operation returned by the service.
- See Also:
-
getKeyPair
default GetKeyPairResponse getKeyPair(GetKeyPairRequest getKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific key pair.
- Parameters:
getKeyPairRequest
-- Returns:
- Result of the GetKeyPair operation returned by the service.
- See Also:
-
getKeyPair
default GetKeyPairResponse getKeyPair(Consumer<GetKeyPairRequest.Builder> getKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific key pair.
This is a convenience which creates an instance of the
GetKeyPairRequest.Builder
avoiding the need to create one manually viaGetKeyPairRequest.builder()
- Parameters:
getKeyPairRequest
- AConsumer
that will call methods onGetKeyPairRequest.Builder
to create a request.- Returns:
- Result of the GetKeyPair operation returned by the service.
- See Also:
-
getKeyPairs
default GetKeyPairsResponse getKeyPairs(GetKeyPairsRequest getKeyPairsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all key pairs in the user's account.
- Parameters:
getKeyPairsRequest
-- Returns:
- Result of the GetKeyPairs operation returned by the service.
- See Also:
-
getKeyPairs
default GetKeyPairsResponse getKeyPairs(Consumer<GetKeyPairsRequest.Builder> getKeyPairsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all key pairs in the user's account.
This is a convenience which creates an instance of the
GetKeyPairsRequest.Builder
avoiding the need to create one manually viaGetKeyPairsRequest.builder()
- Parameters:
getKeyPairsRequest
- AConsumer
that will call methods onGetKeyPairsRequest.Builder
to create a request.- Returns:
- Result of the GetKeyPairs operation returned by the service.
- See Also:
-
getKeyPairs
default GetKeyPairsResponse getKeyPairs() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns information about all key pairs in the user's account.
- Returns:
- Result of the GetKeyPairs operation returned by the service.
- See Also:
-
getLoadBalancer
default GetLoadBalancerResponse getLoadBalancer(GetLoadBalancerRequest getLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about the specified Lightsail load balancer.
- Parameters:
getLoadBalancerRequest
-- Returns:
- Result of the GetLoadBalancer operation returned by the service.
- See Also:
-
getLoadBalancer
default GetLoadBalancerResponse getLoadBalancer(Consumer<GetLoadBalancerRequest.Builder> getLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about the specified Lightsail load balancer.
This is a convenience which creates an instance of the
GetLoadBalancerRequest.Builder
avoiding the need to create one manually viaGetLoadBalancerRequest.builder()
- Parameters:
getLoadBalancerRequest
- AConsumer
that will call methods onGetLoadBalancerRequest.Builder
to create a request.- Returns:
- Result of the GetLoadBalancer operation returned by the service.
- See Also:
-
getLoadBalancerMetricData
default GetLoadBalancerMetricDataResponse getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest getLoadBalancerMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about health metrics for your Lightsail load balancer.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
- Parameters:
getLoadBalancerMetricDataRequest
-- Returns:
- Result of the GetLoadBalancerMetricData operation returned by the service.
- See Also:
-
getLoadBalancerMetricData
default GetLoadBalancerMetricDataResponse getLoadBalancerMetricData(Consumer<GetLoadBalancerMetricDataRequest.Builder> getLoadBalancerMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about health metrics for your Lightsail load balancer.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
This is a convenience which creates an instance of the
GetLoadBalancerMetricDataRequest.Builder
avoiding the need to create one manually viaGetLoadBalancerMetricDataRequest.builder()
- Parameters:
getLoadBalancerMetricDataRequest
- AConsumer
that will call methods onGetLoadBalancerMetricDataRequest.Builder
to create a request.- Returns:
- Result of the GetLoadBalancerMetricData operation returned by the service.
- See Also:
-
getLoadBalancerTlsCertificates
default GetLoadBalancerTlsCertificatesResponse getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest getLoadBalancerTlsCertificatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
- Parameters:
getLoadBalancerTlsCertificatesRequest
-- Returns:
- Result of the GetLoadBalancerTlsCertificates operation returned by the service.
- See Also:
-
getLoadBalancerTlsCertificates
default GetLoadBalancerTlsCertificatesResponse getLoadBalancerTlsCertificates(Consumer<GetLoadBalancerTlsCertificatesRequest.Builder> getLoadBalancerTlsCertificatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
This is a convenience which creates an instance of the
GetLoadBalancerTlsCertificatesRequest.Builder
avoiding the need to create one manually viaGetLoadBalancerTlsCertificatesRequest.builder()
- Parameters:
getLoadBalancerTlsCertificatesRequest
- AConsumer
that will call methods onGetLoadBalancerTlsCertificatesRequest.Builder
to create a request.- Returns:
- Result of the GetLoadBalancerTlsCertificates operation returned by the service.
- See Also:
-
getLoadBalancerTlsPolicies
default GetLoadBalancerTlsPoliciesResponse getLoadBalancerTlsPolicies(GetLoadBalancerTlsPoliciesRequest getLoadBalancerTlsPoliciesRequest) throws ServiceException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, InvalidInputException, AwsServiceException, SdkClientException, LightsailException Returns a list of TLS security policies that you can apply to Lightsail load balancers.
For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
- Parameters:
getLoadBalancerTlsPoliciesRequest
-- Returns:
- Result of the GetLoadBalancerTlsPolicies operation returned by the service.
- See Also:
-
getLoadBalancerTlsPolicies
default GetLoadBalancerTlsPoliciesResponse getLoadBalancerTlsPolicies(Consumer<GetLoadBalancerTlsPoliciesRequest.Builder> getLoadBalancerTlsPoliciesRequest) throws ServiceException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, InvalidInputException, AwsServiceException, SdkClientException, LightsailException Returns a list of TLS security policies that you can apply to Lightsail load balancers.
For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
GetLoadBalancerTlsPoliciesRequest.Builder
avoiding the need to create one manually viaGetLoadBalancerTlsPoliciesRequest.builder()
- Parameters:
getLoadBalancerTlsPoliciesRequest
- AConsumer
that will call methods onGetLoadBalancerTlsPoliciesRequest.Builder
to create a request.- Returns:
- Result of the GetLoadBalancerTlsPolicies operation returned by the service.
- See Also:
-
getLoadBalancers
default GetLoadBalancersResponse getLoadBalancers(GetLoadBalancersRequest getLoadBalancersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all load balancers in an account.
- Parameters:
getLoadBalancersRequest
-- Returns:
- Result of the GetLoadBalancers operation returned by the service.
- See Also:
-
getLoadBalancers
default GetLoadBalancersResponse getLoadBalancers(Consumer<GetLoadBalancersRequest.Builder> getLoadBalancersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all load balancers in an account.
This is a convenience which creates an instance of the
GetLoadBalancersRequest.Builder
avoiding the need to create one manually viaGetLoadBalancersRequest.builder()
- Parameters:
getLoadBalancersRequest
- AConsumer
that will call methods onGetLoadBalancersRequest.Builder
to create a request.- Returns:
- Result of the GetLoadBalancers operation returned by the service.
- See Also:
-
getLoadBalancers
default GetLoadBalancersResponse getLoadBalancers() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns information about all load balancers in an account.
- Returns:
- Result of the GetLoadBalancers operation returned by the service.
- See Also:
-
getOperation
default GetOperationResponse getOperation(GetOperationRequest getOperationRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
- Parameters:
getOperationRequest
-- Returns:
- Result of the GetOperation operation returned by the service.
- See Also:
-
getOperation
default GetOperationResponse getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
This is a convenience which creates an instance of the
GetOperationRequest.Builder
avoiding the need to create one manually viaGetOperationRequest.builder()
- Parameters:
getOperationRequest
- AConsumer
that will call methods onGetOperationRequest.Builder
to create a request.- Returns:
- Result of the GetOperation operation returned by the service.
- See Also:
-
getOperations
default GetOperationsResponse getOperations(GetOperationsRequest getOperationsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to
GetOperations
use the maximum (last)statusChangedAt
value from the previous request.- Parameters:
getOperationsRequest
-- Returns:
- Result of the GetOperations operation returned by the service.
- See Also:
-
getOperations
default GetOperationsResponse getOperations(Consumer<GetOperationsRequest.Builder> getOperationsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to
GetOperations
use the maximum (last)statusChangedAt
value from the previous request.
This is a convenience which creates an instance of the
GetOperationsRequest.Builder
avoiding the need to create one manually viaGetOperationsRequest.builder()
- Parameters:
getOperationsRequest
- AConsumer
that will call methods onGetOperationsRequest.Builder
to create a request.- Returns:
- Result of the GetOperations operation returned by the service.
- See Also:
-
getOperations
default GetOperationsResponse getOperations() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to
GetOperations
use the maximum (last)statusChangedAt
value from the previous request.- Returns:
- Result of the GetOperations operation returned by the service.
- See Also:
-
getOperationsForResource
default GetOperationsForResourceResponse getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Gets operations for a specific resource (an instance or a static IP).
- Parameters:
getOperationsForResourceRequest
-- Returns:
- Result of the GetOperationsForResource operation returned by the service.
- See Also:
-
getOperationsForResource
default GetOperationsForResourceResponse getOperationsForResource(Consumer<GetOperationsForResourceRequest.Builder> getOperationsForResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Gets operations for a specific resource (an instance or a static IP).
This is a convenience which creates an instance of the
GetOperationsForResourceRequest.Builder
avoiding the need to create one manually viaGetOperationsForResourceRequest.builder()
- Parameters:
getOperationsForResourceRequest
- AConsumer
that will call methods onGetOperationsForResourceRequest.Builder
to create a request.- Returns:
- Result of the GetOperationsForResource operation returned by the service.
- See Also:
-
getRegions
default GetRegionsResponse getRegions(GetRegionsRequest getRegionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a list of all valid regions for Amazon Lightsail. Use the
include availability zones
parameter to also return the Availability Zones in a region.- Parameters:
getRegionsRequest
-- Returns:
- Result of the GetRegions operation returned by the service.
- See Also:
-
getRegions
default GetRegionsResponse getRegions(Consumer<GetRegionsRequest.Builder> getRegionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a list of all valid regions for Amazon Lightsail. Use the
include availability zones
parameter to also return the Availability Zones in a region.
This is a convenience which creates an instance of the
GetRegionsRequest.Builder
avoiding the need to create one manually viaGetRegionsRequest.builder()
- Parameters:
getRegionsRequest
- AConsumer
that will call methods onGetRegionsRequest.Builder
to create a request.- Returns:
- Result of the GetRegions operation returned by the service.
- See Also:
-
getRegions
default GetRegionsResponse getRegions() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns a list of all valid regions for Amazon Lightsail. Use the
include availability zones
parameter to also return the Availability Zones in a region.- Returns:
- Result of the GetRegions operation returned by the service.
- See Also:
-
getRelationalDatabase
default GetRelationalDatabaseResponse getRelationalDatabase(GetRelationalDatabaseRequest getRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific database in Amazon Lightsail.
- Parameters:
getRelationalDatabaseRequest
-- Returns:
- Result of the GetRelationalDatabase operation returned by the service.
- See Also:
-
getRelationalDatabase
default GetRelationalDatabaseResponse getRelationalDatabase(Consumer<GetRelationalDatabaseRequest.Builder> getRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific database in Amazon Lightsail.
This is a convenience which creates an instance of the
GetRelationalDatabaseRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabaseRequest.builder()
- Parameters:
getRelationalDatabaseRequest
- AConsumer
that will call methods onGetRelationalDatabaseRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabase operation returned by the service.
- See Also:
-
getRelationalDatabaseBlueprints
default GetRelationalDatabaseBlueprintsResponse getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest getRelationalDatabaseBlueprintsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
You can use a blueprint ID to create a new database that runs a specific database engine.
- Parameters:
getRelationalDatabaseBlueprintsRequest
-- Returns:
- Result of the GetRelationalDatabaseBlueprints operation returned by the service.
- See Also:
-
getRelationalDatabaseBlueprints
default GetRelationalDatabaseBlueprintsResponse getRelationalDatabaseBlueprints(Consumer<GetRelationalDatabaseBlueprintsRequest.Builder> getRelationalDatabaseBlueprintsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
You can use a blueprint ID to create a new database that runs a specific database engine.
This is a convenience which creates an instance of the
GetRelationalDatabaseBlueprintsRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabaseBlueprintsRequest.builder()
- Parameters:
getRelationalDatabaseBlueprintsRequest
- AConsumer
that will call methods onGetRelationalDatabaseBlueprintsRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabaseBlueprints operation returned by the service.
- See Also:
-
getRelationalDatabaseBlueprints
default GetRelationalDatabaseBlueprintsResponse getRelationalDatabaseBlueprints() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
You can use a blueprint ID to create a new database that runs a specific database engine.
- Returns:
- Result of the GetRelationalDatabaseBlueprints operation returned by the service.
- See Also:
-
getRelationalDatabaseBundles
default GetRelationalDatabaseBundlesResponse getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest getRelationalDatabaseBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
You can use a bundle ID to create a new database with explicit performance specifications.
- Parameters:
getRelationalDatabaseBundlesRequest
-- Returns:
- Result of the GetRelationalDatabaseBundles operation returned by the service.
- See Also:
-
getRelationalDatabaseBundles
default GetRelationalDatabaseBundlesResponse getRelationalDatabaseBundles(Consumer<GetRelationalDatabaseBundlesRequest.Builder> getRelationalDatabaseBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
You can use a bundle ID to create a new database with explicit performance specifications.
This is a convenience which creates an instance of the
GetRelationalDatabaseBundlesRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabaseBundlesRequest.builder()
- Parameters:
getRelationalDatabaseBundlesRequest
- AConsumer
that will call methods onGetRelationalDatabaseBundlesRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabaseBundles operation returned by the service.
- See Also:
-
getRelationalDatabaseBundles
default GetRelationalDatabaseBundlesResponse getRelationalDatabaseBundles() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
You can use a bundle ID to create a new database with explicit performance specifications.
- Returns:
- Result of the GetRelationalDatabaseBundles operation returned by the service.
- See Also:
-
getRelationalDatabaseEvents
default GetRelationalDatabaseEventsResponse getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest getRelationalDatabaseEventsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a list of events for a specific database in Amazon Lightsail.
- Parameters:
getRelationalDatabaseEventsRequest
-- Returns:
- Result of the GetRelationalDatabaseEvents operation returned by the service.
- See Also:
-
getRelationalDatabaseEvents
default GetRelationalDatabaseEventsResponse getRelationalDatabaseEvents(Consumer<GetRelationalDatabaseEventsRequest.Builder> getRelationalDatabaseEventsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a list of events for a specific database in Amazon Lightsail.
This is a convenience which creates an instance of the
GetRelationalDatabaseEventsRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabaseEventsRequest.builder()
- Parameters:
getRelationalDatabaseEventsRequest
- AConsumer
that will call methods onGetRelationalDatabaseEventsRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabaseEvents operation returned by the service.
- See Also:
-
getRelationalDatabaseLogEvents
default GetRelationalDatabaseLogEventsResponse getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest getRelationalDatabaseLogEventsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a list of log events for a database in Amazon Lightsail.
- Parameters:
getRelationalDatabaseLogEventsRequest
-- Returns:
- Result of the GetRelationalDatabaseLogEvents operation returned by the service.
- See Also:
-
getRelationalDatabaseLogEvents
default GetRelationalDatabaseLogEventsResponse getRelationalDatabaseLogEvents(Consumer<GetRelationalDatabaseLogEventsRequest.Builder> getRelationalDatabaseLogEventsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a list of log events for a database in Amazon Lightsail.
This is a convenience which creates an instance of the
GetRelationalDatabaseLogEventsRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabaseLogEventsRequest.builder()
- Parameters:
getRelationalDatabaseLogEventsRequest
- AConsumer
that will call methods onGetRelationalDatabaseLogEventsRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabaseLogEvents operation returned by the service.
- See Also:
-
getRelationalDatabaseLogStreams
default GetRelationalDatabaseLogStreamsResponse getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest getRelationalDatabaseLogStreamsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a list of available log streams for a specific database in Amazon Lightsail.
- Parameters:
getRelationalDatabaseLogStreamsRequest
-- Returns:
- Result of the GetRelationalDatabaseLogStreams operation returned by the service.
- See Also:
-
getRelationalDatabaseLogStreams
default GetRelationalDatabaseLogStreamsResponse getRelationalDatabaseLogStreams(Consumer<GetRelationalDatabaseLogStreamsRequest.Builder> getRelationalDatabaseLogStreamsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a list of available log streams for a specific database in Amazon Lightsail.
This is a convenience which creates an instance of the
GetRelationalDatabaseLogStreamsRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabaseLogStreamsRequest.builder()
- Parameters:
getRelationalDatabaseLogStreamsRequest
- AConsumer
that will call methods onGetRelationalDatabaseLogStreamsRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabaseLogStreams operation returned by the service.
- See Also:
-
getRelationalDatabaseMasterUserPassword
default GetRelationalDatabaseMasterUserPasswordResponse getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest getRelationalDatabaseMasterUserPasswordRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the current, previous, or pending versions of the master user password for a Lightsail database.
The
GetRelationalDatabaseMasterUserPassword
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.- Parameters:
getRelationalDatabaseMasterUserPasswordRequest
-- Returns:
- Result of the GetRelationalDatabaseMasterUserPassword operation returned by the service.
- See Also:
-
getRelationalDatabaseMasterUserPassword
default GetRelationalDatabaseMasterUserPasswordResponse getRelationalDatabaseMasterUserPassword(Consumer<GetRelationalDatabaseMasterUserPasswordRequest.Builder> getRelationalDatabaseMasterUserPasswordRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the current, previous, or pending versions of the master user password for a Lightsail database.
The
GetRelationalDatabaseMasterUserPassword
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.
This is a convenience which creates an instance of the
GetRelationalDatabaseMasterUserPasswordRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabaseMasterUserPasswordRequest.builder()
- Parameters:
getRelationalDatabaseMasterUserPasswordRequest
- AConsumer
that will call methods onGetRelationalDatabaseMasterUserPasswordRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabaseMasterUserPassword operation returned by the service.
- See Also:
-
getRelationalDatabaseMetricData
default GetRelationalDatabaseMetricDataResponse getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest getRelationalDatabaseMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the data points of the specified metric for a database in Amazon Lightsail.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
- Parameters:
getRelationalDatabaseMetricDataRequest
-- Returns:
- Result of the GetRelationalDatabaseMetricData operation returned by the service.
- See Also:
-
getRelationalDatabaseMetricData
default GetRelationalDatabaseMetricDataResponse getRelationalDatabaseMetricData(Consumer<GetRelationalDatabaseMetricDataRequest.Builder> getRelationalDatabaseMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns the data points of the specified metric for a database in Amazon Lightsail.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
This is a convenience which creates an instance of the
GetRelationalDatabaseMetricDataRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabaseMetricDataRequest.builder()
- Parameters:
getRelationalDatabaseMetricDataRequest
- AConsumer
that will call methods onGetRelationalDatabaseMetricDataRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabaseMetricData operation returned by the service.
- See Also:
-
getRelationalDatabaseParameters
default GetRelationalDatabaseParametersResponse getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest getRelationalDatabaseParametersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
- Parameters:
getRelationalDatabaseParametersRequest
-- Returns:
- Result of the GetRelationalDatabaseParameters operation returned by the service.
- See Also:
-
getRelationalDatabaseParameters
default GetRelationalDatabaseParametersResponse getRelationalDatabaseParameters(Consumer<GetRelationalDatabaseParametersRequest.Builder> getRelationalDatabaseParametersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
This is a convenience which creates an instance of the
GetRelationalDatabaseParametersRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabaseParametersRequest.builder()
- Parameters:
getRelationalDatabaseParametersRequest
- AConsumer
that will call methods onGetRelationalDatabaseParametersRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabaseParameters operation returned by the service.
- See Also:
-
getRelationalDatabaseSnapshot
default GetRelationalDatabaseSnapshotResponse getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest getRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific database snapshot in Amazon Lightsail.
- Parameters:
getRelationalDatabaseSnapshotRequest
-- Returns:
- Result of the GetRelationalDatabaseSnapshot operation returned by the service.
- See Also:
-
getRelationalDatabaseSnapshot
default GetRelationalDatabaseSnapshotResponse getRelationalDatabaseSnapshot(Consumer<GetRelationalDatabaseSnapshotRequest.Builder> getRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about a specific database snapshot in Amazon Lightsail.
This is a convenience which creates an instance of the
GetRelationalDatabaseSnapshotRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabaseSnapshotRequest.builder()
- Parameters:
getRelationalDatabaseSnapshotRequest
- AConsumer
that will call methods onGetRelationalDatabaseSnapshotRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabaseSnapshot operation returned by the service.
- See Also:
-
getRelationalDatabaseSnapshots
default GetRelationalDatabaseSnapshotsResponse getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest getRelationalDatabaseSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all of your database snapshots in Amazon Lightsail.
- Parameters:
getRelationalDatabaseSnapshotsRequest
-- Returns:
- Result of the GetRelationalDatabaseSnapshots operation returned by the service.
- See Also:
-
getRelationalDatabaseSnapshots
default GetRelationalDatabaseSnapshotsResponse getRelationalDatabaseSnapshots(Consumer<GetRelationalDatabaseSnapshotsRequest.Builder> getRelationalDatabaseSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all of your database snapshots in Amazon Lightsail.
This is a convenience which creates an instance of the
GetRelationalDatabaseSnapshotsRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabaseSnapshotsRequest.builder()
- Parameters:
getRelationalDatabaseSnapshotsRequest
- AConsumer
that will call methods onGetRelationalDatabaseSnapshotsRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabaseSnapshots operation returned by the service.
- See Also:
-
getRelationalDatabaseSnapshots
default GetRelationalDatabaseSnapshotsResponse getRelationalDatabaseSnapshots() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns information about all of your database snapshots in Amazon Lightsail.
- Returns:
- Result of the GetRelationalDatabaseSnapshots operation returned by the service.
- See Also:
-
getRelationalDatabases
default GetRelationalDatabasesResponse getRelationalDatabases(GetRelationalDatabasesRequest getRelationalDatabasesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all of your databases in Amazon Lightsail.
- Parameters:
getRelationalDatabasesRequest
-- Returns:
- Result of the GetRelationalDatabases operation returned by the service.
- See Also:
-
getRelationalDatabases
default GetRelationalDatabasesResponse getRelationalDatabases(Consumer<GetRelationalDatabasesRequest.Builder> getRelationalDatabasesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all of your databases in Amazon Lightsail.
This is a convenience which creates an instance of the
GetRelationalDatabasesRequest.Builder
avoiding the need to create one manually viaGetRelationalDatabasesRequest.builder()
- Parameters:
getRelationalDatabasesRequest
- AConsumer
that will call methods onGetRelationalDatabasesRequest.Builder
to create a request.- Returns:
- Result of the GetRelationalDatabases operation returned by the service.
- See Also:
-
getRelationalDatabases
default GetRelationalDatabasesResponse getRelationalDatabases() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns information about all of your databases in Amazon Lightsail.
- Returns:
- Result of the GetRelationalDatabases operation returned by the service.
- See Also:
-
getSetupHistory
default GetSetupHistoryResponse getSetupHistory(GetSetupHistoryRequest getSetupHistoryRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns detailed information for five of the most recent
SetupInstanceHttps
requests that were ran on the target instance.- Parameters:
getSetupHistoryRequest
-- Returns:
- Result of the GetSetupHistory operation returned by the service.
- See Also:
-
getSetupHistory
default GetSetupHistoryResponse getSetupHistory(Consumer<GetSetupHistoryRequest.Builder> getSetupHistoryRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns detailed information for five of the most recent
SetupInstanceHttps
requests that were ran on the target instance.
This is a convenience which creates an instance of the
GetSetupHistoryRequest.Builder
avoiding the need to create one manually viaGetSetupHistoryRequest.builder()
- Parameters:
getSetupHistoryRequest
- AConsumer
that will call methods onGetSetupHistoryRequest.Builder
to create a request.- Returns:
- Result of the GetSetupHistory operation returned by the service.
- See Also:
-
getStaticIp
default GetStaticIpResponse getStaticIp(GetStaticIpRequest getStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about an Amazon Lightsail static IP.
- Parameters:
getStaticIpRequest
-- Returns:
- Result of the GetStaticIp operation returned by the service.
- See Also:
-
getStaticIp
default GetStaticIpResponse getStaticIp(Consumer<GetStaticIpRequest.Builder> getStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about an Amazon Lightsail static IP.
This is a convenience which creates an instance of the
GetStaticIpRequest.Builder
avoiding the need to create one manually viaGetStaticIpRequest.builder()
- Parameters:
getStaticIpRequest
- AConsumer
that will call methods onGetStaticIpRequest.Builder
to create a request.- Returns:
- Result of the GetStaticIp operation returned by the service.
- See Also:
-
getStaticIps
default GetStaticIpsResponse getStaticIps(GetStaticIpsRequest getStaticIpsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all static IPs in the user's account.
- Parameters:
getStaticIpsRequest
-- Returns:
- Result of the GetStaticIps operation returned by the service.
- See Also:
-
getStaticIps
default GetStaticIpsResponse getStaticIps(Consumer<GetStaticIpsRequest.Builder> getStaticIpsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns information about all static IPs in the user's account.
This is a convenience which creates an instance of the
GetStaticIpsRequest.Builder
avoiding the need to create one manually viaGetStaticIpsRequest.builder()
- Parameters:
getStaticIpsRequest
- AConsumer
that will call methods onGetStaticIpsRequest.Builder
to create a request.- Returns:
- Result of the GetStaticIps operation returned by the service.
- See Also:
-
getStaticIps
default GetStaticIpsResponse getStaticIps() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns information about all static IPs in the user's account.
- Returns:
- Result of the GetStaticIps operation returned by the service.
- See Also:
-
importKeyPair
default ImportKeyPairResponse importKeyPair(ImportKeyPairRequest importKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Imports a public SSH key from a specific key pair.
- Parameters:
importKeyPairRequest
-- Returns:
- Result of the ImportKeyPair operation returned by the service.
- See Also:
-
importKeyPair
default ImportKeyPairResponse importKeyPair(Consumer<ImportKeyPairRequest.Builder> importKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Imports a public SSH key from a specific key pair.
This is a convenience which creates an instance of the
ImportKeyPairRequest.Builder
avoiding the need to create one manually viaImportKeyPairRequest.builder()
- Parameters:
importKeyPairRequest
- AConsumer
that will call methods onImportKeyPairRequest.Builder
to create a request.- Returns:
- Result of the ImportKeyPair operation returned by the service.
- See Also:
-
isVpcPeered
default IsVpcPeeredResponse isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a Boolean value indicating whether your Lightsail VPC is peered.
- Parameters:
isVpcPeeredRequest
-- Returns:
- Result of the IsVpcPeered operation returned by the service.
- See Also:
-
isVpcPeered
default IsVpcPeeredResponse isVpcPeered(Consumer<IsVpcPeeredRequest.Builder> isVpcPeeredRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Returns a Boolean value indicating whether your Lightsail VPC is peered.
This is a convenience which creates an instance of the
IsVpcPeeredRequest.Builder
avoiding the need to create one manually viaIsVpcPeeredRequest.builder()
- Parameters:
isVpcPeeredRequest
- AConsumer
that will call methods onIsVpcPeeredRequest.Builder
to create a request.- Returns:
- Result of the IsVpcPeered operation returned by the service.
- See Also:
-
isVpcPeered
default IsVpcPeeredResponse isVpcPeered() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionReturns a Boolean value indicating whether your Lightsail VPC is peered.
- Returns:
- Result of the IsVpcPeered operation returned by the service.
- See Also:
-
openInstancePublicPorts
default OpenInstancePublicPortsResponse openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.
The
OpenInstancePublicPorts
action supports tag-based access control via resource tags applied to the resource identified byinstanceName
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
openInstancePublicPortsRequest
-- Returns:
- Result of the OpenInstancePublicPorts operation returned by the service.
- See Also:
-
openInstancePublicPorts
default OpenInstancePublicPortsResponse openInstancePublicPorts(Consumer<OpenInstancePublicPortsRequest.Builder> openInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.
The
OpenInstancePublicPorts
action supports tag-based access control via resource tags applied to the resource identified byinstanceName
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
OpenInstancePublicPortsRequest.Builder
avoiding the need to create one manually viaOpenInstancePublicPortsRequest.builder()
- Parameters:
openInstancePublicPortsRequest
- AConsumer
that will call methods onOpenInstancePublicPortsRequest.Builder
to create a request.- Returns:
- Result of the OpenInstancePublicPorts operation returned by the service.
- See Also:
-
peerVpc
default PeerVpcResponse peerVpc(PeerVpcRequest peerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Peers the Lightsail VPC with the user's default VPC.
- Parameters:
peerVpcRequest
-- Returns:
- Result of the PeerVpc operation returned by the service.
- See Also:
-
peerVpc
default PeerVpcResponse peerVpc(Consumer<PeerVpcRequest.Builder> peerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Peers the Lightsail VPC with the user's default VPC.
This is a convenience which creates an instance of the
PeerVpcRequest.Builder
avoiding the need to create one manually viaPeerVpcRequest.builder()
- Parameters:
peerVpcRequest
- AConsumer
that will call methods onPeerVpcRequest.Builder
to create a request.- Returns:
- Result of the PeerVpc operation returned by the service.
- See Also:
-
peerVpc
default PeerVpcResponse peerVpc() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionPeers the Lightsail VPC with the user's default VPC.
- Returns:
- Result of the PeerVpc operation returned by the service.
- See Also:
-
putAlarm
default PutAlarmResponse putAlarm(PutAlarmRequest putAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, AccessDeniedException, UnauthenticatedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException Creates or updates an alarm, and associates it with the specified metric.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
When this action creates an alarm, the alarm state is immediately set to
INSUFFICIENT_DATA
. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
- Parameters:
putAlarmRequest
-- Returns:
- Result of the PutAlarm operation returned by the service.
- See Also:
-
putAlarm
default PutAlarmResponse putAlarm(Consumer<PutAlarmRequest.Builder> putAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, AccessDeniedException, UnauthenticatedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException Creates or updates an alarm, and associates it with the specified metric.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
When this action creates an alarm, the alarm state is immediately set to
INSUFFICIENT_DATA
. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
This is a convenience which creates an instance of the
PutAlarmRequest.Builder
avoiding the need to create one manually viaPutAlarmRequest.builder()
- Parameters:
putAlarmRequest
- AConsumer
that will call methods onPutAlarmRequest.Builder
to create a request.- Returns:
- Result of the PutAlarm operation returned by the service.
- See Also:
-
putInstancePublicPorts
default PutInstancePublicPortsResponse putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your
PutInstancePublicPorts
request. Or use theOpenInstancePublicPorts
action to open ports without closing currently open ports.The
PutInstancePublicPorts
action supports tag-based access control via resource tags applied to the resource identified byinstanceName
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
putInstancePublicPortsRequest
-- Returns:
- Result of the PutInstancePublicPorts operation returned by the service.
- See Also:
-
putInstancePublicPorts
default PutInstancePublicPortsResponse putInstancePublicPorts(Consumer<PutInstancePublicPortsRequest.Builder> putInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your
PutInstancePublicPorts
request. Or use theOpenInstancePublicPorts
action to open ports without closing currently open ports.The
PutInstancePublicPorts
action supports tag-based access control via resource tags applied to the resource identified byinstanceName
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
PutInstancePublicPortsRequest.Builder
avoiding the need to create one manually viaPutInstancePublicPortsRequest.builder()
- Parameters:
putInstancePublicPortsRequest
- AConsumer
that will call methods onPutInstancePublicPortsRequest.Builder
to create a request.- Returns:
- Result of the PutInstancePublicPorts operation returned by the service.
- See Also:
-
rebootInstance
default RebootInstanceResponse rebootInstance(RebootInstanceRequest rebootInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Restarts a specific instance.
The
reboot instance
operation supports tag-based access control via resource tags applied to the resource identified byinstance name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
rebootInstanceRequest
-- Returns:
- Result of the RebootInstance operation returned by the service.
- See Also:
-
rebootInstance
default RebootInstanceResponse rebootInstance(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Restarts a specific instance.
The
reboot instance
operation supports tag-based access control via resource tags applied to the resource identified byinstance name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
RebootInstanceRequest.Builder
avoiding the need to create one manually viaRebootInstanceRequest.builder()
- Parameters:
rebootInstanceRequest
- AConsumer
that will call methods onRebootInstanceRequest.Builder
to create a request.- Returns:
- Result of the RebootInstance operation returned by the service.
- See Also:
-
rebootRelationalDatabase
default RebootRelationalDatabaseResponse rebootRelationalDatabase(RebootRelationalDatabaseRequest rebootRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Restarts a specific database in Amazon Lightsail.
The
reboot relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
rebootRelationalDatabaseRequest
-- Returns:
- Result of the RebootRelationalDatabase operation returned by the service.
- See Also:
-
rebootRelationalDatabase
default RebootRelationalDatabaseResponse rebootRelationalDatabase(Consumer<RebootRelationalDatabaseRequest.Builder> rebootRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Restarts a specific database in Amazon Lightsail.
The
reboot relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
RebootRelationalDatabaseRequest.Builder
avoiding the need to create one manually viaRebootRelationalDatabaseRequest.builder()
- Parameters:
rebootRelationalDatabaseRequest
- AConsumer
that will call methods onRebootRelationalDatabaseRequest.Builder
to create a request.- Returns:
- Result of the RebootRelationalDatabase operation returned by the service.
- See Also:
-
registerContainerImage
default RegisterContainerImageResponse registerContainerImage(RegisterContainerImageRequest registerContainerImageRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Registers a container image to your Amazon Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
- Parameters:
registerContainerImageRequest
-- Returns:
- Result of the RegisterContainerImage operation returned by the service.
- See Also:
-
registerContainerImage
default RegisterContainerImageResponse registerContainerImage(Consumer<RegisterContainerImageRequest.Builder> registerContainerImageRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Registers a container image to your Amazon Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
RegisterContainerImageRequest.Builder
avoiding the need to create one manually viaRegisterContainerImageRequest.builder()
- Parameters:
registerContainerImageRequest
- AConsumer
that will call methods onRegisterContainerImageRequest.Builder
to create a request.- Returns:
- Result of the RegisterContainerImage operation returned by the service.
- See Also:
-
releaseStaticIp
default ReleaseStaticIpResponse releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes a specific static IP from your account.
- Parameters:
releaseStaticIpRequest
-- Returns:
- Result of the ReleaseStaticIp operation returned by the service.
- See Also:
-
releaseStaticIp
default ReleaseStaticIpResponse releaseStaticIp(Consumer<ReleaseStaticIpRequest.Builder> releaseStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes a specific static IP from your account.
This is a convenience which creates an instance of the
ReleaseStaticIpRequest.Builder
avoiding the need to create one manually viaReleaseStaticIpRequest.builder()
- Parameters:
releaseStaticIpRequest
- AConsumer
that will call methods onReleaseStaticIpRequest.Builder
to create a request.- Returns:
- Result of the ReleaseStaticIp operation returned by the service.
- See Also:
-
resetDistributionCache
default ResetDistributionCacheResponse resetDistributionCache(ResetDistributionCacheRequest resetDistributionCacheRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.
- Parameters:
resetDistributionCacheRequest
-- Returns:
- Result of the ResetDistributionCache operation returned by the service.
- See Also:
-
resetDistributionCache
default ResetDistributionCacheResponse resetDistributionCache(Consumer<ResetDistributionCacheRequest.Builder> resetDistributionCacheRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.
This is a convenience which creates an instance of the
ResetDistributionCacheRequest.Builder
avoiding the need to create one manually viaResetDistributionCacheRequest.builder()
- Parameters:
resetDistributionCacheRequest
- AConsumer
that will call methods onResetDistributionCacheRequest.Builder
to create a request.- Returns:
- Result of the ResetDistributionCache operation returned by the service.
- See Also:
-
sendContactMethodVerification
default SendContactMethodVerificationResponse sendContactMethodVerification(SendContactMethodVerificationRequest sendContactMethodVerificationRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.
Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
- Parameters:
sendContactMethodVerificationRequest
-- Returns:
- Result of the SendContactMethodVerification operation returned by the service.
- See Also:
-
sendContactMethodVerification
default SendContactMethodVerificationResponse sendContactMethodVerification(Consumer<SendContactMethodVerificationRequest.Builder> sendContactMethodVerificationRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.
Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
This is a convenience which creates an instance of the
SendContactMethodVerificationRequest.Builder
avoiding the need to create one manually viaSendContactMethodVerificationRequest.builder()
- Parameters:
sendContactMethodVerificationRequest
- AConsumer
that will call methods onSendContactMethodVerificationRequest.Builder
to create a request.- Returns:
- Result of the SendContactMethodVerification operation returned by the service.
- See Also:
-
setIpAddressType
default SetIpAddressTypeResponse setIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Sets the IP address type for an Amazon Lightsail resource.
Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.
- Parameters:
setIpAddressTypeRequest
-- Returns:
- Result of the SetIpAddressType operation returned by the service.
- See Also:
-
setIpAddressType
default SetIpAddressTypeResponse setIpAddressType(Consumer<SetIpAddressTypeRequest.Builder> setIpAddressTypeRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Sets the IP address type for an Amazon Lightsail resource.
Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.
This is a convenience which creates an instance of the
SetIpAddressTypeRequest.Builder
avoiding the need to create one manually viaSetIpAddressTypeRequest.builder()
- Parameters:
setIpAddressTypeRequest
- AConsumer
that will call methods onSetIpAddressTypeRequest.Builder
to create a request.- Returns:
- Result of the SetIpAddressType operation returned by the service.
- See Also:
-
setResourceAccessForBucket
default SetResourceAccessForBucketResponse setResourceAccessForBucket(SetResourceAccessForBucketRequest setResourceAccessForBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.
- Parameters:
setResourceAccessForBucketRequest
-- Returns:
- Result of the SetResourceAccessForBucket operation returned by the service.
- See Also:
-
setResourceAccessForBucket
default SetResourceAccessForBucketResponse setResourceAccessForBucket(Consumer<SetResourceAccessForBucketRequest.Builder> setResourceAccessForBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.
This is a convenience which creates an instance of the
SetResourceAccessForBucketRequest.Builder
avoiding the need to create one manually viaSetResourceAccessForBucketRequest.builder()
- Parameters:
setResourceAccessForBucketRequest
- AConsumer
that will call methods onSetResourceAccessForBucketRequest.Builder
to create a request.- Returns:
- Result of the SetResourceAccessForBucket operation returned by the service.
- See Also:
-
setupInstanceHttps
default SetupInstanceHttpsResponse setupInstanceHttps(SetupInstanceHttpsRequest setupInstanceHttpsRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance.
If you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length.
- Parameters:
setupInstanceHttpsRequest
-- Returns:
- Result of the SetupInstanceHttps operation returned by the service.
- See Also:
-
setupInstanceHttps
default SetupInstanceHttpsResponse setupInstanceHttps(Consumer<SetupInstanceHttpsRequest.Builder> setupInstanceHttpsRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Creates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance.
If you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length.
This is a convenience which creates an instance of the
SetupInstanceHttpsRequest.Builder
avoiding the need to create one manually viaSetupInstanceHttpsRequest.builder()
- Parameters:
setupInstanceHttpsRequest
- AConsumer
that will call methods onSetupInstanceHttpsRequest.Builder
to create a request.- Returns:
- Result of the SetupInstanceHttps operation returned by the service.
- See Also:
-
startGUISession
default StartGuiSessionResponse startGUISession(StartGuiSessionRequest startGuiSessionRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.
- Parameters:
startGuiSessionRequest
-- Returns:
- Result of the StartGUISession operation returned by the service.
- See Also:
-
startGUISession
default StartGuiSessionResponse startGUISession(Consumer<StartGuiSessionRequest.Builder> startGuiSessionRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.
This is a convenience which creates an instance of the
StartGuiSessionRequest.Builder
avoiding the need to create one manually viaStartGuiSessionRequest.builder()
- Parameters:
startGuiSessionRequest
- AConsumer
that will call methods onStartGuiSessionRequest.Builder
to create a request.- Returns:
- Result of the StartGUISession operation returned by the service.
- See Also:
-
startInstance
default StartInstanceResponse startInstance(StartInstanceRequest startInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the
reboot instance
operation.When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The
start instance
operation supports tag-based access control via resource tags applied to the resource identified byinstance name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
startInstanceRequest
-- Returns:
- Result of the StartInstance operation returned by the service.
- See Also:
-
startInstance
default StartInstanceResponse startInstance(Consumer<StartInstanceRequest.Builder> startInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the
reboot instance
operation.When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The
start instance
operation supports tag-based access control via resource tags applied to the resource identified byinstance name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
StartInstanceRequest.Builder
avoiding the need to create one manually viaStartInstanceRequest.builder()
- Parameters:
startInstanceRequest
- AConsumer
that will call methods onStartInstanceRequest.Builder
to create a request.- Returns:
- Result of the StartInstance operation returned by the service.
- See Also:
-
startRelationalDatabase
default StartRelationalDatabaseResponse startRelationalDatabase(StartRelationalDatabaseRequest startRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the
reboot relational database
operation.The
start relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
startRelationalDatabaseRequest
-- Returns:
- Result of the StartRelationalDatabase operation returned by the service.
- See Also:
-
startRelationalDatabase
default StartRelationalDatabaseResponse startRelationalDatabase(Consumer<StartRelationalDatabaseRequest.Builder> startRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the
reboot relational database
operation.The
start relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
StartRelationalDatabaseRequest.Builder
avoiding the need to create one manually viaStartRelationalDatabaseRequest.builder()
- Parameters:
startRelationalDatabaseRequest
- AConsumer
that will call methods onStartRelationalDatabaseRequest.Builder
to create a request.- Returns:
- Result of the StartRelationalDatabase operation returned by the service.
- See Also:
-
stopGUISession
default StopGuiSessionResponse stopGUISession(StopGuiSessionRequest stopGuiSessionRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.
- Parameters:
stopGuiSessionRequest
-- Returns:
- Result of the StopGUISession operation returned by the service.
- See Also:
-
stopGUISession
default StopGuiSessionResponse stopGUISession(Consumer<StopGuiSessionRequest.Builder> stopGuiSessionRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.
This is a convenience which creates an instance of the
StopGuiSessionRequest.Builder
avoiding the need to create one manually viaStopGuiSessionRequest.builder()
- Parameters:
stopGuiSessionRequest
- AConsumer
that will call methods onStopGuiSessionRequest.Builder
to create a request.- Returns:
- Result of the StopGUISession operation returned by the service.
- See Also:
-
stopInstance
default StopInstanceResponse stopInstance(StopInstanceRequest stopInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Stops a specific Amazon Lightsail instance that is currently running.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The
stop instance
operation supports tag-based access control via resource tags applied to the resource identified byinstance name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
stopInstanceRequest
-- Returns:
- Result of the StopInstance operation returned by the service.
- See Also:
-
stopInstance
default StopInstanceResponse stopInstance(Consumer<StopInstanceRequest.Builder> stopInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Stops a specific Amazon Lightsail instance that is currently running.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The
stop instance
operation supports tag-based access control via resource tags applied to the resource identified byinstance name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
StopInstanceRequest.Builder
avoiding the need to create one manually viaStopInstanceRequest.builder()
- Parameters:
stopInstanceRequest
- AConsumer
that will call methods onStopInstanceRequest.Builder
to create a request.- Returns:
- Result of the StopInstance operation returned by the service.
- See Also:
-
stopRelationalDatabase
default StopRelationalDatabaseResponse stopRelationalDatabase(StopRelationalDatabaseRequest stopRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Stops a specific database that is currently running in Amazon Lightsail.
The
stop relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
stopRelationalDatabaseRequest
-- Returns:
- Result of the StopRelationalDatabase operation returned by the service.
- See Also:
-
stopRelationalDatabase
default StopRelationalDatabaseResponse stopRelationalDatabase(Consumer<StopRelationalDatabaseRequest.Builder> stopRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Stops a specific database that is currently running in Amazon Lightsail.
The
stop relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
StopRelationalDatabaseRequest.Builder
avoiding the need to create one manually viaStopRelationalDatabaseRequest.builder()
- Parameters:
stopRelationalDatabaseRequest
- AConsumer
that will call methods onStopRelationalDatabaseRequest.Builder
to create a request.- Returns:
- Result of the StopRelationalDatabase operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide.
The
tag resource
operation supports tag-based access control via request tags and resource tags applied to the resource identified byresource name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide.
The
tag resource
operation supports tag-based access control via request tags and resource tags applied to the resource identified byresource name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
testAlarm
default TestAlarmResponse testAlarm(TestAlarmRequest testAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (
Email
and/orSMS
) configured for the alarm.An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
- Parameters:
testAlarmRequest
-- Returns:
- Result of the TestAlarm operation returned by the service.
- See Also:
-
testAlarm
default TestAlarmResponse testAlarm(Consumer<TestAlarmRequest.Builder> testAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (
Email
and/orSMS
) configured for the alarm.An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
This is a convenience which creates an instance of the
TestAlarmRequest.Builder
avoiding the need to create one manually viaTestAlarmRequest.builder()
- Parameters:
testAlarmRequest
- AConsumer
that will call methods onTestAlarmRequest.Builder
to create a request.- Returns:
- Result of the TestAlarm operation returned by the service.
- See Also:
-
unpeerVpc
default UnpeerVpcResponse unpeerVpc(UnpeerVpcRequest unpeerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Unpeers the Lightsail VPC from the user's default VPC.
- Parameters:
unpeerVpcRequest
-- Returns:
- Result of the UnpeerVpc operation returned by the service.
- See Also:
-
unpeerVpc
default UnpeerVpcResponse unpeerVpc(Consumer<UnpeerVpcRequest.Builder> unpeerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Unpeers the Lightsail VPC from the user's default VPC.
This is a convenience which creates an instance of the
UnpeerVpcRequest.Builder
avoiding the need to create one manually viaUnpeerVpcRequest.builder()
- Parameters:
unpeerVpcRequest
- AConsumer
that will call methods onUnpeerVpcRequest.Builder
to create a request.- Returns:
- Result of the UnpeerVpc operation returned by the service.
- See Also:
-
unpeerVpc
default UnpeerVpcResponse unpeerVpc() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailExceptionUnpeers the Lightsail VPC from the user's default VPC.
- Returns:
- Result of the UnpeerVpc operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
The
untag resource
operation supports tag-based access control via request tags and resource tags applied to the resource identified byresource name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
The
untag resource
operation supports tag-based access control via request tags and resource tags applied to the resource identified byresource name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateBucket
default UpdateBucketResponse updateBucket(UpdateBucketRequest updateBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates an existing Amazon Lightsail bucket.
Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.
- Parameters:
updateBucketRequest
-- Returns:
- Result of the UpdateBucket operation returned by the service.
- See Also:
-
updateBucket
default UpdateBucketResponse updateBucket(Consumer<UpdateBucketRequest.Builder> updateBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates an existing Amazon Lightsail bucket.
Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.
This is a convenience which creates an instance of the
UpdateBucketRequest.Builder
avoiding the need to create one manually viaUpdateBucketRequest.builder()
- Parameters:
updateBucketRequest
- AConsumer
that will call methods onUpdateBucketRequest.Builder
to create a request.- Returns:
- Result of the UpdateBucket operation returned by the service.
- See Also:
-
updateBucketBundle
default UpdateBucketBundleResponse updateBucketBundle(UpdateBucketBundleRequest updateBucketBundleRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The
ableToUpdateBundle
parameter in the response will indicate whether you can currently update a bucket's bundle.Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.
- Parameters:
updateBucketBundleRequest
-- Returns:
- Result of the UpdateBucketBundle operation returned by the service.
- See Also:
-
updateBucketBundle
default UpdateBucketBundleResponse updateBucketBundle(Consumer<UpdateBucketBundleRequest.Builder> updateBucketBundleRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The
ableToUpdateBundle
parameter in the response will indicate whether you can currently update a bucket's bundle.Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.
This is a convenience which creates an instance of the
UpdateBucketBundleRequest.Builder
avoiding the need to create one manually viaUpdateBucketBundleRequest.builder()
- Parameters:
updateBucketBundleRequest
- AConsumer
that will call methods onUpdateBucketBundleRequest.Builder
to create a request.- Returns:
- Result of the UpdateBucketBundle operation returned by the service.
- See Also:
-
updateContainerService
default UpdateContainerServiceResponse updateContainerService(UpdateContainerServiceRequest updateContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
- Parameters:
updateContainerServiceRequest
-- Returns:
- Result of the UpdateContainerService operation returned by the service.
- See Also:
-
updateContainerService
default UpdateContainerServiceResponse updateContainerService(Consumer<UpdateContainerServiceRequest.Builder> updateContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
This is a convenience which creates an instance of the
UpdateContainerServiceRequest.Builder
avoiding the need to create one manually viaUpdateContainerServiceRequest.builder()
- Parameters:
updateContainerServiceRequest
- AConsumer
that will call methods onUpdateContainerServiceRequest.Builder
to create a request.- Returns:
- Result of the UpdateContainerService operation returned by the service.
- See Also:
-
updateDistribution
default UpdateDistributionResponse updateDistribution(UpdateDistributionRequest updateDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distribution.
- Parameters:
updateDistributionRequest
-- Returns:
- Result of the UpdateDistribution operation returned by the service.
- See Also:
-
updateDistribution
default UpdateDistributionResponse updateDistribution(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distribution.
This is a convenience which creates an instance of the
UpdateDistributionRequest.Builder
avoiding the need to create one manually viaUpdateDistributionRequest.builder()
- Parameters:
updateDistributionRequest
- AConsumer
that will call methods onUpdateDistributionRequest.Builder
to create a request.- Returns:
- Result of the UpdateDistribution operation returned by the service.
- See Also:
-
updateDistributionBundle
default UpdateDistributionBundleResponse updateDistributionBundle(UpdateDistributionBundleRequest updateDistributionBundleRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.
You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the
GetDistributions
action. TheableToUpdateBundle
parameter in the result will indicate whether you can currently update your distribution's bundle.- Parameters:
updateDistributionBundleRequest
-- Returns:
- Result of the UpdateDistributionBundle operation returned by the service.
- See Also:
-
updateDistributionBundle
default UpdateDistributionBundleResponse updateDistributionBundle(Consumer<UpdateDistributionBundleRequest.Builder> updateDistributionBundleRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.
You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the
GetDistributions
action. TheableToUpdateBundle
parameter in the result will indicate whether you can currently update your distribution's bundle.
This is a convenience which creates an instance of the
UpdateDistributionBundleRequest.Builder
avoiding the need to create one manually viaUpdateDistributionBundleRequest.builder()
- Parameters:
updateDistributionBundleRequest
- AConsumer
that will call methods onUpdateDistributionBundleRequest.Builder
to create a request.- Returns:
- Result of the UpdateDistributionBundle operation returned by the service.
- See Also:
-
updateDomainEntry
default UpdateDomainEntryResponse updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates a domain recordset after it is created.
The
update domain entry
operation supports tag-based access control via resource tags applied to the resource identified bydomain name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
updateDomainEntryRequest
-- Returns:
- Result of the UpdateDomainEntry operation returned by the service.
- See Also:
-
updateDomainEntry
default UpdateDomainEntryResponse updateDomainEntry(Consumer<UpdateDomainEntryRequest.Builder> updateDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates a domain recordset after it is created.
The
update domain entry
operation supports tag-based access control via resource tags applied to the resource identified bydomain name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
UpdateDomainEntryRequest.Builder
avoiding the need to create one manually viaUpdateDomainEntryRequest.builder()
- Parameters:
updateDomainEntryRequest
- AConsumer
that will call methods onUpdateDomainEntryRequest.Builder
to create a request.- Returns:
- Result of the UpdateDomainEntry operation returned by the service.
- See Also:
-
updateInstanceMetadataOptions
default UpdateInstanceMetadataOptionsResponse updateInstanceMetadataOptions(UpdateInstanceMetadataOptionsRequest updateInstanceMetadataOptionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the
GetInstance
orGetInstances
API operation initially responds with a state ofpending
. After the parameter modifications are successfully applied, the state changes toapplied
in subsequentGetInstance
orGetInstances
API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.- Parameters:
updateInstanceMetadataOptionsRequest
-- Returns:
- Result of the UpdateInstanceMetadataOptions operation returned by the service.
- See Also:
-
updateInstanceMetadataOptions
default UpdateInstanceMetadataOptionsResponse updateInstanceMetadataOptions(Consumer<UpdateInstanceMetadataOptionsRequest.Builder> updateInstanceMetadataOptionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the
GetInstance
orGetInstances
API operation initially responds with a state ofpending
. After the parameter modifications are successfully applied, the state changes toapplied
in subsequentGetInstance
orGetInstances
API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
UpdateInstanceMetadataOptionsRequest.Builder
avoiding the need to create one manually viaUpdateInstanceMetadataOptionsRequest.builder()
- Parameters:
updateInstanceMetadataOptionsRequest
- AConsumer
that will call methods onUpdateInstanceMetadataOptionsRequest.Builder
to create a request.- Returns:
- Result of the UpdateInstanceMetadataOptions operation returned by the service.
- See Also:
-
updateLoadBalancerAttribute
default UpdateLoadBalancerAttributeResponse updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest updateLoadBalancerAttributeRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates the specified attribute for a load balancer. You can only update one attribute at a time.
The
update load balancer attribute
operation supports tag-based access control via resource tags applied to the resource identified byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
updateLoadBalancerAttributeRequest
-- Returns:
- Result of the UpdateLoadBalancerAttribute operation returned by the service.
- See Also:
-
updateLoadBalancerAttribute
default UpdateLoadBalancerAttributeResponse updateLoadBalancerAttribute(Consumer<UpdateLoadBalancerAttributeRequest.Builder> updateLoadBalancerAttributeRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Updates the specified attribute for a load balancer. You can only update one attribute at a time.
The
update load balancer attribute
operation supports tag-based access control via resource tags applied to the resource identified byload balancer name
. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
UpdateLoadBalancerAttributeRequest.Builder
avoiding the need to create one manually viaUpdateLoadBalancerAttributeRequest.builder()
- Parameters:
updateLoadBalancerAttributeRequest
- AConsumer
that will call methods onUpdateLoadBalancerAttributeRequest.Builder
to create a request.- Returns:
- Result of the UpdateLoadBalancerAttribute operation returned by the service.
- See Also:
-
updateRelationalDatabase
default UpdateRelationalDatabaseResponse updateRelationalDatabase(UpdateRelationalDatabaseRequest updateRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Allows the update of one or more attributes of a database in Amazon Lightsail.
Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.
The
update relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
updateRelationalDatabaseRequest
-- Returns:
- Result of the UpdateRelationalDatabase operation returned by the service.
- See Also:
-
updateRelationalDatabase
default UpdateRelationalDatabaseResponse updateRelationalDatabase(Consumer<UpdateRelationalDatabaseRequest.Builder> updateRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Allows the update of one or more attributes of a database in Amazon Lightsail.
Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.
The
update relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
UpdateRelationalDatabaseRequest.Builder
avoiding the need to create one manually viaUpdateRelationalDatabaseRequest.builder()
- Parameters:
updateRelationalDatabaseRequest
- AConsumer
that will call methods onUpdateRelationalDatabaseRequest.Builder
to create a request.- Returns:
- Result of the UpdateRelationalDatabase operation returned by the service.
- See Also:
-
updateRelationalDatabaseParameters
default UpdateRelationalDatabaseParametersResponse updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest updateRelationalDatabaseParametersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Allows the update of one or more parameters of a database in Amazon Lightsail.
Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied:
dynamic
orpending-reboot
. Parameters marked with adynamic
apply type are applied immediately. Parameters marked with apending-reboot
apply type are applied only after the database is rebooted using thereboot relational database
operation.The
update relational database parameters
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.- Parameters:
updateRelationalDatabaseParametersRequest
-- Returns:
- Result of the UpdateRelationalDatabaseParameters operation returned by the service.
- See Also:
-
updateRelationalDatabaseParameters
default UpdateRelationalDatabaseParametersResponse updateRelationalDatabaseParameters(Consumer<UpdateRelationalDatabaseParametersRequest.Builder> updateRelationalDatabaseParametersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException Allows the update of one or more parameters of a database in Amazon Lightsail.
Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied:
dynamic
orpending-reboot
. Parameters marked with adynamic
apply type are applied immediately. Parameters marked with apending-reboot
apply type are applied only after the database is rebooted using thereboot relational database
operation.The
update relational database parameters
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
UpdateRelationalDatabaseParametersRequest.Builder
avoiding the need to create one manually viaUpdateRelationalDatabaseParametersRequest.builder()
- Parameters:
updateRelationalDatabaseParametersRequest
- AConsumer
that will call methods onUpdateRelationalDatabaseParametersRequest.Builder
to create a request.- Returns:
- Result of the UpdateRelationalDatabaseParameters operation returned by the service.
- See Also:
-
create
Create aLightsailClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aLightsailClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-