AWS::EC2::IPAMPool

EC2 IPAMPool

Resource Schema of AWS::EC2::IPAMPool Type

Properties

16 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`AddressFamily`	`string`	RequiredCreate-only
`IpamScopeId`	`string`	RequiredCreate-only
`AllocationDefaultNetmaskLength`	`integer`
`AllocationMaxNetmaskLength`	`integer`
`AllocationMinNetmaskLength`	`integer`
`AllocationResourceTags`	`Array<Tag>`
`AutoImport`	`boolean`
`AwsService`	`string`	Create-only
`Description`	`string`
`Locale`	`string`	Create-only
`ProvisionedCidrs`	`Array<ProvisionedCidr>`
`PublicIpSource`	`string`	Create-only
`PubliclyAdvertisable`	`boolean`	Create-only
`SourceIpamPoolId`	`string`	Create-only
`SourceResource`	`SourceResource`	Create-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	The Amazon Resource Name (ARN) of the IPAM Pool.
`IpamArn`	`string`	The Amazon Resource Name (ARN) of the IPAM this pool is a part of.
`IpamPoolId`	`string`	Id of the IPAM Pool.
`IpamScopeArn`	`string`	The Amazon Resource Name (ARN) of the scope this pool is a part of.
`IpamScopeType`	`string`	Determines whether this scope contains publicly routable space or space for a private network
`PoolDepth`	`integer`	The depth of this pool in the source pool hierarchy.
`State`	`string`	The state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"
`StateMessage`	`string`	An explanation of how the pool arrived at it current state.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::EC2::IPAMPool

Resources:
  MyResource:
    Type: AWS::EC2::IPAMPool
    Properties:
      IpamScopeId: "my-ipamscopeid"
      AddressFamily: "value"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

ec2:CreateIpamPoolec2:DescribeIpamPoolsec2:ProvisionIpamPoolCidrec2:GetIpamPoolCidrsec2:CreateTags

read

ec2:DescribeIpamPoolsec2:GetIpamPoolCidrs

update

ec2:ModifyIpamPoolec2:DescribeIpamPoolsec2:GetIpamPoolCidrsec2:ProvisionIpamPoolCidrec2:DeprovisionIpamPoolCidrec2:CreateTagsec2:DeleteTags

delete

ec2:DeleteIpamPoolec2:DescribeIpamPoolsec2:GetIpamPoolCidrsec2:DeprovisionIpamPoolCidrec2:DeleteTags

list

ec2:DescribeIpamPools

Get the EC2 Cheat Sheet

Everything you need to know about EC2 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceEC2

Properties24

Required2

TaggingSupported

Primary IDIpamPoolId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

IpamScopeIdSourceIpamPoolIdLocaleAddressFamilyPubliclyAdvertisablePublicIpSourceAwsServiceSourceResource

Related Resources

External Links

AWS Documentation