ipam_policy_organization_targets
Creates, updates, deletes, gets or lists an ipam_policy_organization_targets resource.
Overview
| Name | ipam_policy_organization_targets |
| Type | Resource |
| Id | aws.ec2.ipam_policy_organization_targets |
Fields
The following fields are returned by SELECT queries:
- get_ipam_policy_organization_targets
| Name | Datatype | Description |
|---|---|---|
next_token | string | The token to use to retrieve the next page of results. |
organization_targets | string | The IDs of the Amazon Web Services Organizations targets. A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_ipam_policy_organization_targets | select | IpamPolicyId, region | DryRun, MaxResults, NextToken, Filter | Gets the Amazon Web Services Organizations targets for an 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. A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied. |
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 |
|---|---|---|
IpamPolicyId | string | The ID of the IPAM policy for which to get Amazon Web Services Organizations targets. |
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. |
Filter | array | One or more filters for the Amazon Web Services Organizations targets. |
MaxResults | integer | The maximum number of results to return in a single call. |
NextToken | string | The token for the next page of results. |
SELECT examples
- get_ipam_policy_organization_targets
Gets the Amazon Web Services Organizations targets for an 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. A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied.
SELECT
next_token,
organization_targets
FROM aws.ec2.ipam_policy_organization_targets
WHERE IpamPolicyId = '{{ IpamPolicyId }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND Filter = '{{ Filter }}'
;