eip_associations

Creates, updates, deletes or gets an eip_association resource or lists eip_associations in a region

Overview

Name	eip_associations
Type	Resource
Description	Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. For more information about working with Elastic IP addresses, see [Elastic IP address concepts and rules](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#vpc-eip-overview). You must specify ``AllocationId`` and either ``InstanceId``, ``NetworkInterfaceId``, or ``PrivateIpAddress``.
Id	awscc.ec2.eip_associations

Fields

get (all properties)

Name	Datatype	Description
private_ip_address	string	The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
instance_id	string	The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both.
allocation_id	string	The allocation ID. This is required.
id	string
network_interface_id	string	The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.<br />You can specify either the instance ID or the network interface ID, but not both.
e_ip	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

For more information, see AWS::EC2::EIPAssociation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	eip_associations	INSERT	region
delete_resource	eip_associations	DELETE	Identifier, region
list_resources	eip_associations_list_only	SELECT	region
get_resource	eip_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual eip_association.

SELECT
  region,
  private_ip_address,
  instance_id,
  allocation_id,
  id,
  network_interface_id,
  e_ip
FROM awscc.ec2.eip_associations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all eip_associations in a region.

SELECT
  region,
  id
FROM awscc.ec2.eip_associations_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.eip_associations (
  PrivateIpAddress,
  InstanceId,
  AllocationId,
  NetworkInterfaceId,
  EIP,
  region
)
SELECT
  '{{ private_ip_address }}',
  '{{ instance_id }}',
  '{{ allocation_id }}',
  '{{ network_interface_id }}',
  '{{ e_ip }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.eip_associations (
  PrivateIpAddress,
  InstanceId,
  AllocationId,
  NetworkInterfaceId,
  EIP,
  region
)
SELECT
  '{{ private_ip_address }}',
  '{{ instance_id }}',
  '{{ allocation_id }}',
  '{{ network_interface_id }}',
  '{{ e_ip }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: eip_association
    props:
      - name: private_ip_address
        value: '{{ private_ip_address }}'
      - name: instance_id
        value: '{{ instance_id }}'
      - name: allocation_id
        value: '{{ allocation_id }}'
      - name: network_interface_id
        value: '{{ network_interface_id }}'
      - name: e_ip
        value: '{{ e_ip }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.eip_associations
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions

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

Read

ec2:DescribeAddresses

Create

ec2:DescribeAddresses,
ec2:AssociateAddress

List

ec2:DescribeAddresses

Delete

ec2:DisassociateAddress,
ec2:DescribeAddresses