coip_pools

Creates, updates, deletes, gets or lists a coip_pools resource.

Overview

Name	coip_pools
Type	Resource
Id	aws.ec2.coip_pools

Fields

The following fields are returned by SELECT queries:

describe_coip_pools

Name	Datatype	Description
local_gateway_route_table_id	string	The ID of the local gateway route table.
pool_arn	string	The ARN of the address pool.
pool_cidrs	string	The address ranges of the address pool.
pool_id	string	The ID of the address pool.
tags	string	The tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_coip_pools	select	region	PoolId, Filter, MaxResults, NextToken, DryRun	Describes the specified customer-owned address pools or all of your customer-owned address pools.
create_coip_cidr	insert	CoipPoolId, region	Cidr, DryRun	Creates a range of customer-owned IP addresses.
create_coip_pool	insert	LocalGatewayRouteTableId, region	TagSpecification, DryRun	Creates a pool of customer-owned IP (CoIP) addresses.
delete_coip_pool	delete	CoipPoolId, region	DryRun	Deletes a pool of customer-owned IP (CoIP) addresses.
delete_coip_cidr	exec	CoipPoolId, region	Cidr, DryRun	Deletes a range of customer-owned IP addresses.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
CoipPoolId	string	The ID of the customer-owned address pool.
LocalGatewayRouteTableId	string	The ID of the local gateway route table.
region	string	AWS region (default: us-east-1)
Cidr	string	A customer-owned IP address range that you want to delete.
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	One or more filters. coip-pool.local-gateway-route-table-id - The ID of the local gateway route table. coip-pool.pool-id - The ID of the address pool.
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NextToken	string	The token for the next page of results.
PoolId	array	The IDs of the address pools.
TagSpecification	array	The tags to assign to the CoIP address pool.

SELECT examples

describe_coip_pools

Describes the specified customer-owned address pools or all of your customer-owned address pools.

SELECT
local_gateway_route_table_id,
pool_arn,
pool_cidrs,
pool_id,
tags
FROM aws.ec2.coip_pools
WHERE region = '{{ region }}' -- required
AND PoolId = '{{ PoolId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_coip_cidr

Creates a range of customer-owned IP addresses.

INSERT INTO aws.ec2.coip_pools (
CoipPoolId,
region,
Cidr,
DryRun
)
SELECT 
'{{ CoipPoolId }}',
'{{ region }}',
'{{ Cidr }}',
'{{ DryRun }}'
RETURNING
cidr,
coip_pool_id,
local_gateway_route_table_id
;

create_coip_pool

Creates a pool of customer-owned IP (CoIP) addresses.

INSERT INTO aws.ec2.coip_pools (
LocalGatewayRouteTableId,
region,
TagSpecification,
DryRun
)
SELECT 
'{{ LocalGatewayRouteTableId }}',
'{{ region }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
local_gateway_route_table_id,
pool_arn,
pool_cidrs,
pool_id,
tags
;

Manifest

# Description fields are for documentation purposes
- name: coip_pools
props:
  - name: CoipPoolId
    value: "{{ CoipPoolId }}"
    description: Required parameter for the coip_pools resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the coip_pools resource.
  - name: LocalGatewayRouteTableId
    value: "{{ LocalGatewayRouteTableId }}"
    description: Required parameter for the coip_pools resource.
  - name: Cidr
    value: "{{ Cidr }}"
    description: A customer-owned IP address range to create.
    description: A customer-owned IP address range to create.
  - name: DryRun
    value: {{ DryRun }}
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to assign to the CoIP address pool.
    description: The tags to assign to the CoIP address pool.

DELETE examples

delete_coip_pool

Deletes a pool of customer-owned IP (CoIP) addresses.

DELETE FROM aws.ec2.coip_pools
WHERE CoipPoolId = '{{ CoipPoolId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;

Lifecycle Methods

delete_coip_cidr

Deletes a range of customer-owned IP addresses.

EXEC aws.ec2.coip_pools.delete_coip_cidr 
@CoipPoolId='{{ CoipPoolId }}' --required, 
@region='{{ region }}' --required, 
@Cidr='{{ Cidr }}', 
@DryRun={{ DryRun }}
;