coip_pool_usages
Creates, updates, deletes, gets or lists a coip_pool_usages resource.
Overview
| Name | coip_pool_usages |
| Type | Resource |
| Id | aws.ec2.coip_pool_usages |
Fields
The following fields are returned by SELECT queries:
- get_coip_pool_usage
| Name | Datatype | Description |
|---|---|---|
coip_address_usages | string | Information about the address usage. |
coip_pool_id | string | The ID of the customer-owned address pool. |
local_gateway_route_table_id | string | The ID of the local gateway route table. |
next_token | string | The token to use to retrieve the next page of results. This value is null when there are no more results to return. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_coip_pool_usage | select | PoolId, region | Filter, MaxResults, NextToken, DryRun | Describes the allocations from the specified customer-owned address pool. |
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 |
|---|---|---|
PoolId | string | The ID of the address pool. |
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. coip-address-usage.allocation-id - The allocation ID of the address. coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address. coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address. coip-address-usage.co-ip - The customer-owned IP address. |
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. |
SELECT examples
- get_coip_pool_usage
Describes the allocations from the specified customer-owned address pool.
SELECT
coip_address_usages,
coip_pool_id,
local_gateway_route_table_id,
next_token
FROM aws.ec2.coip_pool_usages
WHERE PoolId = '{{ PoolId }}' -- required
AND region = '{{ region }}' -- required
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;