static_ips

Creates, updates, deletes or gets a static_ip resource or lists static_ips in a region

Overview

Name	static_ips
Type	Resource
Description	Resource Type definition for AWS::Lightsail::StaticIp
Id	aws.lightsail.static_ips

Fields

Name	Datatype	Description
static_ip_name	string	The name of the static IP address.
attached_to	string	The instance where the static IP is attached.
is_attached	boolean	A Boolean value indicating whether the static IP is attached.
ip_address	string	The static IP address.
static_ip_arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	StaticIpName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all static_ips in a region.

SELECT
region,
static_ip_name,
attached_to,
is_attached,
ip_address,
static_ip_arn
FROM aws.lightsail.static_ips
WHERE region = 'us-east-1';

Gets all properties from an individual static_ip.

SELECT
region,
static_ip_name,
attached_to,
is_attached,
ip_address,
static_ip_arn
FROM aws.lightsail.static_ips
WHERE region = 'us-east-1' AND data__Identifier = '<StaticIpName>';

INSERT example

Use the following StackQL query and manifest file to create a new static_ip resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.lightsail.static_ips (
 StaticIpName,
 region
)
SELECT 
'{{ StaticIpName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.lightsail.static_ips (
 StaticIpName,
 AttachedTo,
 region
)
SELECT 
 '{{ StaticIpName }}',
 '{{ AttachedTo }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: static_ip
    props:
      - name: StaticIpName
        value: '{{ StaticIpName }}'
      - name: AttachedTo
        value: '{{ AttachedTo }}'

DELETE example

/*+ delete */
DELETE FROM aws.lightsail.static_ips
WHERE data__Identifier = '<StaticIpName>'
AND region = 'us-east-1';

Permissions

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

Create

lightsail:AllocateStaticIp,
lightsail:AttachStaticIp,
lightsail:DetachStaticIp,
lightsail:GetInstance,
lightsail:GetStaticIp,
lightsail:GetStaticIps

Read

lightsail:GetStaticIp,
lightsail:GetStaticIps

Update

lightsail:AttachStaticIp,
lightsail:DetachStaticIp,
lightsail:GetInstance,
lightsail:GetStaticIp,
lightsail:GetStaticIps

Delete

lightsail:GetStaticIp,
lightsail:GetStaticIps,
lightsail:ReleaseStaticIp

List

lightsail:GetStaticIps