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	awscc.lightsail.static_ips

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
static_ip_name	string	The name of the static IP address.
region	string	AWS region.

For more information, see AWS::Lightsail::StaticIp.

Methods

Name	Resource	Accessible by	Required Params
create_resource	static_ips	INSERT	StaticIpName, region
delete_resource	static_ips	DELETE	Identifier, region
update_resource	static_ips	UPDATE	Identifier, PatchDocument, region
list_resources	static_ips_list_only	SELECT	region
get_resource	static_ips	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual static_ip.

SELECT
  region,
  static_ip_name,
  attached_to,
  is_attached,
  ip_address,
  static_ip_arn
FROM awscc.lightsail.static_ips
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ static_ip_name }}';

list (identifiers only)

Lists all static_ips in a region.

SELECT
  region,
  static_ip_name
FROM awscc.lightsail.static_ips_list_only
WHERE
  region = '{{ region }}';

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 awscc.lightsail.static_ips (
  StaticIpName,
  region
)
SELECT
  '{{ static_ip_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.lightsail.static_ips (
  StaticIpName,
  AttachedTo,
  region
)
SELECT
  '{{ static_ip_name }}',
  '{{ attached_to }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

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

UPDATE example

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

/*+ update */
UPDATE awscc.lightsail.static_ips
SET PatchDocument = string('{{ {
    "AttachedTo": attached_to
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ static_ip_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.lightsail.static_ips
WHERE
  Identifier = '{{ static_ip_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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