enabled_ipam_policies
Creates, updates, deletes, gets or lists an enabled_ipam_policies resource.
Overview
| Name | enabled_ipam_policies |
| Type | Resource |
| Id | aws.ec2.enabled_ipam_policies |
Fields
The following fields are returned by SELECT queries:
- get_enabled_ipam_policy
| Name | Datatype | Description |
|---|---|---|
ipam_policy_enabled | boolean | Indicates whether the IPAM policy is enabled. |
ipam_policy_id | string | The ID of the enabled IPAM policy. |
managed_by | string | The entity that manages the IPAM policy. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_enabled_ipam_policy | select | region | DryRun | Gets the enabled IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations. |
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 | A check for 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. |
SELECT examples
- get_enabled_ipam_policy
Gets the enabled IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
SELECT
ipam_policy_enabled,
ipam_policy_id,
managed_by
FROM aws.ec2.enabled_ipam_policies
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
;