instances_list_only

Lists instances in a region or regions, for all properties use instances

Overview

Name	instances_list_only
Type	Resource
Description	Resource Type definition for AWS::Lightsail::Instance
Id	aws.lightsail.instances_list_only

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
ipv6_addresses	array	IPv6 addresses of the instance
location	object	Location of a resource.
hardware	object	Hardware of the Instance.
state	object	Current State of the Instance.
networking	object	Networking of the Instance.
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

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all instances in a region.

SELECT
region,
instance_name
FROM aws.lightsail.instances_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the instances_list_only resource, see instances