ipv6_pools
Creates, updates, deletes, gets or lists an ipv6_pools resource.
Overview
| Name | ipv6_pools |
| Type | Resource |
| Id | aws.ec2.ipv6_pools |
Fields
The following fields are returned by SELECT queries:
- describe_ipv6_pools
| Name | Datatype | Description |
|---|---|---|
description | string | The description for the address pool. |
pool_cidr_blocks | string | The CIDR blocks for the address pool. |
pool_id | string | The ID of the address pool. |
tags | string | Any tags for the address pool. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_ipv6_pools | select | region | PoolId, NextToken, MaxResults, DryRun, Filter | Describes your IPv6 address pools. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
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. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. |
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 IPv6 address pools. |
SELECT examples
- describe_ipv6_pools
Describes your IPv6 address pools.
SELECT
description,
pool_cidr_blocks,
pool_id,
tags
FROM aws.ec2.ipv6_pools
WHERE region = '{{ region }}' -- required
AND PoolId = '{{ PoolId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
;