ipam_policy_allocation_rules

Creates, updates, deletes, gets or lists an ipam_policy_allocation_rules resource.

Overview

Name	ipam_policy_allocation_rules
Type	Resource
Id	aws.ec2.ipam_policy_allocation_rules

Fields

The following fields are returned by SELECT queries:

get_ipam_policy_allocation_rules

Name	Datatype	Description
ipam_policy_documents	string	The IPAM policy documents containing the allocation rules. Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.
next_token	string	The token to use to retrieve the next page of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ipam_policy_allocation_rules	select	IpamPolicyId, region	DryRun, Filter, Locale, ResourceType, MaxResults, NextToken	Gets the allocation rules 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. Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.
modify_ipam_policy_allocation_rules	update	IpamPolicyId, ResourceType, region	DryRun, Locale, AllocationRule	Modifies the allocation rules in 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. Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided 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
IpamPolicyId	string	The ID of the IPAM policy whose allocation rules you want to modify.
ResourceType	string	The resource type for which to modify the allocation rules. The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include: Elastic IP addresses
region	string	AWS region (default: us-east-1)
AllocationRule	array	The new allocation rules to apply to the IPAM policy. Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.
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 allocation rules.
Locale	string	The locale for which to modify the allocation rules.
MaxResults	integer	The maximum number of results to return in a single call.
NextToken	string	The token for the next page of results.
ResourceType	string	The resource type for which to get the allocation rules. The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include: Elastic IP addresses

SELECT examples

get_ipam_policy_allocation_rules

Gets the allocation rules 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. Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.

SELECT
ipam_policy_documents,
next_token
FROM aws.ec2.ipam_policy_allocation_rules
WHERE IpamPolicyId = '{{ IpamPolicyId }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND Locale = '{{ Locale }}'
AND ResourceType = '{{ ResourceType }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

UPDATE examples

modify_ipam_policy_allocation_rules

Modifies the allocation rules in 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. Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.

UPDATE aws.ec2.ipam_policy_allocation_rules
SET 
-- No updatable properties
WHERE 
IpamPolicyId = '{{ IpamPolicyId }}' --required
AND ResourceType = '{{ ResourceType }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND Locale = '{{ Locale}}'
AND AllocationRule = '{{ AllocationRule}}'
RETURNING
allocation_rules,
ipam_policy_id,
locale,
resource_type;