Skip to content

Client

lightsail R Documentation

Amazon Lightsail

Description

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.

You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.

Usage

lightsail(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- lightsail(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

allocate_static_ip
Allocates a static IP address
attach_certificate_to_distribution
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution
attach_disk
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name
attach_instances_to_load_balancer
Attaches one or more Lightsail instances to a load balancer
attach_load_balancer_tls_certificate
Attaches a Transport Layer Security (TLS) certificate to your load balancer
attach_static_ip
Attaches a static IP address to a specific Amazon Lightsail instance
close_instance_public_ports
Closes ports for a specific Amazon Lightsail instance
copy_snapshot
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot
create_bucket
Creates an Amazon Lightsail bucket
create_bucket_access_key
Creates a new access key for the specified Amazon Lightsail bucket
create_certificate
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service
create_cloud_formation_stack
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot
create_contact_method
Creates an email or SMS text message contact method
create_container_service
Creates an Amazon Lightsail container service
create_container_service_deployment
Creates a deployment for your Amazon Lightsail container service
create_container_service_registry_login
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine
create_disk
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a)
create_disk_from_snapshot
Creates a block storage disk from a manual or automatic snapshot of a disk
create_disk_snapshot
Creates a snapshot of a block storage disk
create_distribution
Creates an Amazon Lightsail content delivery network (CDN) distribution
create_domain
Creates a domain resource for the specified domain (example
create_domain_entry
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT)
create_gui_session_access_details
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session
create_instances
Creates one or more Amazon Lightsail instances
create_instances_from_snapshot
Creates one or more new instances from a manual or automatic snapshot of an instance
create_instance_snapshot
Creates a snapshot of a specific virtual private server, or instance
create_key_pair
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance
create_load_balancer
Creates a Lightsail load balancer
create_load_balancer_tls_certificate
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer
create_relational_database
Creates a new database in Amazon Lightsail
create_relational_database_from_snapshot
Creates a new database from an existing database snapshot in Amazon Lightsail
create_relational_database_snapshot
Creates a snapshot of your database in Amazon Lightsail
delete_alarm
Deletes an alarm
delete_auto_snapshot
Deletes an automatic snapshot of an instance or disk
delete_bucket
Deletes a Amazon Lightsail bucket
delete_bucket_access_key
Deletes an access key for the specified Amazon Lightsail bucket
delete_certificate
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution
delete_contact_method
Deletes a contact method
delete_container_image
Deletes a container image that is registered to your Amazon Lightsail container service
delete_container_service
Deletes your Amazon Lightsail container service
delete_disk
Deletes the specified block storage disk
delete_disk_snapshot
Deletes the specified disk snapshot
delete_distribution
Deletes your Amazon Lightsail content delivery network (CDN) distribution
delete_domain
Deletes the specified domain recordset and all of its domain records
delete_domain_entry
Deletes a specific domain entry
delete_instance
Deletes an Amazon Lightsail instance
delete_instance_snapshot
Deletes a specific snapshot of a virtual private server (or instance)
delete_key_pair
Deletes the specified key pair by removing the public key from Amazon Lightsail
delete_known_host_keys
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance
delete_load_balancer
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates
delete_load_balancer_tls_certificate
Deletes an SSL/TLS certificate associated with a Lightsail load balancer
delete_relational_database
Deletes a database in Amazon Lightsail
delete_relational_database_snapshot
Deletes a database snapshot in Amazon Lightsail
detach_certificate_from_distribution
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution
detach_disk
Detaches a stopped block storage disk from a Lightsail instance
detach_instances_from_load_balancer
Detaches the specified instances from a Lightsail load balancer
detach_static_ip
Detaches a static IP from the Amazon Lightsail instance to which it is attached
disable_add_on
Disables an add-on for an Amazon Lightsail resource
download_default_key_pair
Downloads the regional Amazon Lightsail default key pair
enable_add_on
Enables or modifies an add-on for an Amazon Lightsail resource
export_snapshot
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2)
get_active_names
Returns the names of all active (not deleted) resources
get_alarms
Returns information about the configured alarms
get_auto_snapshots
Returns the available automatic snapshots for an instance or disk
get_blueprints
Returns the list of available instance images, or blueprints
get_bucket_access_keys
Returns the existing access key IDs for the specified Amazon Lightsail bucket
get_bucket_bundles
Returns the bundles that you can apply to a Amazon Lightsail bucket
get_bucket_metric_data
Returns the data points of a specific metric for an Amazon Lightsail bucket
get_buckets
Returns information about one or more Amazon Lightsail buckets
get_bundles
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it
get_certificates
Returns information about one or more Amazon Lightsail SSL/TLS certificates
get_cloud_formation_stack_records
Returns the CloudFormation stack record created as a result of the create cloud formation stack operation
get_contact_methods
Returns information about the configured contact methods
get_container_api_metadata
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin
get_container_images
Returns the container images that are registered to your Amazon Lightsail container service
get_container_log
Returns the log events of a container of your Amazon Lightsail container service
get_container_service_deployments
Returns the deployments for your Amazon Lightsail container service
get_container_service_metric_data
Returns the data points of a specific metric of your Amazon Lightsail container service
get_container_service_powers
Returns the list of powers that can be specified for your Amazon Lightsail container services
get_container_services
Returns information about one or more of your Amazon Lightsail container services
get_cost_estimate
Retrieves information about the cost estimate for a specified resource
get_disk
Returns information about a specific block storage disk
get_disks
Returns information about all block storage disks in your AWS account and region
get_disk_snapshot
Returns information about a specific block storage disk snapshot
get_disk_snapshots
Returns information about all block storage disk snapshots in your AWS account and region
get_distribution_bundles
Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions
get_distribution_latest_cache_reset
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution
get_distribution_metric_data
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution
get_distributions
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions
get_domain
Returns information about a specific domain recordset
get_domains
Returns a list of all domains in the user's account
get_export_snapshot_records
Returns all export snapshot records created as a result of the export snapshot operation
get_instance
Returns information about a specific Amazon Lightsail instance, which is a virtual private server
get_instance_access_details
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance
get_instance_metric_data
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name
get_instance_port_states
Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol
get_instances
Returns information about all Amazon Lightsail virtual private servers, or instances
get_instance_snapshot
Returns information about a specific instance snapshot
get_instance_snapshots
Returns all instance snapshots for the user's account
get_instance_state
Returns the state of a specific instance
get_key_pair
Returns information about a specific key pair
get_key_pairs
Returns information about all key pairs in the user's account
get_load_balancer
Returns information about the specified Lightsail load balancer
get_load_balancer_metric_data
Returns information about health metrics for your Lightsail load balancer
get_load_balancers
Returns information about all load balancers in an account
get_load_balancer_tls_certificates
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer
get_load_balancer_tls_policies
Returns a list of TLS security policies that you can apply to Lightsail load balancers
get_operation
Returns information about a specific operation
get_operations
Returns information about all operations
get_operations_for_resource
Gets operations for a specific resource (an instance or a static IP)
get_regions
Returns a list of all valid regions for Amazon Lightsail
get_relational_database
Returns information about a specific database in Amazon Lightsail
get_relational_database_blueprints
Returns a list of available database blueprints in Amazon Lightsail
get_relational_database_bundles
Returns the list of bundles that are available in Amazon Lightsail
get_relational_database_events
Returns a list of events for a specific database in Amazon Lightsail
get_relational_database_log_events
Returns a list of log events for a database in Amazon Lightsail
get_relational_database_log_streams
Returns a list of available log streams for a specific database in Amazon Lightsail
get_relational_database_master_user_password
Returns the current, previous, or pending versions of the master user password for a Lightsail database
get_relational_database_metric_data
Returns the data points of the specified metric for a database in Amazon Lightsail
get_relational_database_parameters
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail
get_relational_databases
Returns information about all of your databases in Amazon Lightsail
get_relational_database_snapshot
Returns information about a specific database snapshot in Amazon Lightsail
get_relational_database_snapshots
Returns information about all of your database snapshots in Amazon Lightsail
get_setup_history
Returns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance
get_static_ip
Returns information about an Amazon Lightsail static IP
get_static_ips
Returns information about all static IPs in the user's account
import_key_pair
Imports a public SSH key from a specific key pair
is_vpc_peered
Returns a Boolean value indicating whether your Lightsail VPC is peered
open_instance_public_ports
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol
peer_vpc
Peers the Lightsail VPC with the user's default VPC
put_alarm
Creates or updates an alarm, and associates it with the specified metric
put_instance_public_ports
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol
reboot_instance
Restarts a specific instance
reboot_relational_database
Restarts a specific database in Amazon Lightsail
register_container_image
Registers a container image to your Amazon Lightsail container service
release_static_ip
Deletes a specific static IP from your account
reset_distribution_cache
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution
send_contact_method_verification
Sends a verification request to an email contact method to ensure it's owned by the requester
set_ip_address_type
Sets the IP address type for an Amazon Lightsail resource
set_resource_access_for_bucket
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket
setup_instance_https
Creates an SSL/TLS certificate that secures traffic for your website
start_gui_session
Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application
start_instance
Starts a specific Amazon Lightsail instance from a stopped state
start_relational_database
Starts a specific database from a stopped state in Amazon Lightsail
stop_gui_session
Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application
stop_instance
Stops a specific Amazon Lightsail instance that is currently running
stop_relational_database
Stops a specific database that is currently running in Amazon Lightsail
tag_resource
Adds one or more tags to the specified Amazon Lightsail resource
test_alarm
Tests an alarm by displaying a banner on the Amazon Lightsail console
unpeer_vpc
Unpeers the Lightsail VPC from the user's default VPC
untag_resource
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource
update_bucket
Updates an existing Amazon Lightsail bucket
update_bucket_bundle
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket
update_container_service
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names
update_distribution
Updates an existing Amazon Lightsail content delivery network (CDN) distribution
update_distribution_bundle
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution
update_domain_entry
Updates a domain recordset after it is created
update_instance_metadata_options
Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance
update_load_balancer_attribute
Updates the specified attribute for a load balancer
update_relational_database
Allows the update of one or more attributes of a database in Amazon Lightsail
update_relational_database_parameters
Allows the update of one or more parameters of a database in Amazon Lightsail

Examples

## Not run: 
svc <- lightsail()
svc$allocate_static_ip(
  Foo = 123
)

## End(Not run)