Skip to main content

instance_tags

Expands all tag keys and values for instances in a region

Overview

Nameinstance_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Instance
Idaws.lightsail.instance_tags

Fields

NameDatatypeDescription
support_codestringSupport code to help identify any issues
resource_typestringResource type of Lightsail instance.
is_static_ipbooleanIs the IP Address of the Instance is the static IP
private_ip_addressstringPrivate IP Address of the Instance
public_ip_addressstringPublic IP Address of the Instance
ipv6_addressesarrayIPv6 addresses of the instance
locationobjectLocation of a resource.
hardwareobjectHardware of the Instance.
stateobjectCurrent State of the Instance.
networkingobjectNetworking of the Instance.
user_namestringUsername of the Lightsail instance.
ssh_key_namestringSSH Key Name of the Lightsail instance.
instance_namestringThe names to use for your new Lightsail instance.
availability_zonestringThe 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_idstringThe bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
blueprint_idstringThe 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_onsarrayAn array of objects representing the add-ons to enable for the new instance.
user_datastringA 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_namestringThe name of your key pair.
instance_arnstring
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all instances in a region.

SELECT
region,
support_code,
resource_type,
is_static_ip,
private_ip_address,
public_ip_address,
ipv6_addresses,
location,
hardware,
state,
networking,
user_name,
ssh_key_name,
instance_name,
availability_zone,
bundle_id,
blueprint_id,
add_ons,
user_data,
key_pair_name,
instance_arn,
tag_key,
tag_value
FROM aws.lightsail.instance_tags
WHERE region = 'us-east-1';

Permissions

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