The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Paws::Lightsail - Perl Interface to AWS Amazon Lightsail

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Lightsail');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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 (http://lightsail.aws.amazon.com/ls/docs/how-to/article/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli).

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 (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the AWS General Reference.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28

METHODS

AllocateStaticIp

StaticIpName => Str

Each argument is described in detail in: Paws::Lightsail::AllocateStaticIp

Returns: a Paws::Lightsail::AllocateStaticIpResult instance

Allocates a static IP address.

AttachCertificateToDistribution

CertificateName => Str
DistributionName => Str

Each argument is described in detail in: Paws::Lightsail::AttachCertificateToDistribution

Returns: a Paws::Lightsail::AttachCertificateToDistributionResult instance

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

After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.

Use the CreateCertificate action to create a certificate that you can attach to your distribution.

Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

AttachDisk

DiskName => Str
DiskPath => Str
InstanceName => Str

Each argument is described in detail in: Paws::Lightsail::AttachDisk

Returns: a Paws::Lightsail::AttachDiskResult instance

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

The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

AttachInstancesToLoadBalancer

InstanceNames => ArrayRef[Str|Undef]
LoadBalancerName => Str

Each argument is described in detail in: Paws::Lightsail::AttachInstancesToLoadBalancer

Returns: a Paws::Lightsail::AttachInstancesToLoadBalancerResult instance

Attaches one or more Lightsail instances to a load balancer.

After some time, the instances are attached to the load balancer and the health check status is available.

The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

AttachLoadBalancerTlsCertificate

CertificateName => Str
LoadBalancerName => Str

Each argument is described in detail in: Paws::Lightsail::AttachLoadBalancerTlsCertificate

Returns: a Paws::Lightsail::AttachLoadBalancerTlsCertificateResult instance

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

Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate.

The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

AttachStaticIp

InstanceName => Str
StaticIpName => Str

Each argument is described in detail in: Paws::Lightsail::AttachStaticIp

Returns: a Paws::Lightsail::AttachStaticIpResult instance

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

CloseInstancePublicPorts

InstanceName => Str
PortInfo => Paws::Lightsail::PortInfo

Each argument is described in detail in: Paws::Lightsail::CloseInstancePublicPorts

Returns: a Paws::Lightsail::CloseInstancePublicPortsResult instance

Closes ports for a specific Amazon Lightsail instance.

The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CopySnapshot

SourceRegion => Str
TargetSnapshotName => Str
[RestoreDate => Str]
[SourceResourceName => Str]
[SourceSnapshotName => Str]
[UseLatestRestorableAutoSnapshot => Bool]

Each argument is described in detail in: Paws::Lightsail::CopySnapshot

Returns: a Paws::Lightsail::CopySnapshotResult instance

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

When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.

When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.

CreateCertificate

CertificateName => Str
DomainName => Str
[SubjectAlternativeNames => ArrayRef[Str|Undef]]
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateCertificate

Returns: a Paws::Lightsail::CreateCertificateResult instance

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

After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service.

Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

CreateCloudFormationStack

Instances => ArrayRef[Paws::Lightsail::InstanceEntry]

Each argument is described in detail in: Paws::Lightsail::CreateCloudFormationStack

Returns: a Paws::Lightsail::CreateCloudFormationStackResult instance

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.

CreateContactMethod

ContactEndpoint => Str
Protocol => Str

Each argument is described in detail in: Paws::Lightsail::CreateContactMethod

Returns: a Paws::Lightsail::CreateContactMethodResult instance

Creates an email or SMS text message contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).

CreateContainerService

Power => Str
Scale => Int
ServiceName => Str
[Deployment => Paws::Lightsail::ContainerServiceDeploymentRequest]
[PublicDomainNames => Paws::Lightsail::ContainerServicePublicDomains]
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateContainerService

Returns: a Paws::Lightsail::CreateContainerServiceResult instance

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 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-services) in the Lightsail Dev Guide.

CreateContainerServiceDeployment

ServiceName => Str
[Containers => Paws::Lightsail::ContainerMap]
[PublicEndpoint => Paws::Lightsail::EndpointRequest]

Each argument is described in detail in: Paws::Lightsail::CreateContainerServiceDeployment

Returns: a Paws::Lightsail::CreateContainerServiceDeploymentResult instance

Creates a deployment for your Amazon Lightsail container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

You can deploy containers to your container service using container images from a public registry like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-container-images) in the Lightsail Dev Guide.

CreateContainerServiceRegistryLogin

Each argument is described in detail in: Paws::Lightsail::CreateContainerServiceRegistryLogin

Returns: a Paws::Lightsail::CreateContainerServiceRegistryLoginResult instance

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 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images) in the Lightsail Dev Guide.

CreateDisk

AvailabilityZone => Str
DiskName => Str
SizeInGb => Int
[AddOns => ArrayRef[Paws::Lightsail::AddOnRequest]]
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateDisk

Returns: a Paws::Lightsail::CreateDiskResult instance

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

The create disk operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateDiskFromSnapshot

AvailabilityZone => Str
DiskName => Str
SizeInGb => Int
[AddOns => ArrayRef[Paws::Lightsail::AddOnRequest]]
[DiskSnapshotName => Str]
[RestoreDate => Str]
[SourceDiskName => Str]
[Tags => ArrayRef[Paws::Lightsail::Tag]]
[UseLatestRestorableAutoSnapshot => Bool]

Each argument is described in detail in: Paws::Lightsail::CreateDiskFromSnapshot

Returns: a Paws::Lightsail::CreateDiskFromSnapshotResult instance

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

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateDiskSnapshot

DiskSnapshotName => Str
[DiskName => Str]
[InstanceName => Str]
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateDiskSnapshot

Returns: a Paws::Lightsail::CreateDiskSnapshotResult instance

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.

You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.

You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.

The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateDistribution

BundleId => Str
DefaultCacheBehavior => Paws::Lightsail::CacheBehavior
DistributionName => Str
Origin => Paws::Lightsail::InputOrigin
[CacheBehaviors => ArrayRef[Paws::Lightsail::CacheBehaviorPerPath]]
[CacheBehaviorSettings => Paws::Lightsail::CacheSettings]
[IpAddressType => Str]
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateDistribution

Returns: a Paws::Lightsail::CreateDistributionResult instance

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 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-content-delivery-network-distributions).

CreateDomain

DomainName => Str
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateDomain

Returns: a Paws::Lightsail::CreateDomainResult instance

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

The create domain operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateDomainEntry

DomainEntry => Paws::Lightsail::DomainEntry
DomainName => Str

Each argument is described in detail in: Paws::Lightsail::CreateDomainEntry

Returns: a Paws::Lightsail::CreateDomainEntryResult instance

Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateInstances

AvailabilityZone => Str
BlueprintId => Str
BundleId => Str
InstanceNames => ArrayRef[Str|Undef]
[AddOns => ArrayRef[Paws::Lightsail::AddOnRequest]]
[CustomImageName => Str]
[IpAddressType => Str]
[KeyPairName => Str]
[Tags => ArrayRef[Paws::Lightsail::Tag]]
[UserData => Str]

Each argument is described in detail in: Paws::Lightsail::CreateInstances

Returns: a Paws::Lightsail::CreateInstancesResult instance

Creates one or more Amazon Lightsail instances.

The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateInstancesFromSnapshot

AvailabilityZone => Str
BundleId => Str
InstanceNames => ArrayRef[Str|Undef]
[AddOns => ArrayRef[Paws::Lightsail::AddOnRequest]]
[AttachedDiskMapping => Paws::Lightsail::AttachedDiskMap]
[InstanceSnapshotName => Str]
[IpAddressType => Str]
[KeyPairName => Str]
[RestoreDate => Str]
[SourceInstanceName => Str]
[Tags => ArrayRef[Paws::Lightsail::Tag]]
[UseLatestRestorableAutoSnapshot => Bool]
[UserData => Str]

Each argument is described in detail in: Paws::Lightsail::CreateInstancesFromSnapshot

Returns: a Paws::Lightsail::CreateInstancesFromSnapshotResult instance

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

The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateInstanceSnapshot

InstanceName => Str
InstanceSnapshotName => Str
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateInstanceSnapshot

Returns: a Paws::Lightsail::CreateInstanceSnapshotResult instance

Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.

The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateKeyPair

KeyPairName => Str
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateKeyPair

Returns: a Paws::Lightsail::CreateKeyPairResult instance

Creates an SSH key pair.

The create key pair operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateLoadBalancer

InstancePort => Int
LoadBalancerName => Str
[CertificateAlternativeNames => ArrayRef[Str|Undef]]
[CertificateDomainName => Str]
[CertificateName => Str]
[HealthCheckPath => Str]
[IpAddressType => Str]
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateLoadBalancer

Returns: a Paws::Lightsail::CreateLoadBalancerResult instance

Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing (https://lightsail.aws.amazon.com/ls/docs/how-to/article/configure-lightsail-instances-for-load-balancing). You can create up to 5 load balancers per AWS Region in your account.

When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.

The create load balancer operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateLoadBalancerTlsCertificate

CertificateDomainName => Str
CertificateName => Str
LoadBalancerName => Str
[CertificateAlternativeNames => ArrayRef[Str|Undef]]
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateLoadBalancerTlsCertificate

Returns: a Paws::Lightsail::CreateLoadBalancerTlsCertificateResult instance

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateRelationalDatabase

MasterDatabaseName => Str
MasterUsername => Str
RelationalDatabaseBlueprintId => Str
RelationalDatabaseBundleId => Str
RelationalDatabaseName => Str
[AvailabilityZone => Str]
[MasterUserPassword => Str]
[PreferredBackupWindow => Str]
[PreferredMaintenanceWindow => Str]
[PubliclyAccessible => Bool]
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateRelationalDatabase

Returns: a Paws::Lightsail::CreateRelationalDatabaseResult instance

Creates a new database in Amazon Lightsail.

The create relational database operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateRelationalDatabaseFromSnapshot

RelationalDatabaseName => Str
[AvailabilityZone => Str]
[PubliclyAccessible => Bool]
[RelationalDatabaseBundleId => Str]
[RelationalDatabaseSnapshotName => Str]
[RestoreTime => Str]
[SourceRelationalDatabaseName => Str]
[Tags => ArrayRef[Paws::Lightsail::Tag]]
[UseLatestRestorableTime => Bool]

Each argument is described in detail in: Paws::Lightsail::CreateRelationalDatabaseFromSnapshot

Returns: a Paws::Lightsail::CreateRelationalDatabaseFromSnapshotResult instance

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

You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.

The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

CreateRelationalDatabaseSnapshot

RelationalDatabaseName => Str
RelationalDatabaseSnapshotName => Str
[Tags => ArrayRef[Paws::Lightsail::Tag]]

Each argument is described in detail in: Paws::Lightsail::CreateRelationalDatabaseSnapshot

Returns: a Paws::Lightsail::CreateRelationalDatabaseSnapshotResult instance

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.

The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DeleteAlarm

AlarmName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteAlarm

Returns: a Paws::Lightsail::DeleteAlarmResult instance

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 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).

DeleteAutoSnapshot

Date => Str
ResourceName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteAutoSnapshot

Returns: a Paws::Lightsail::DeleteAutoSnapshotResult instance

Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).

DeleteCertificate

CertificateName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteCertificate

Returns: a Paws::Lightsail::DeleteCertificateResult instance

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.

DeleteContactMethod

Protocol => Str

Each argument is described in detail in: Paws::Lightsail::DeleteContactMethod

Returns: a Paws::Lightsail::DeleteContactMethodResult instance

Deletes a contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).

DeleteContainerImage

Image => Str
ServiceName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteContainerImage

Returns: a Paws::Lightsail::DeleteContainerImageResult instance

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

DeleteContainerService

ServiceName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteContainerService

Returns: a Paws::Lightsail::DeleteContainerServiceResult instance

Deletes your Amazon Lightsail container service.

DeleteDisk

DiskName => Str
[ForceDeleteAddOns => Bool]

Each argument is described in detail in: Paws::Lightsail::DeleteDisk

Returns: a Paws::Lightsail::DeleteDiskResult instance

Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance).

The disk may remain in the deleting state for several minutes.

The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DeleteDiskSnapshot

DiskSnapshotName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteDiskSnapshot

Returns: a Paws::Lightsail::DeleteDiskSnapshotResult instance

Deletes the specified disk snapshot.

When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.

The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DeleteDistribution

[DistributionName => Str]

Each argument is described in detail in: Paws::Lightsail::DeleteDistribution

Returns: a Paws::Lightsail::DeleteDistributionResult instance

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

DeleteDomain

DomainName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteDomain

Returns: a Paws::Lightsail::DeleteDomainResult instance

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

The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DeleteDomainEntry

DomainEntry => Paws::Lightsail::DomainEntry
DomainName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteDomainEntry

Returns: a Paws::Lightsail::DeleteDomainEntryResult instance

Deletes a specific domain entry.

The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DeleteInstance

InstanceName => Str
[ForceDeleteAddOns => Bool]

Each argument is described in detail in: Paws::Lightsail::DeleteInstance

Returns: a Paws::Lightsail::DeleteInstanceResult instance

Deletes an Amazon Lightsail instance.

The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DeleteInstanceSnapshot

InstanceSnapshotName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteInstanceSnapshot

Returns: a Paws::Lightsail::DeleteInstanceSnapshotResult instance

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

The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DeleteKeyPair

KeyPairName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteKeyPair

Returns: a Paws::Lightsail::DeleteKeyPairResult instance

Deletes a specific SSH key pair.

The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DeleteKnownHostKeys

InstanceName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteKnownHostKeys

Returns: a Paws::Lightsail::DeleteKnownHostKeysResult instance

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 (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-troubleshooting-browser-based-ssh-rdp-client-connection).

DeleteLoadBalancer

LoadBalancerName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteLoadBalancer

Returns: a Paws::Lightsail::DeleteLoadBalancerResult instance

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.

The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DeleteLoadBalancerTlsCertificate

CertificateName => Str
LoadBalancerName => Str
[Force => Bool]

Each argument is described in detail in: Paws::Lightsail::DeleteLoadBalancerTlsCertificate

Returns: a Paws::Lightsail::DeleteLoadBalancerTlsCertificateResult instance

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

The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DeleteRelationalDatabase

RelationalDatabaseName => Str
[FinalRelationalDatabaseSnapshotName => Str]
[SkipFinalSnapshot => Bool]

Each argument is described in detail in: Paws::Lightsail::DeleteRelationalDatabase

Returns: a Paws::Lightsail::DeleteRelationalDatabaseResult instance

Deletes a database in Amazon Lightsail.

The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DeleteRelationalDatabaseSnapshot

RelationalDatabaseSnapshotName => Str

Each argument is described in detail in: Paws::Lightsail::DeleteRelationalDatabaseSnapshot

Returns: a Paws::Lightsail::DeleteRelationalDatabaseSnapshotResult instance

Deletes a database snapshot in Amazon Lightsail.

The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DetachCertificateFromDistribution

DistributionName => Str

Each argument is described in detail in: Paws::Lightsail::DetachCertificateFromDistribution

Returns: a Paws::Lightsail::DetachCertificateFromDistributionResult instance

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.

DetachDisk

DiskName => Str

Each argument is described in detail in: Paws::Lightsail::DetachDisk

Returns: a Paws::Lightsail::DetachDiskResult instance

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.

The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DetachInstancesFromLoadBalancer

InstanceNames => ArrayRef[Str|Undef]
LoadBalancerName => Str

Each argument is described in detail in: Paws::Lightsail::DetachInstancesFromLoadBalancer

Returns: a Paws::Lightsail::DetachInstancesFromLoadBalancerResult instance

Detaches the specified instances from a Lightsail load balancer.

This operation waits until the instances are no longer needed before they are detached from the load balancer.

The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

DetachStaticIp

StaticIpName => Str

Each argument is described in detail in: Paws::Lightsail::DetachStaticIp

Returns: a Paws::Lightsail::DetachStaticIpResult instance

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

DisableAddOn

AddOnType => Str
ResourceName => Str

Each argument is described in detail in: Paws::Lightsail::DisableAddOn

Returns: a Paws::Lightsail::DisableAddOnResult instance

Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).

DownloadDefaultKeyPair

Each argument is described in detail in: Paws::Lightsail::DownloadDefaultKeyPair

Returns: a Paws::Lightsail::DownloadDefaultKeyPairResult instance

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

EnableAddOn

AddOnRequest => Paws::Lightsail::AddOnRequest
ResourceName => Str

Each argument is described in detail in: Paws::Lightsail::EnableAddOn

Returns: a Paws::Lightsail::EnableAddOnResult instance

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).

ExportSnapshot

SourceSnapshotName => Str

Each argument is described in detail in: Paws::Lightsail::ExportSnapshot

Returns: a Paws::Lightsail::ExportSnapshotResult instance

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.

The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.

GetActiveNames

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetActiveNames

Returns: a Paws::Lightsail::GetActiveNamesResult instance

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

GetAlarms

[AlarmName => Str]
[MonitoredResourceName => Str]
[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetAlarms

Returns: a Paws::Lightsail::GetAlarmsResult instance

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 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).

GetAutoSnapshots

ResourceName => Str

Each argument is described in detail in: Paws::Lightsail::GetAutoSnapshots

Returns: a Paws::Lightsail::GetAutoSnapshotsResult instance

Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).

GetBlueprints

[IncludeInactive => Bool]
[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetBlueprints

Returns: a Paws::Lightsail::GetBlueprintsResult instance

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.

GetBundles

[IncludeInactive => Bool]
[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetBundles

Returns: a Paws::Lightsail::GetBundlesResult instance

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

GetCertificates

[CertificateName => Str]
[CertificateStatuses => ArrayRef[Str|Undef]]
[IncludeCertificateDetails => Bool]

Each argument is described in detail in: Paws::Lightsail::GetCertificates

Returns: a Paws::Lightsail::GetCertificatesResult instance

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

To get a summary of a certificate, ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

GetCloudFormationStackRecords

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetCloudFormationStackRecords

Returns: a Paws::Lightsail::GetCloudFormationStackRecordsResult instance

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.

GetContactMethods

[Protocols => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::Lightsail::GetContactMethods

Returns: a Paws::Lightsail::GetContactMethodsResult instance

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

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).

GetContainerAPIMetadata

Each argument is described in detail in: Paws::Lightsail::GetContainerAPIMetadata

Returns: a Paws::Lightsail::GetContainerAPIMetadataResult instance

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

GetContainerImages

ServiceName => Str

Each argument is described in detail in: Paws::Lightsail::GetContainerImages

Returns: a Paws::Lightsail::GetContainerImagesResult instance

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.

GetContainerLog

ContainerName => Str
ServiceName => Str
[EndTime => Str]
[FilterPattern => Str]
[PageToken => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::Lightsail::GetContainerLog

Returns: a Paws::Lightsail::GetContainerLogResult instance

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 (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the AWS General Reference.

GetContainerServiceDeployments

ServiceName => Str

Each argument is described in detail in: Paws::Lightsail::GetContainerServiceDeployments

Returns: a Paws::Lightsail::GetContainerServiceDeploymentsResult instance

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 (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the AWS General Reference.

GetContainerServiceMetricData

EndTime => Str
MetricName => Str
Period => Int
ServiceName => Str
StartTime => Str
Statistics => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Lightsail::GetContainerServiceMetricData

Returns: a Paws::Lightsail::GetContainerServiceMetricDataResult instance

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.

GetContainerServicePowers

Each argument is described in detail in: Paws::Lightsail::GetContainerServicePowers

Returns: a Paws::Lightsail::GetContainerServicePowersResult instance

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.

GetContainerServices

[ServiceName => Str]

Each argument is described in detail in: Paws::Lightsail::GetContainerServices

Returns: a Paws::Lightsail::ContainerServicesListResult instance

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

GetDisk

DiskName => Str

Each argument is described in detail in: Paws::Lightsail::GetDisk

Returns: a Paws::Lightsail::GetDiskResult instance

Returns information about a specific block storage disk.

GetDisks

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetDisks

Returns: a Paws::Lightsail::GetDisksResult instance

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

GetDiskSnapshot

DiskSnapshotName => Str

Each argument is described in detail in: Paws::Lightsail::GetDiskSnapshot

Returns: a Paws::Lightsail::GetDiskSnapshotResult instance

Returns information about a specific block storage disk snapshot.

GetDiskSnapshots

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetDiskSnapshots

Returns: a Paws::Lightsail::GetDiskSnapshotsResult instance

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

GetDistributionBundles

Each argument is described in detail in: Paws::Lightsail::GetDistributionBundles

Returns: a Paws::Lightsail::GetDistributionBundlesResult instance

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

A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.

GetDistributionLatestCacheReset

[DistributionName => Str]

Each argument is described in detail in: Paws::Lightsail::GetDistributionLatestCacheReset

Returns: a Paws::Lightsail::GetDistributionLatestCacheResetResult instance

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

GetDistributionMetricData

DistributionName => Str
EndTime => Str
MetricName => Str
Period => Int
StartTime => Str
Statistics => ArrayRef[Str|Undef]
Unit => Str

Each argument is described in detail in: Paws::Lightsail::GetDistributionMetricData

Returns: a Paws::Lightsail::GetDistributionMetricDataResult instance

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.

GetDistributions

[DistributionName => Str]
[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetDistributions

Returns: a Paws::Lightsail::GetDistributionsResult instance

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

GetDomain

DomainName => Str

Each argument is described in detail in: Paws::Lightsail::GetDomain

Returns: a Paws::Lightsail::GetDomainResult instance

Returns information about a specific domain recordset.

GetDomains

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetDomains

Returns: a Paws::Lightsail::GetDomainsResult instance

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

GetExportSnapshotRecords

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetExportSnapshotRecords

Returns: a Paws::Lightsail::GetExportSnapshotRecordsResult instance

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

An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the create cloud formation stack operation.

GetInstance

InstanceName => Str

Each argument is described in detail in: Paws::Lightsail::GetInstance

Returns: a Paws::Lightsail::GetInstanceResult instance

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

GetInstanceAccessDetails

InstanceName => Str
[Protocol => Str]

Each argument is described in detail in: Paws::Lightsail::GetInstanceAccessDetails

Returns: a Paws::Lightsail::GetInstanceAccessDetailsResult instance

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

The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

GetInstanceMetricData

EndTime => Str
InstanceName => Str
MetricName => Str
Period => Int
StartTime => Str
Statistics => ArrayRef[Str|Undef]
Unit => Str

Each argument is described in detail in: Paws::Lightsail::GetInstanceMetricData

Returns: a Paws::Lightsail::GetInstanceMetricDataResult instance

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.

GetInstancePortStates

InstanceName => Str

Each argument is described in detail in: Paws::Lightsail::GetInstancePortStates

Returns: a Paws::Lightsail::GetInstancePortStatesResult instance

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

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetInstances

Returns: a Paws::Lightsail::GetInstancesResult instance

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

GetInstanceSnapshot

InstanceSnapshotName => Str

Each argument is described in detail in: Paws::Lightsail::GetInstanceSnapshot

Returns: a Paws::Lightsail::GetInstanceSnapshotResult instance

Returns information about a specific instance snapshot.

GetInstanceSnapshots

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetInstanceSnapshots

Returns: a Paws::Lightsail::GetInstanceSnapshotsResult instance

Returns all instance snapshots for the user's account.

GetInstanceState

InstanceName => Str

Each argument is described in detail in: Paws::Lightsail::GetInstanceState

Returns: a Paws::Lightsail::GetInstanceStateResult instance

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

GetKeyPair

KeyPairName => Str

Each argument is described in detail in: Paws::Lightsail::GetKeyPair

Returns: a Paws::Lightsail::GetKeyPairResult instance

Returns information about a specific key pair.

GetKeyPairs

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetKeyPairs

Returns: a Paws::Lightsail::GetKeyPairsResult instance

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

GetLoadBalancer

LoadBalancerName => Str

Each argument is described in detail in: Paws::Lightsail::GetLoadBalancer

Returns: a Paws::Lightsail::GetLoadBalancerResult instance

Returns information about the specified Lightsail load balancer.

GetLoadBalancerMetricData

EndTime => Str
LoadBalancerName => Str
MetricName => Str
Period => Int
StartTime => Str
Statistics => ArrayRef[Str|Undef]
Unit => Str

Each argument is described in detail in: Paws::Lightsail::GetLoadBalancerMetricData

Returns: a Paws::Lightsail::GetLoadBalancerMetricDataResult instance

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.

GetLoadBalancers

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetLoadBalancers

Returns: a Paws::Lightsail::GetLoadBalancersResult instance

Returns information about all load balancers in an account.

GetLoadBalancerTlsCertificates

LoadBalancerName => Str

Each argument is described in detail in: Paws::Lightsail::GetLoadBalancerTlsCertificates

Returns: a Paws::Lightsail::GetLoadBalancerTlsCertificatesResult instance

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.

GetOperation

OperationId => Str

Each argument is described in detail in: Paws::Lightsail::GetOperation

Returns: a Paws::Lightsail::GetOperationResult instance

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

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetOperations

Returns: a Paws::Lightsail::GetOperationsResult instance

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.

GetOperationsForResource

ResourceName => Str
[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetOperationsForResource

Returns: a Paws::Lightsail::GetOperationsForResourceResult instance

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

GetRegions

[IncludeAvailabilityZones => Bool]
[IncludeRelationalDatabaseAvailabilityZones => Bool]

Each argument is described in detail in: Paws::Lightsail::GetRegions

Returns: a Paws::Lightsail::GetRegionsResult instance

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

RelationalDatabaseName => Str

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabase

Returns: a Paws::Lightsail::GetRelationalDatabaseResult instance

Returns information about a specific database in Amazon Lightsail.

GetRelationalDatabaseBlueprints

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabaseBlueprints

Returns: a Paws::Lightsail::GetRelationalDatabaseBlueprintsResult instance

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.

GetRelationalDatabaseBundles

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabaseBundles

Returns: a Paws::Lightsail::GetRelationalDatabaseBundlesResult instance

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.

GetRelationalDatabaseEvents

RelationalDatabaseName => Str
[DurationInMinutes => Int]
[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabaseEvents

Returns: a Paws::Lightsail::GetRelationalDatabaseEventsResult instance

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

GetRelationalDatabaseLogEvents

LogStreamName => Str
RelationalDatabaseName => Str
[EndTime => Str]
[PageToken => Str]
[StartFromHead => Bool]
[StartTime => Str]

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabaseLogEvents

Returns: a Paws::Lightsail::GetRelationalDatabaseLogEventsResult instance

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

GetRelationalDatabaseLogStreams

RelationalDatabaseName => Str

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabaseLogStreams

Returns: a Paws::Lightsail::GetRelationalDatabaseLogStreamsResult instance

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

GetRelationalDatabaseMasterUserPassword

RelationalDatabaseName => Str
[PasswordVersion => Str]

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabaseMasterUserPassword

Returns: a Paws::Lightsail::GetRelationalDatabaseMasterUserPasswordResult instance

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.

GetRelationalDatabaseMetricData

EndTime => Str
MetricName => Str
Period => Int
RelationalDatabaseName => Str
StartTime => Str
Statistics => ArrayRef[Str|Undef]
Unit => Str

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabaseMetricData

Returns: a Paws::Lightsail::GetRelationalDatabaseMetricDataResult instance

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.

GetRelationalDatabaseParameters

RelationalDatabaseName => Str
[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabaseParameters

Returns: a Paws::Lightsail::GetRelationalDatabaseParametersResult instance

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.

GetRelationalDatabases

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabases

Returns: a Paws::Lightsail::GetRelationalDatabasesResult instance

Returns information about all of your databases in Amazon Lightsail.

GetRelationalDatabaseSnapshot

RelationalDatabaseSnapshotName => Str

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabaseSnapshot

Returns: a Paws::Lightsail::GetRelationalDatabaseSnapshotResult instance

Returns information about a specific database snapshot in Amazon Lightsail.

GetRelationalDatabaseSnapshots

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetRelationalDatabaseSnapshots

Returns: a Paws::Lightsail::GetRelationalDatabaseSnapshotsResult instance

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

GetStaticIp

StaticIpName => Str

Each argument is described in detail in: Paws::Lightsail::GetStaticIp

Returns: a Paws::Lightsail::GetStaticIpResult instance

Returns information about an Amazon Lightsail static IP.

GetStaticIps

[PageToken => Str]

Each argument is described in detail in: Paws::Lightsail::GetStaticIps

Returns: a Paws::Lightsail::GetStaticIpsResult instance

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

ImportKeyPair

KeyPairName => Str
PublicKeyBase64 => Str

Each argument is described in detail in: Paws::Lightsail::ImportKeyPair

Returns: a Paws::Lightsail::ImportKeyPairResult instance

Imports a public SSH key from a specific key pair.

IsVpcPeered

Each argument is described in detail in: Paws::Lightsail::IsVpcPeered

Returns: a Paws::Lightsail::IsVpcPeeredResult instance

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

OpenInstancePublicPorts

InstanceName => Str
PortInfo => Paws::Lightsail::PortInfo

Each argument is described in detail in: Paws::Lightsail::OpenInstancePublicPorts

Returns: a Paws::Lightsail::OpenInstancePublicPortsResult instance

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.

The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

PeerVpc

Each argument is described in detail in: Paws::Lightsail::PeerVpc

Returns: a Paws::Lightsail::PeerVpcResult instance

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

PutAlarm

AlarmName => Str
ComparisonOperator => Str
EvaluationPeriods => Int
MetricName => Str
MonitoredResourceName => Str
Threshold => Num
[ContactProtocols => ArrayRef[Str|Undef]]
[DatapointsToAlarm => Int]
[NotificationEnabled => Bool]
[NotificationTriggers => ArrayRef[Str|Undef]]
[TreatMissingData => Str]

Each argument is described in detail in: Paws::Lightsail::PutAlarm

Returns: a Paws::Lightsail::PutAlarmResult instance

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 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).

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.

PutInstancePublicPorts

InstanceName => Str
PortInfos => ArrayRef[Paws::Lightsail::PortInfo]

Each argument is described in detail in: Paws::Lightsail::PutInstancePublicPorts

Returns: a Paws::Lightsail::PutInstancePublicPortsResult instance

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.

The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

RebootInstance

InstanceName => Str

Each argument is described in detail in: Paws::Lightsail::RebootInstance

Returns: a Paws::Lightsail::RebootInstanceResult instance

Restarts a specific instance.

The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

RebootRelationalDatabase

RelationalDatabaseName => Str

Each argument is described in detail in: Paws::Lightsail::RebootRelationalDatabase

Returns: a Paws::Lightsail::RebootRelationalDatabaseResult instance

Restarts a specific database in Amazon Lightsail.

The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

RegisterContainerImage

Digest => Str
Label => Str
ServiceName => Str

Each argument is described in detail in: Paws::Lightsail::RegisterContainerImage

Returns: a Paws::Lightsail::RegisterContainerImageResult instance

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 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images) in the Lightsail Dev Guide.

ReleaseStaticIp

StaticIpName => Str

Each argument is described in detail in: Paws::Lightsail::ReleaseStaticIp

Returns: a Paws::Lightsail::ReleaseStaticIpResult instance

Deletes a specific static IP from your account.

ResetDistributionCache

[DistributionName => Str]

Each argument is described in detail in: Paws::Lightsail::ResetDistributionCache

Returns: a Paws::Lightsail::ResetDistributionCacheResult instance

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.

SendContactMethodVerification

Protocol => Str

Each argument is described in detail in: Paws::Lightsail::SendContactMethodVerification

Returns: a Paws::Lightsail::SendContactMethodVerificationResult instance

Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).

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.

SetIpAddressType

IpAddressType => Str
ResourceName => Str
ResourceType => Str

Each argument is described in detail in: Paws::Lightsail::SetIpAddressType

Returns: a Paws::Lightsail::SetIpAddressTypeResult instance

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.

StartInstance

InstanceName => Str

Each argument is described in detail in: Paws::Lightsail::StartInstance

Returns: a Paws::Lightsail::StartInstanceResult instance

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/lightsail-create-static-ip).

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 (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

StartRelationalDatabase

RelationalDatabaseName => Str

Each argument is described in detail in: Paws::Lightsail::StartRelationalDatabase

Returns: a Paws::Lightsail::StartRelationalDatabaseResult instance

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

The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

StopInstance

InstanceName => Str
[Force => Bool]

Each argument is described in detail in: Paws::Lightsail::StopInstance

Returns: a Paws::Lightsail::StopInstanceResult instance

Stops a specific Amazon Lightsail instance that is currently running.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/lightsail-create-static-ip).

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 (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

StopRelationalDatabase

RelationalDatabaseName => Str
[RelationalDatabaseSnapshotName => Str]

Each argument is described in detail in: Paws::Lightsail::StopRelationalDatabase

Returns: a Paws::Lightsail::StopRelationalDatabaseResult instance

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

The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

TagResource

ResourceName => Str
Tags => ArrayRef[Paws::Lightsail::Tag]
[ResourceArn => Str]

Each argument is described in detail in: Paws::Lightsail::TagResource

Returns: a Paws::Lightsail::TagResourceResult instance

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 (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags).

The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

TestAlarm

AlarmName => Str
State => Str

Each argument is described in detail in: Paws::Lightsail::TestAlarm

Returns: a Paws::Lightsail::TestAlarmResult instance

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

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).

UnpeerVpc

Each argument is described in detail in: Paws::Lightsail::UnpeerVpc

Returns: a Paws::Lightsail::UnpeerVpcResult instance

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

UntagResource

ResourceName => Str
TagKeys => ArrayRef[Str|Undef]
[ResourceArn => Str]

Each argument is described in detail in: Paws::Lightsail::UntagResource

Returns: a Paws::Lightsail::UntagResourceResult instance

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

The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

UpdateContainerService

ServiceName => Str
[IsDisabled => Bool]
[Power => Str]
[PublicDomainNames => Paws::Lightsail::ContainerServicePublicDomains]
[Scale => Int]

Each argument is described in detail in: Paws::Lightsail::UpdateContainerService

Returns: a Paws::Lightsail::UpdateContainerServiceResult instance

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

UpdateDistribution

DistributionName => Str
[CacheBehaviors => ArrayRef[Paws::Lightsail::CacheBehaviorPerPath]]
[CacheBehaviorSettings => Paws::Lightsail::CacheSettings]
[DefaultCacheBehavior => Paws::Lightsail::CacheBehavior]
[IsEnabled => Bool]
[Origin => Paws::Lightsail::InputOrigin]

Each argument is described in detail in: Paws::Lightsail::UpdateDistribution

Returns: a Paws::Lightsail::UpdateDistributionResult instance

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

Use this action to update the configuration of your existing distribution

UpdateDistributionBundle

[BundleId => Str]
[DistributionName => Str]

Each argument is described in detail in: Paws::Lightsail::UpdateDistributionBundle

Returns: a Paws::Lightsail::UpdateDistributionBundleResult instance

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

A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.

Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.

You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle.

UpdateDomainEntry

DomainEntry => Paws::Lightsail::DomainEntry
DomainName => Str

Each argument is described in detail in: Paws::Lightsail::UpdateDomainEntry

Returns: a Paws::Lightsail::UpdateDomainEntryResult instance

Updates a domain recordset after it is created.

The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

UpdateLoadBalancerAttribute

AttributeName => Str
AttributeValue => Str
LoadBalancerName => Str

Each argument is described in detail in: Paws::Lightsail::UpdateLoadBalancerAttribute

Returns: a Paws::Lightsail::UpdateLoadBalancerAttributeResult instance

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

The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

UpdateRelationalDatabase

RelationalDatabaseName => Str
[ApplyImmediately => Bool]
[CaCertificateIdentifier => Str]
[DisableBackupRetention => Bool]
[EnableBackupRetention => Bool]
[MasterUserPassword => Str]
[PreferredBackupWindow => Str]
[PreferredMaintenanceWindow => Str]
[PubliclyAccessible => Bool]
[RotateMasterUserPassword => Bool]

Each argument is described in detail in: Paws::Lightsail::UpdateRelationalDatabase

Returns: a Paws::Lightsail::UpdateRelationalDatabaseResult instance

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

Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.

The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

UpdateRelationalDatabaseParameters

Parameters => ArrayRef[Paws::Lightsail::RelationalDatabaseParameter]
RelationalDatabaseName => Str

Each argument is described in detail in: Paws::Lightsail::UpdateRelationalDatabaseParameters

Returns: a Paws::Lightsail::UpdateRelationalDatabaseParametersResult instance

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

Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation.

The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

GetAllActiveNames(sub { },[PageToken => Str])

GetAllActiveNames([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - activeNames, passing the object as the first parameter, and the string 'activeNames' as the second parameter 

If not, it will return a a Paws::Lightsail::GetActiveNamesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllBlueprints(sub { },[IncludeInactive => Bool, PageToken => Str])

GetAllBlueprints([IncludeInactive => Bool, PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - blueprints, passing the object as the first parameter, and the string 'blueprints' as the second parameter 

If not, it will return a a Paws::Lightsail::GetBlueprintsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllBundles(sub { },[IncludeInactive => Bool, PageToken => Str])

GetAllBundles([IncludeInactive => Bool, PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - bundles, passing the object as the first parameter, and the string 'bundles' as the second parameter 

If not, it will return a a Paws::Lightsail::GetBundlesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllCloudFormationStackRecords(sub { },[PageToken => Str])

GetAllCloudFormationStackRecords([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - cloudFormationStackRecords, passing the object as the first parameter, and the string 'cloudFormationStackRecords' as the second parameter 

If not, it will return a a Paws::Lightsail::GetCloudFormationStackRecordsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllDisks(sub { },[PageToken => Str])

GetAllDisks([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - disks, passing the object as the first parameter, and the string 'disks' as the second parameter 

If not, it will return a a Paws::Lightsail::GetDisksResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllDiskSnapshots(sub { },[PageToken => Str])

GetAllDiskSnapshots([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - diskSnapshots, passing the object as the first parameter, and the string 'diskSnapshots' as the second parameter 

If not, it will return a a Paws::Lightsail::GetDiskSnapshotsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllDomains(sub { },[PageToken => Str])

GetAllDomains([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - domains, passing the object as the first parameter, and the string 'domains' as the second parameter 

If not, it will return a a Paws::Lightsail::GetDomainsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllExportSnapshotRecords(sub { },[PageToken => Str])

GetAllExportSnapshotRecords([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - exportSnapshotRecords, passing the object as the first parameter, and the string 'exportSnapshotRecords' as the second parameter 

If not, it will return a a Paws::Lightsail::GetExportSnapshotRecordsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllInstances(sub { },[PageToken => Str])

GetAllInstances([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - instances, passing the object as the first parameter, and the string 'instances' as the second parameter 

If not, it will return a a Paws::Lightsail::GetInstancesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllInstanceSnapshots(sub { },[PageToken => Str])

GetAllInstanceSnapshots([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - instanceSnapshots, passing the object as the first parameter, and the string 'instanceSnapshots' as the second parameter 

If not, it will return a a Paws::Lightsail::GetInstanceSnapshotsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllKeyPairs(sub { },[PageToken => Str])

GetAllKeyPairs([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - keyPairs, passing the object as the first parameter, and the string 'keyPairs' as the second parameter 

If not, it will return a a Paws::Lightsail::GetKeyPairsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllLoadBalancers(sub { },[PageToken => Str])

GetAllLoadBalancers([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - loadBalancers, passing the object as the first parameter, and the string 'loadBalancers' as the second parameter 

If not, it will return a a Paws::Lightsail::GetLoadBalancersResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllOperations(sub { },[PageToken => Str])

GetAllOperations([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - operations, passing the object as the first parameter, and the string 'operations' as the second parameter 

If not, it will return a a Paws::Lightsail::GetOperationsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllRelationalDatabaseBlueprints(sub { },[PageToken => Str])

GetAllRelationalDatabaseBlueprints([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - blueprints, passing the object as the first parameter, and the string 'blueprints' as the second parameter 

If not, it will return a a Paws::Lightsail::GetRelationalDatabaseBlueprintsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllRelationalDatabaseBundles(sub { },[PageToken => Str])

GetAllRelationalDatabaseBundles([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - bundles, passing the object as the first parameter, and the string 'bundles' as the second parameter 

If not, it will return a a Paws::Lightsail::GetRelationalDatabaseBundlesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllRelationalDatabaseEvents(sub { },RelationalDatabaseName => Str, [DurationInMinutes => Int, PageToken => Str])

GetAllRelationalDatabaseEvents(RelationalDatabaseName => Str, [DurationInMinutes => Int, PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - relationalDatabaseEvents, passing the object as the first parameter, and the string 'relationalDatabaseEvents' as the second parameter 

If not, it will return a a Paws::Lightsail::GetRelationalDatabaseEventsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllRelationalDatabaseParameters(sub { },RelationalDatabaseName => Str, [PageToken => Str])

GetAllRelationalDatabaseParameters(RelationalDatabaseName => Str, [PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - parameters, passing the object as the first parameter, and the string 'parameters' as the second parameter 

If not, it will return a a Paws::Lightsail::GetRelationalDatabaseParametersResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllRelationalDatabases(sub { },[PageToken => Str])

GetAllRelationalDatabases([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - relationalDatabases, passing the object as the first parameter, and the string 'relationalDatabases' as the second parameter 

If not, it will return a a Paws::Lightsail::GetRelationalDatabasesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllRelationalDatabaseSnapshots(sub { },[PageToken => Str])

GetAllRelationalDatabaseSnapshots([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - relationalDatabaseSnapshots, passing the object as the first parameter, and the string 'relationalDatabaseSnapshots' as the second parameter 

If not, it will return a a Paws::Lightsail::GetRelationalDatabaseSnapshotsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllStaticIps(sub { },[PageToken => Str])

GetAllStaticIps([PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - staticIps, passing the object as the first parameter, and the string 'staticIps' as the second parameter 

If not, it will return a a Paws::Lightsail::GetStaticIpsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues