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

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.

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.

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.

CreateDomain(DomainName => Str)

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

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:
A record, CNAME record, TXT record, or MX record.

CreateInstances(AvailabilityZone => Str, BlueprintId => Str, BundleId => Str, InstanceNames => ArrayRef[Str|Undef], [CustomImageName => Str, KeyPairName => Str, 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
I<instances>.

CreateInstancesFromSnapshot(AvailabilityZone => Str, BundleId => Str, InstanceNames => ArrayRef[Str|Undef], InstanceSnapshotName => Str, [KeyPairName => Str, 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.

CreateInstanceSnapshot(InstanceName => Str, InstanceSnapshotName => Str)

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
I<instance>. You can use a snapshot to create a new instance that is
based on that snapshot.

CreateKeyPair(KeyPairName => Str)

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

Returns: a Paws::Lightsail::CreateKeyPairResult instance

  Creates sn SSH key pair.

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.

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.

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

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

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.

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.

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

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.

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

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

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

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.

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.

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.

RebootInstance(InstanceName => Str)

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

Returns: a Paws::Lightsail::RebootInstanceResult instance

  Restarts a specific instance. When your Amazon Lightsail instance is
finished rebooting, Lightsail assigns a new public IP address. To use
the same IP address after restarting, create a static IP address and
attach it to the instance.

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.

StopInstance(InstanceName => Str)

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.

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.

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.

PAGINATORS

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