# IpamPolicyDocument
<a name="API_IpamPolicyDocument"></a>

Information about an IPAM policy.

## Contents
<a name="API_IpamPolicyDocument_Contents"></a>

 ** AllocationRuleSet.N **   
The allocation rules in the IPAM policy document.  
Allocation rules are optional configurations within an IPAM policy that map Amazon resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.  
Type: Array of [IpamPolicyAllocationRule](API_IpamPolicyAllocationRule.md) objects  
Required: No

 ** ipamPolicyId **   
The ID of the IPAM policy.  
Type: String  
Required: No

 ** locale **   
The locale of the IPAM policy document.  
Type: String  
Required: No

 ** resourceType **   
The resource type of the IPAM policy document.  
The Amazon service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:  
+ Elastic IP addresses
Type: String  
Valid Values: `alb | eip | rds | rnat`   
Required: No

## See Also
<a name="API_IpamPolicyDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ec2-2016-11-15/IpamPolicyDocument) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ec2-2016-11-15/IpamPolicyDocument) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ec2-2016-11-15/IpamPolicyDocument)