AWS::EC2::IPAMPoolCidr - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::EC2::IPAMPoolCidr

A CIDR provisioned to an IPAM pool.

Syntax

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

JSON

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

YAML

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

Properties

Cidr

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 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

Required: No

Type: String

Update requires: Replacement

IpamPoolId

The ID of the IPAM pool.

Required: Yes

Type: String

Update requires: Replacement

NetmaskLength

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

Ref

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.

Fn::GetAtt

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.

IpamPoolCidrId

The IPAM pool CIDR ID.

State

The state of the CIDR.