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 AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, a managed database, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).

For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/all).

To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, 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).

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.

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 diskName. 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 loadBalancerName. 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 operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.

The attach load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. 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 the public ports on a specific Amazon Lightsail instance.

The close instance public ports operation 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
SourceSnapshotName => Str
TargetSnapshotName => Str

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

Returns: a Paws::Lightsail::CopySnapshotResult instance

Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail.

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.

CreateDisk

AvailabilityZone => Str
DiskName => Str
SizeInGb => Int
[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 a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail (https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail).

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
DiskSnapshotName => Str
SizeInGb => Int
[Tags => ArrayRef[Paws::Lightsail::Tag]]

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

Returns: a Paws::Lightsail::CreateDiskFromSnapshotResult instance

Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail (https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by diskSnapshotName. 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).

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 entry records associated with the domain: 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 domainName. 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]
[CustomImageName => 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 virtual private servers, or instances. Create instances using active blueprints. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Use the get blueprints operation to return a list of available blueprints.

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]
InstanceSnapshotName => Str
[AttachedDiskMapping => Paws::Lightsail::AttachedDiskMap]
[KeyPairName => Str]
[Tags => ArrayRef[Paws::Lightsail::Tag]]
[UserData => Str]

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

Returns: a Paws::Lightsail::CreateInstancesFromSnapshotResult instance

Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.

The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instanceSnapshotName. 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]
[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 a Lightsail load balancer TLS certificate.

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

The create load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. 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).

DeleteDisk

DiskName => Str

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 diskName. 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 diskSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

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

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

Returns: a Paws::Lightsail::DeleteInstanceResult instance

Deletes a specific Amazon Lightsail virtual private server, or instance.

The delete instance operation 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).

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 instanceSnapshotName. 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 keyPairName. 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 loadBalancerName. 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 delete load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. 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).

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

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.

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

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 virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

GetBundles

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

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.

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.

If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

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.

If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

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

GetInstancePortStates

InstanceName => Str

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

Returns: a Paws::Lightsail::GetInstancePortStatesResult instance

Returns the port states for a specific virtual private server, or instance.

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.

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.

If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

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 asdf operation GetRelationalDatabaseMasterUserPassword 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.

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 a specific 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

Adds public ports to an Amazon Lightsail instance.

The open instance public ports operation 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.

PutInstancePublicPorts

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

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

Returns: a Paws::Lightsail::PutInstancePublicPortsResult instance

Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.

The put instance public ports operation 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 instanceName. 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).

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.

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

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 resourceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

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]

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 resourceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

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 domainName. 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 loadBalancerName. 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]
[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 paramater 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