---
type: resource-type
title: IPAMPool
description: aws resource type AWS::EC2::IPAMPool
name: IPAMPool
lexicon: aws
resource_type: AWS::EC2::IPAMPool
---
`AWS::EC2::IPAMPool`, a resource type of the aws lexicon.

## Properties

- `AddressFamily` (`string`, required): The address family of the address space in this pool. Either IPv4 or IPv6.
- `IpamScopeId` (`string`, required): The Id of the scope this pool is a part of.
- `AllocationDefaultNetmaskLength` (`number`, optional): The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.
- `AllocationMaxNetmaskLength` (`number`, optional): The maximum allowed netmask length for allocations made from this pool.
- `AllocationMinNetmaskLength` (`number`, optional): The minimum allowed netmask length for allocations made from this pool.
- `AllocationResourceTags` (`IPAMPool_Tag[]`, optional): When specified, an allocation will not be allowed unless a resource has a matching set of tags.
- `Arn` (`string`, optional): The Amazon Resource Name (ARN) of the IPAM Pool.
- `AutoImport` (`boolean`, optional): Determines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically.
- `AwsService` (`"ec2" | "global-services"`, optional): Limits which service in Amazon Web Services that the pool can be used in.
- `Description` (`string`, optional)
- `IpamArn` (`string`, optional): The Amazon Resource Name (ARN) of the IPAM this pool is a part of.
- `IpamPoolId` (`string`, optional): Id of the IPAM Pool.
- `IpamScopeArn` (`string`, optional): The Amazon Resource Name (ARN) of the scope this pool is a part of.
- `IpamScopeType` (`"private" | "public"`, optional): Determines whether this scope contains publicly routable space or space for a private network
- `Locale` (`string`, optional): The region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match.
- `PoolDepth` (`number`, optional): The depth of this pool in the source pool hierarchy.
- `ProvisionedCidrs` (`IPAMPool_ProvisionedCidr[]`, optional): A list of cidrs representing the address space available for allocation in this pool.
- `PublicIpSource` (`"amazon" | "byoip"`, optional): The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.
- `PubliclyAdvertisable` (`boolean`, optional): Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
- `SourceIpamPoolId` (`string`, optional): The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.
- `SourceResource` (`IPAMPool_SourceResource`, optional)
- `State` (`"create-complete" | "create-in-progress" | "delete-complete" | "delete-in-progress" | "modify-complete" | "modify-in-progress"`, optional): 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`, optional): An explanation of how the pool arrived at it current state.
- `Tags` (`IPAMPool_Tag[]`, optional): An array of key-value pairs to apply to this resource.

## Attributes

- `Arn`
- `IpamArn`
- `IpamPoolId`
- `IpamScopeArn`
- `IpamScopeType`
- `PoolDepth`
- `State`
- `StateMessage`