instance

Gets an individual instance resource

Overview

Name	instance
Type	Resource
Description	instance
Id	awscc.lightsail.instance

Fields

Name	Datatype	Description
support_code	string	Support code to help identify any issues
resource_type	string	Resource type of Lightsail instance.
is_static_ip	boolean	Is the IP Address of the Instance is the static IP
private_ip_address	string	Private IP Address of the Instance
public_ip_address	string	Public IP Address of the Instance
location	object
hardware	object
state	object
networking	object
user_name	string	Username of the Lightsail instance.
ssh_key_name	string	SSH Key Name of the Lightsail instance.
instance_name	string	The names to use for your new Lightsail instance.
availability_zone	string	The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
bundle_id	string	The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
blueprint_id	string	The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
add_ons	array	An array of objects representing the add-ons to enable for the new instance.
user_data	string	A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
key_pair_name	string	The name of your key pair.
tags	array	An array of key-value pairs to apply to this resource.
instance_arn	string
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
support_code,
resource_type,
is_static_ip,
private_ip_address,
public_ip_address,
location,
hardware,
state,
networking,
user_name,
ssh_key_name,
instance_name,
availability_zone,
bundle_id,
blueprint_id,
add_ons,
user_data,
key_pair_name,
tags,
instance_arn
FROM awscc.lightsail.instance
WHERE data__Identifier = '<InstanceName>';

Permissions

To operate on the instance resource, the following permissions are required:

Read

lightsail:GetInstances,
lightsail:GetInstance

Delete

lightsail:GetInstances,
lightsail:GetInstance,
lightsail:DeleteInstance

Update

lightsail:GetInstances,
lightsail:GetInstance,
lightsail:DeleteInstance,
lightsail:EnableAddOn,
lightsail:DisableAddOn,
lightsail:PutInstancePublicPorts,
lightsail:AttachDisk,
lightsail:DetachDisk,
lightsail:StartInstance,
lightsail:StopInstance,
lightsail:GetDisk,
lightsail:TagResource,
lightsail:UntagResource