aws-elixir v0.4.0 AWS.Lightsail

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.

Summary

Functions

Allocates a static IP address

Attaches a static IP address to a specific Amazon Lightsail instance

Closes the public ports on a specific Amazon Lightsail instance

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

Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record

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

Creates one or more Amazon Lightsail virtual private servers, or instances

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

Deletes the specified domain recordset and all of its domain records

Deletes a specific domain entry

Deletes a specific Amazon Lightsail virtual private server, or instance

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

Deletes a specific SSH key pair

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

Downloads the default SSH key pair from the user’s account

Returns the names of all active (not deleted) resources

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

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

Returns information about a specific domain recordset

Returns a list of all domains in the user’s account

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

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

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

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

Returns information about a specific instance snapshot

Returns all instance snapshots for the user’s account

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

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

Returns information about a specific key pair

Returns information about all key pairs in the user’s account

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

Returns information about all operations

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

Returns a list of all valid regions for Amazon Lightsail

Returns information about a specific static IP

Returns information about all static IPs in the user’s account

Imports a public SSH key from a specific key pair

Returns a Boolean value indicating whether your Lightsail VPC is peered

Adds public ports to an Amazon Lightsail instance

Tries to peer the Lightsail VPC with the user’s default VPC

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

Deletes a specific static IP from your account

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

Stops a specific Amazon Lightsail instance that is currently running

Attempts to unpeer the Lightsail VPC from the user’s default VPC

Updates a domain recordset after it is created

Functions

allocate_static_ip(client, input, options \\ [])

Allocates a static IP address.

attach_static_ip(client, input, options \\ [])

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

close_instance_public_ports(client, input, options \\ [])

Closes the public ports on a specific Amazon Lightsail instance.

create_domain(client, input, options \\ [])

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

create_domain_entry(client, input, options \\ [])

Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.

create_instance_snapshot(client, input, options \\ [])

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.

create_instances(client, input, options \\ [])

Creates one or more Amazon Lightsail virtual private servers, or instances.

create_instances_from_snapshot(client, input, options \\ [])

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

create_key_pair(client, input, options \\ [])

Creates sn SSH key pair.

delete_domain(client, input, options \\ [])

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

delete_domain_entry(client, input, options \\ [])

Deletes a specific domain entry.

delete_instance(client, input, options \\ [])

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

delete_instance_snapshot(client, input, options \\ [])

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

delete_key_pair(client, input, options \\ [])

Deletes a specific SSH key pair.

detach_static_ip(client, input, options \\ [])

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

download_default_key_pair(client, input, options \\ [])

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

get_active_names(client, input, options \\ [])

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

get_blueprints(client, input, options \\ [])

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.

get_bundles(client, input, options \\ [])

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

get_domain(client, input, options \\ [])

Returns information about a specific domain recordset.

get_domains(client, input, options \\ [])

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

get_instance(client, input, options \\ [])

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

get_instance_access_details(client, input, options \\ [])

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

get_instance_metric_data(client, input, options \\ [])

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

get_instance_port_states(client, input, options \\ [])

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

get_instance_snapshot(client, input, options \\ [])

Returns information about a specific instance snapshot.

get_instance_snapshots(client, input, options \\ [])

Returns all instance snapshots for the user’s account.

get_instance_state(client, input, options \\ [])

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

get_instances(client, input, options \\ [])

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

get_key_pair(client, input, options \\ [])

Returns information about a specific key pair.

get_key_pairs(client, input, options \\ [])

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

get_operation(client, input, options \\ [])

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.

get_operations(client, input, options \\ [])

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.

get_operations_for_resource(client, input, options \\ [])

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

get_regions(client, input, options \\ [])

Returns a list of all valid regions for Amazon Lightsail.

get_static_ip(client, input, options \\ [])

Returns information about a specific static IP.

get_static_ips(client, input, options \\ [])

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

import_key_pair(client, input, options \\ [])

Imports a public SSH key from a specific key pair.

is_vpc_peered(client, input, options \\ [])

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

open_instance_public_ports(client, input, options \\ [])

Adds public ports to an Amazon Lightsail instance.

peer_vpc(client, input, options \\ [])

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

reboot_instance(client, input, options \\ [])

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.

release_static_ip(client, input, options \\ [])

Deletes a specific static IP from your account.

start_instance(client, input, options \\ [])

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

stop_instance(client, input, options \\ [])

Stops a specific Amazon Lightsail instance that is currently running.

unpeer_vpc(client, input, options \\ [])

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

update_domain_entry(client, input, options \\ [])

Updates a domain recordset after it is created.