AWS::EC2::IPAM - AWS CloudFormation


IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide.


To declare this entity in your AWS CloudFormation template, use the following syntax:


{ "Type" : "AWS::EC2::IPAM", "Properties" : { "Description" : String, "OperatingRegions" : [ IpamOperatingRegion, ... ], "Tags" : [ Tag, ... ], "Tier" : String } }


Type: AWS::EC2::IPAM Properties: Description: String OperatingRegions: - IpamOperatingRegion Tags: - Tag Tier: String



The description for the IPAM.

Required: No

Type: String

Update requires: No interruption


The operating Regions for an IPAM. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

Required: No

Type: Array of IpamOperatingRegion

Update requires: No interruption


The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Required: No

Type: Array of Tag

Update requires: No interruption


IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see the VPC IPAM product pricing page.

Required: No

Type: String

Allowed values: free | advanced

Update requires: No interruption

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the IPAM ID.

For more information about using the Ref function, see Ref.


The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.


The ARN of the IPAM.


The ID of the default resource discovery association.


The ID of the default resource discovery.


The ID of the IPAM.


The ID of the default private scope.


The ID of the default public scope.


The number of resource discovery associations.


The number of scopes.