IpamPolicy
Information about an IPAM policy.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS 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 AWS 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 AWS account or an entity within AWS Organizations.
Contents
- ipamId
-
The ID of the IPAM this policy belongs to.
Type: String
Required: No
- ipamPolicyArn
-
The Amazon Resource Name (ARN) of the IPAM policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1283.
Required: No
- ipamPolicyId
-
The ID of the IPAM policy.
Type: String
Required: No
- ipamPolicyRegion
-
The Region of the IPAM policy.
Type: String
Required: No
- ownerId
-
The account ID that owns the IPAM policy.
Type: String
Required: No
- state
-
The state of the IPAM policy.
Type: String
Valid Values:
create-in-progress | create-complete | create-failed | modify-in-progress | modify-complete | modify-failed | delete-in-progress | delete-complete | delete-failed | isolate-in-progress | isolate-complete | restore-in-progressRequired: No
- stateMessage
-
A message about the state of the IPAM policy.
Type: String
Required: No
- tagSet
-
The tags assigned to the IPAM policy.
Type: Array of Tag objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
