baiji v0.6.5 Baiji.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.

Link to this section Summary

Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

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. Use the include availability zones parameter to also return the availability zones in a region

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

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

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

Link to this section Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Link to this function allocate_static_ip(input \\ %{}, options \\ [])

Allocates a static IP address.

Link to this function attach_static_ip(input \\ %{}, options \\ [])

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

Link to this function close_instance_public_ports(input \\ %{}, options \\ [])

Closes the public ports on a specific Amazon Lightsail instance.

Link to this function create_domain(input \\ %{}, options \\ [])

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

Link to this function create_domain_entry(input \\ %{}, options \\ [])

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

Link to this function create_instance_snapshot(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.

Link to this function create_instances(input \\ %{}, options \\ [])

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

Link to this function create_instances_from_snapshot(input \\ %{}, options \\ [])

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

Link to this function create_key_pair(input \\ %{}, options \\ [])

Creates sn SSH key pair.

Link to this function delete_domain(input \\ %{}, options \\ [])

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

Link to this function delete_domain_entry(input \\ %{}, options \\ [])

Deletes a specific domain entry.

Link to this function delete_instance(input \\ %{}, options \\ [])

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

Link to this function delete_instance_snapshot(input \\ %{}, options \\ [])

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

Link to this function delete_key_pair(input \\ %{}, options \\ [])

Deletes a specific SSH key pair.

Link to this function detach_static_ip(input \\ %{}, options \\ [])

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

Link to this function download_default_key_pair(input \\ %{}, options \\ [])

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

Link to this function get_active_names(input \\ %{}, options \\ [])

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

Link to this function get_blueprints(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.

Link to this function get_bundles(input \\ %{}, options \\ [])

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

Link to this function get_domain(input \\ %{}, options \\ [])

Returns information about a specific domain recordset.

Link to this function get_domains(input \\ %{}, options \\ [])

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

Link to this function get_instance(input \\ %{}, options \\ [])

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

Link to this function get_instance_access_details(input \\ %{}, options \\ [])

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

Link to this function get_instance_metric_data(input \\ %{}, options \\ [])

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

Link to this function get_instance_port_states(input \\ %{}, options \\ [])

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

Link to this function get_instance_snapshot(input \\ %{}, options \\ [])

Returns information about a specific instance snapshot.

Link to this function get_instance_snapshots(input \\ %{}, options \\ [])

Returns all instance snapshots for the user’s account.

Link to this function get_instance_state(input \\ %{}, options \\ [])

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

Link to this function get_instances(input \\ %{}, options \\ [])

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

Link to this function get_key_pair(input \\ %{}, options \\ [])

Returns information about a specific key pair.

Link to this function get_key_pairs(input \\ %{}, options \\ [])

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

Link to this function get_operation(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.

Link to this function get_operations(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.

Link to this function get_operations_for_resource(input \\ %{}, options \\ [])

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

Link to this function get_regions(input \\ %{}, options \\ [])

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.

Link to this function get_static_ip(input \\ %{}, options \\ [])

Returns information about a specific static IP.

Link to this function get_static_ips(input \\ %{}, options \\ [])

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

Link to this function import_key_pair(input \\ %{}, options \\ [])

Imports a public SSH key from a specific key pair.

Link to this function is_vpc_peered(input \\ %{}, options \\ [])

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

Link to this function open_instance_public_ports(input \\ %{}, options \\ [])

Adds public ports to an Amazon Lightsail instance.

Link to this function peer_vpc(input \\ %{}, options \\ [])

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

Link to this function put_instance_public_ports(input \\ %{}, options \\ [])

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

Link to this function reboot_instance(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.

Link to this function release_static_ip(input \\ %{}, options \\ [])

Deletes a specific static IP from your account.

Link to this function start_instance(input \\ %{}, options \\ [])

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

Link to this function stop_instance(input \\ %{}, options \\ [])

Stops a specific Amazon Lightsail instance that is currently running.

Link to this function unpeer_vpc(input \\ %{}, options \\ [])

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

Link to this function update_domain_entry(input \\ %{}, options \\ [])

Updates a domain recordset after it is created.