Lightsail class

Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.

You can manage your Lightsail resources using the Lightsail console, Lightsail API, AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported AWS Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the AWS General Reference.

Constructors

Lightsail({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

allocateStaticIp({required String staticIpName}) → Future<AllocateStaticIpResult>

Allocates a static IP address.

attachCertificateToDistribution({required String certificateName, required String distributionName}) → Future<AttachCertificateToDistributionResult>

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.

attachDisk({required String diskName, required String diskPath, required String instanceName}) → Future<AttachDiskResult>

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.

attachInstancesToLoadBalancer({required List<String> instanceNames, required String loadBalancerName}) → Future<AttachInstancesToLoadBalancerResult>

Attaches one or more Lightsail instances to a load balancer.

attachLoadBalancerTlsCertificate({required String certificateName, required String loadBalancerName}) → Future<AttachLoadBalancerTlsCertificateResult>

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).

attachStaticIp({required String instanceName, required String staticIpName}) → Future<AttachStaticIpResult>

Attaches a static IP address to a specific Amazon Lightsail instance.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

closeInstancePublicPorts({required String instanceName, required PortInfo portInfo}) → Future<CloseInstancePublicPortsResult>

Closes ports for a specific Amazon Lightsail instance.

copySnapshot({required RegionName sourceRegion, required String targetSnapshotName, String? restoreDate, String? sourceResourceName, String? sourceSnapshotName, bool? useLatestRestorableAutoSnapshot}) → Future<CopySnapshotResult>

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.

createCertificate({required String certificateName, required String domainName, List<String>? subjectAlternativeNames, List<Tag>? tags}) → Future<CreateCertificateResult>

Creates an SSL/TLS certificate for a Amazon Lightsail content delivery network (CDN) distribution.

createCloudFormationStack({required List<InstanceEntry> instances}) → Future<CreateCloudFormationStackResult>

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.

createContactMethod({required String contactEndpoint, required ContactProtocol protocol}) → Future<CreateContactMethodResult>

Creates an email or SMS text message contact method.

createContainerService({required ContainerServicePowerName power, required int scale, required String serviceName, ContainerServiceDeploymentRequest? deployment, Map<String, List<String>>? publicDomainNames, List<Tag>? tags}) → Future<CreateContainerServiceResult>

Creates an Amazon Lightsail container service.

createContainerServiceDeployment({required String serviceName, Map<String, Container>? containers, EndpointRequest? publicEndpoint}) → Future<CreateContainerServiceDeploymentResult>

Creates a deployment for your Amazon Lightsail container service.

createContainerServiceRegistryLogin() → Future<CreateContainerServiceRegistryLoginResult>

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. 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.

createDisk({required String availabilityZone, required String diskName, required int sizeInGb, List<AddOnRequest>? addOns, List<Tag>? tags}) → Future<CreateDiskResult>

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

createDiskFromSnapshot({required String availabilityZone, required String diskName, required int sizeInGb, List<AddOnRequest>? addOns, String? diskSnapshotName, String? restoreDate, String? sourceDiskName, List<Tag>? tags, bool? useLatestRestorableAutoSnapshot}) → Future<CreateDiskFromSnapshotResult>

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

createDiskSnapshot({required String diskSnapshotName, String? diskName, String? instanceName, List<Tag>? tags}) → Future<CreateDiskSnapshotResult>

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.

createDistribution({required String bundleId, required CacheBehavior defaultCacheBehavior, required String distributionName, required InputOrigin origin, CacheSettings? cacheBehaviorSettings, List<CacheBehaviorPerPath>? cacheBehaviors, List<Tag>? tags}) → Future<CreateDistributionResult>

Creates an Amazon Lightsail content delivery network (CDN) distribution.

createDomain({required String domainName, List<Tag>? tags}) → Future<CreateDomainResult>

Creates a domain resource for the specified domain (e.g., example.com).

createDomainEntry({required DomainEntry domainEntry, required String domainName}) → Future<CreateDomainEntryResult>

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).

createInstances({required String availabilityZone, required String blueprintId, required String bundleId, required List<String> instanceNames, List<AddOnRequest>? addOns, String? customImageName, String? keyPairName, List<Tag>? tags, String? userData}) → Future<CreateInstancesResult>

Creates one or more Amazon Lightsail instances.

createInstancesFromSnapshot({required String availabilityZone, required String bundleId, required List<String> instanceNames, List<AddOnRequest>? addOns, Map<String, List<DiskMap>>? attachedDiskMapping, String? instanceSnapshotName, String? keyPairName, String? restoreDate, String? sourceInstanceName, List<Tag>? tags, bool? useLatestRestorableAutoSnapshot, String? userData}) → Future<CreateInstancesFromSnapshotResult>

Creates one or more new instances from a manual or automatic snapshot of an instance.

createInstanceSnapshot({required String instanceName, required String instanceSnapshotName, List<Tag>? tags}) → Future<CreateInstanceSnapshotResult>

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.

createKeyPair({required String keyPairName, List<Tag>? tags}) → Future<CreateKeyPairResult>

Creates an SSH key pair.

createLoadBalancer({required int instancePort, required String loadBalancerName, List<String>? certificateAlternativeNames, String? certificateDomainName, String? certificateName, String? healthCheckPath, List<Tag>? tags}) → Future<CreateLoadBalancerResult>

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.

createLoadBalancerTlsCertificate({required String certificateDomainName, required String certificateName, required String loadBalancerName, List<String>? certificateAlternativeNames, List<Tag>? tags}) → Future<CreateLoadBalancerTlsCertificateResult>

Creates a Lightsail load balancer TLS certificate.

createRelationalDatabase({required String masterDatabaseName, required String masterUsername, required String relationalDatabaseBlueprintId, required String relationalDatabaseBundleId, required String relationalDatabaseName, String? availabilityZone, String? masterUserPassword, String? preferredBackupWindow, String? preferredMaintenanceWindow, bool? publiclyAccessible, List<Tag>? tags}) → Future<CreateRelationalDatabaseResult>

Creates a new database in Amazon Lightsail.

createRelationalDatabaseFromSnapshot({required String relationalDatabaseName, String? availabilityZone, bool? publiclyAccessible, String? relationalDatabaseBundleId, String? relationalDatabaseSnapshotName, DateTime? restoreTime, String? sourceRelationalDatabaseName, List<Tag>? tags, bool? useLatestRestorableTime}) → Future<CreateRelationalDatabaseFromSnapshotResult>

Creates a new database from an existing database snapshot in Amazon Lightsail.

createRelationalDatabaseSnapshot({required String relationalDatabaseName, required String relationalDatabaseSnapshotName, List<Tag>? tags}) → Future<CreateRelationalDatabaseSnapshotResult>

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.

deleteAlarm({required String alarmName}) → Future<DeleteAlarmResult>

Deletes an alarm.

deleteAutoSnapshot({required String date, required String resourceName}) → Future<DeleteAutoSnapshotResult>

Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.

deleteCertificate({required String certificateName}) → Future<DeleteCertificateResult>

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.

deleteContactMethod({required ContactProtocol protocol}) → Future<DeleteContactMethodResult>

Deletes a contact method.

deleteContainerImage({required String image, required String serviceName}) → Future<void>

Deletes a container image that is registered to your Amazon Lightsail container service.

deleteContainerService({required String serviceName}) → Future<void>

Deletes your Amazon Lightsail container service.

deleteDisk({required String diskName, bool? forceDeleteAddOns}) → Future<DeleteDiskResult>

Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance). The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide.

deleteDiskSnapshot({required String diskSnapshotName}) → Future<DeleteDiskSnapshotResult>

Deletes the specified disk snapshot.

deleteDistribution({String? distributionName}) → Future<DeleteDistributionResult>

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

deleteDomain({required String domainName}) → Future<DeleteDomainResult>

Deletes the specified domain recordset and all of its domain records.

deleteDomainEntry({required DomainEntry domainEntry, required String domainName}) → Future<DeleteDomainEntryResult>

Deletes a specific domain entry.

deleteInstance({required String instanceName, bool? forceDeleteAddOns}) → Future<DeleteInstanceResult>

Deletes an Amazon Lightsail instance.

deleteInstanceSnapshot({required String instanceSnapshotName}) → Future<DeleteInstanceSnapshotResult>

Deletes a specific snapshot of a virtual private server (or instance).

deleteKeyPair({required String keyPairName}) → Future<DeleteKeyPairResult>

Deletes a specific SSH key pair.

deleteKnownHostKeys({required String instanceName}) → Future<DeleteKnownHostKeysResult>

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.

deleteLoadBalancer({required String loadBalancerName}) → Future<DeleteLoadBalancerResult>

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.

deleteLoadBalancerTlsCertificate({required String certificateName, required String loadBalancerName, bool? force}) → Future<DeleteLoadBalancerTlsCertificateResult>

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

deleteRelationalDatabase({required String relationalDatabaseName, String? finalRelationalDatabaseSnapshotName, bool? skipFinalSnapshot}) → Future<DeleteRelationalDatabaseResult>

Deletes a database in Amazon Lightsail.

deleteRelationalDatabaseSnapshot({required String relationalDatabaseSnapshotName}) → Future<DeleteRelationalDatabaseSnapshotResult>

Deletes a database snapshot in Amazon Lightsail.

detachCertificateFromDistribution({required String distributionName}) → Future<DetachCertificateFromDistributionResult>

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.

detachDisk({required String diskName}) → Future<DetachDiskResult>

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.

detachInstancesFromLoadBalancer({required List<String> instanceNames, required String loadBalancerName}) → Future<DetachInstancesFromLoadBalancerResult>

Detaches the specified instances from a Lightsail load balancer.

detachStaticIp({required String staticIpName}) → Future<DetachStaticIpResult>

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

disableAddOn({required AddOnType addOnType, required String resourceName}) → Future<DisableAddOnResult>

Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.

downloadDefaultKeyPair() → Future<DownloadDefaultKeyPairResult>

Downloads the default SSH key pair from the user's account.

enableAddOn({required AddOnRequest addOnRequest, required String resourceName}) → Future<EnableAddOnResult>

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.

exportSnapshot({required String sourceSnapshotName}) → Future<ExportSnapshotResult>

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.

getActiveNames({String? pageToken}) → Future<GetActiveNamesResult>

Returns the names of all active (not deleted) resources.

getAlarms({String? alarmName, String? monitoredResourceName, String? pageToken}) → Future<GetAlarmsResult>

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.

getAutoSnapshots({required String resourceName}) → Future<GetAutoSnapshotsResult>

Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide.

getBlueprints({bool? includeInactive, String? pageToken}) → Future<GetBlueprintsResult>

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.

getBundles({bool? includeInactive, String? pageToken}) → Future<GetBundlesResult>

Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).

getCertificates({String? certificateName, List<CertificateStatus>? certificateStatuses, bool? includeCertificateDetails}) → Future<GetCertificatesResult>

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

getCloudFormationStackRecords({String? pageToken}) → Future<GetCloudFormationStackRecordsResult>

Returns the CloudFormation stack record created as a result of the create cloud formation stack operation.

getContactMethods({List<ContactProtocol>? protocols}) → Future<GetContactMethodsResult>

Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.

getContainerAPIMetadata() → Future<GetContainerAPIMetadataResult>

Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.

getContainerImages({required String serviceName}) → Future<GetContainerImagesResult>

Returns the container images that are registered to your Amazon Lightsail container service.

getContainerLog({required String containerName, required String serviceName, DateTime? endTime, String? filterPattern, String? pageToken, DateTime? startTime}) → Future<GetContainerLogResult>

Returns the log events of a container of your Amazon Lightsail container service.

getContainerServiceDeployments({required String serviceName}) → Future<GetContainerServiceDeploymentsResult>

Returns the deployments for your Amazon Lightsail container service

getContainerServiceMetricData({required DateTime endTime, required ContainerServiceMetricName metricName, required int period, required String serviceName, required DateTime startTime, required List<MetricStatistic> statistics}) → Future<GetContainerServiceMetricDataResult>

Returns the data points of a specific metric of your Amazon Lightsail container service.

getContainerServicePowers() → Future<GetContainerServicePowersResult>

Returns the list of powers that can be specified for your Amazon Lightsail container services.

getContainerServices({String? serviceName}) → Future<ContainerServicesListResult>

Returns information about one or more of your Amazon Lightsail container services.

getDisk({required String diskName}) → Future<GetDiskResult>

Returns information about a specific block storage disk.

getDisks({String? pageToken}) → Future<GetDisksResult>

Returns information about all block storage disks in your AWS account and region.

getDiskSnapshot({required String diskSnapshotName}) → Future<GetDiskSnapshotResult>

Returns information about a specific block storage disk snapshot.

getDiskSnapshots({String? pageToken}) → Future<GetDiskSnapshotsResult>

Returns information about all block storage disk snapshots in your AWS account and region.

getDistributionBundles() → Future<GetDistributionBundlesResult>

Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions.

getDistributionLatestCacheReset({String? distributionName}) → Future<GetDistributionLatestCacheResetResult>

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.

getDistributionMetricData({required String distributionName, required DateTime endTime, required DistributionMetricName metricName, required int period, required DateTime startTime, required List<MetricStatistic> statistics, required MetricUnit unit}) → Future<GetDistributionMetricDataResult>

Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.

getDistributions({String? distributionName, String? pageToken}) → Future<GetDistributionsResult>

Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.

getDomain({required String domainName}) → Future<GetDomainResult>

Returns information about a specific domain recordset.

getDomains({String? pageToken}) → Future<GetDomainsResult>

Returns a list of all domains in the user's account.

getExportSnapshotRecords({String? pageToken}) → Future<GetExportSnapshotRecordsResult>

Returns the export snapshot record created as a result of the export snapshot operation.

getInstance({required String instanceName}) → Future<GetInstanceResult>

Returns information about a specific Amazon Lightsail instance, which is a virtual private server.

getInstanceAccessDetails({required String instanceName, InstanceAccessProtocol? protocol}) → Future<GetInstanceAccessDetailsResult>

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

getInstanceMetricData({required DateTime endTime, required String instanceName, required InstanceMetricName metricName, required int period, required DateTime startTime, required List<MetricStatistic> statistics, required MetricUnit unit}) → Future<GetInstanceMetricDataResult>

Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.

getInstancePortStates({required String instanceName}) → Future<GetInstancePortStatesResult>

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.

getInstances({String? pageToken}) → Future<GetInstancesResult>

Returns information about all Amazon Lightsail virtual private servers, or instances.

getInstanceSnapshot({required String instanceSnapshotName}) → Future<GetInstanceSnapshotResult>

Returns information about a specific instance snapshot.

getInstanceSnapshots({String? pageToken}) → Future<GetInstanceSnapshotsResult>

Returns all instance snapshots for the user's account.

getInstanceState({required String instanceName}) → Future<GetInstanceStateResult>

Returns the state of a specific instance. Works on one instance at a time.

getKeyPair({required String keyPairName}) → Future<GetKeyPairResult>

Returns information about a specific key pair.

getKeyPairs({String? pageToken}) → Future<GetKeyPairsResult>

Returns information about all key pairs in the user's account.

getLoadBalancer({required String loadBalancerName}) → Future<GetLoadBalancerResult>

Returns information about the specified Lightsail load balancer.

getLoadBalancerMetricData({required DateTime endTime, required String loadBalancerName, required LoadBalancerMetricName metricName, required int period, required DateTime startTime, required List<MetricStatistic> statistics, required MetricUnit unit}) → Future<GetLoadBalancerMetricDataResult>

Returns information about health metrics for your Lightsail load balancer.

getLoadBalancers({String? pageToken}) → Future<GetLoadBalancersResult>

Returns information about all load balancers in an account.

getLoadBalancerTlsCertificates({required String loadBalancerName}) → Future<GetLoadBalancerTlsCertificatesResult>

Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.

getOperation({required String operationId}) → Future<GetOperationResult>

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.

getOperations({String? pageToken}) → Future<GetOperationsResult>

Returns information about all operations.

getOperationsForResource({required String resourceName, String? pageToken}) → Future<GetOperationsForResourceResult>

Gets operations for a specific resource (e.g., an instance or a static IP).

getRegions({bool? includeAvailabilityZones, bool? includeRelationalDatabaseAvailabilityZones}) → Future<GetRegionsResult>

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.

getRelationalDatabase({required String relationalDatabaseName}) → Future<GetRelationalDatabaseResult>

Returns information about a specific database in Amazon Lightsail.

getRelationalDatabaseBlueprints({String? pageToken}) → Future<GetRelationalDatabaseBlueprintsResult>

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.

getRelationalDatabaseBundles({String? pageToken}) → Future<GetRelationalDatabaseBundlesResult>

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.

getRelationalDatabaseEvents({required String relationalDatabaseName, int? durationInMinutes, String? pageToken}) → Future<GetRelationalDatabaseEventsResult>

Returns a list of events for a specific database in Amazon Lightsail.

getRelationalDatabaseLogEvents({required String logStreamName, required String relationalDatabaseName, DateTime? endTime, String? pageToken, bool? startFromHead, DateTime? startTime}) → Future<GetRelationalDatabaseLogEventsResult>

Returns a list of log events for a database in Amazon Lightsail.

getRelationalDatabaseLogStreams({required String relationalDatabaseName}) → Future<GetRelationalDatabaseLogStreamsResult>

Returns a list of available log streams for a specific database in Amazon Lightsail.

getRelationalDatabaseMasterUserPassword({required String relationalDatabaseName, RelationalDatabasePasswordVersion? passwordVersion}) → Future<GetRelationalDatabaseMasterUserPasswordResult>

Returns the current, previous, or pending versions of the master user password for a Lightsail database.

getRelationalDatabaseMetricData({required DateTime endTime, required RelationalDatabaseMetricName metricName, required int period, required String relationalDatabaseName, required DateTime startTime, required List<MetricStatistic> statistics, required MetricUnit unit}) → Future<GetRelationalDatabaseMetricDataResult>

Returns the data points of the specified metric for a database in Amazon Lightsail.

getRelationalDatabaseParameters({required String relationalDatabaseName, String? pageToken}) → Future<GetRelationalDatabaseParametersResult>

Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.

getRelationalDatabases({String? pageToken}) → Future<GetRelationalDatabasesResult>

Returns information about all of your databases in Amazon Lightsail.

getRelationalDatabaseSnapshot({required String relationalDatabaseSnapshotName}) → Future<GetRelationalDatabaseSnapshotResult>

Returns information about a specific database snapshot in Amazon Lightsail.

getRelationalDatabaseSnapshots({String? pageToken}) → Future<GetRelationalDatabaseSnapshotsResult>

Returns information about all of your database snapshots in Amazon Lightsail.

getStaticIp({required String staticIpName}) → Future<GetStaticIpResult>

Returns information about a specific static IP.

getStaticIps({String? pageToken}) → Future<GetStaticIpsResult>

Returns information about all static IPs in the user's account.

importKeyPair({required String keyPairName, required String publicKeyBase64}) → Future<ImportKeyPairResult>

Imports a public SSH key from a specific key pair.

isVpcPeered() → Future<IsVpcPeeredResult>

Returns a Boolean value indicating whether your Lightsail VPC is peered.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

openInstancePublicPorts({required String instanceName, required PortInfo portInfo}) → Future<OpenInstancePublicPortsResult>

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.

peerVpc() → Future<PeerVpcResult>

Tries to peer the Lightsail VPC with the user's default VPC.

putAlarm({required String alarmName, required ComparisonOperator comparisonOperator, required int evaluationPeriods, required MetricName metricName, required String monitoredResourceName, required double threshold, List<ContactProtocol>? contactProtocols, int? datapointsToAlarm, bool? notificationEnabled, List<AlarmState>? notificationTriggers, TreatMissingData? treatMissingData}) → Future<PutAlarmResult>

Creates or updates an alarm, and associates it with the specified metric.

putInstancePublicPorts({required String instanceName, required List<PortInfo> portInfos}) → Future<PutInstancePublicPortsResult>

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 PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports.

rebootInstance({required String instanceName}) → Future<RebootInstanceResult>

Restarts a specific instance.

rebootRelationalDatabase({required String relationalDatabaseName}) → Future<RebootRelationalDatabaseResult>

Restarts a specific database in Amazon Lightsail.

registerContainerImage({required String digest, required String label, required String serviceName}) → Future<RegisterContainerImageResult>

Registers a container image to your Amazon Lightsail container service.

releaseStaticIp({required String staticIpName}) → Future<ReleaseStaticIpResult>

Deletes a specific static IP from your account.

resetDistributionCache({String? distributionName}) → Future<ResetDistributionCacheResult>

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.

sendContactMethodVerification({required ContactMethodVerificationProtocol protocol}) → Future<SendContactMethodVerificationResult>

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.

startInstance({required String instanceName}) → Future<StartInstanceResult>

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation. The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.

startRelationalDatabase({required String relationalDatabaseName}) → Future<StartRelationalDatabaseResult>

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.

stopInstance({required String instanceName, bool? force}) → Future<StopInstanceResult>

Stops a specific Amazon Lightsail instance that is currently running. The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.

stopRelationalDatabase({required String relationalDatabaseName, String? relationalDatabaseSnapshotName}) → Future<StopRelationalDatabaseResult>

Stops a specific database that is currently running in Amazon Lightsail.

tagResource({required String resourceName, required List<Tag> tags, String? resourceArn}) → Future<TagResourceResult>

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide.

testAlarm({required String alarmName, required AlarmState state}) → Future<TestAlarmResult>

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm.

toString() → String

A string representation of this object.

inherited

unpeerVpc() → Future<UnpeerVpcResult>

Attempts to unpeer the Lightsail VPC from the user's default VPC.

untagResource({required String resourceName, required List<String> tagKeys, String? resourceArn}) → Future<UntagResourceResult>

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.

updateContainerService({required String serviceName, bool? isDisabled, ContainerServicePowerName? power, Map<String, List<String>>? publicDomainNames, int? scale}) → Future<UpdateContainerServiceResult>

Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.

updateDistribution({required String distributionName, CacheSettings? cacheBehaviorSettings, List<CacheBehaviorPerPath>? cacheBehaviors, CacheBehavior? defaultCacheBehavior, bool? isEnabled, InputOrigin? origin}) → Future<UpdateDistributionResult>

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

updateDistributionBundle({String? bundleId, String? distributionName}) → Future<UpdateDistributionBundleResult>

Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.

updateDomainEntry({required DomainEntry domainEntry, required String domainName}) → Future<UpdateDomainEntryResult>

Updates a domain recordset after it is created.

updateLoadBalancerAttribute({required LoadBalancerAttributeName attributeName, required String attributeValue, required String loadBalancerName}) → Future<UpdateLoadBalancerAttributeResult>

Updates the specified attribute for a load balancer. You can only update one attribute at a time.

updateRelationalDatabase({required String relationalDatabaseName, bool? applyImmediately, String? caCertificateIdentifier, bool? disableBackupRetention, bool? enableBackupRetention, String? masterUserPassword, String? preferredBackupWindow, String? preferredMaintenanceWindow, bool? publiclyAccessible, bool? rotateMasterUserPassword}) → Future<UpdateRelationalDatabaseResult>

Allows the update of one or more attributes of a database in Amazon Lightsail.

updateRelationalDatabaseParameters({required List<RelationalDatabaseParameter> parameters, required String relationalDatabaseName}) → Future<UpdateRelationalDatabaseParametersResult>

Allows the update of one or more parameters of a database in Amazon Lightsail.

Operators

operator ==(Object other) → bool

The equality operator.

inherited