AWS::EC2::IPAMPoolCidr - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


A CIDR provisioned to an IPAM pool.


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


{ "Type" : "AWS::EC2::IPAMPoolCidr", "Properties" : { "Cidr" : String, "IpamPoolId" : String, "NetmaskLength" : Integer } }


Type: AWS::EC2::IPAMPoolCidr Properties: Cidr: String IpamPoolId: String NetmaskLength: Integer



The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is An IPv6 CIDR example is 2001:DB8::/32.

Required: No

Type: String

Update requires: Replacement


The ID of the IPAM pool.

Required: Yes

Type: String

Update requires: Replacement


The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.

Required: No

Type: Integer

Update requires: Replacement

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the IPAM pool ID and IPAM pool CIDR ID in the following format: ipam-pool-01123456|ipam-pool-cidr-0123456.


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 IPAM pool CIDR ID.


The state of the CIDR.