Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. getIpamPool

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.getIpamPool

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Schema of AWS::EC2::IPAMPool Type

    Using getIpamPool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIpamPool(args: GetIpamPoolArgs, opts?: InvokeOptions): Promise<GetIpamPoolResult>
function getIpamPoolOutput(args: GetIpamPoolOutputArgs, opts?: InvokeOptions): Output<GetIpamPoolResult>
    def get_ipam_pool(ipam_pool_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetIpamPoolResult
def get_ipam_pool_output(ipam_pool_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetIpamPoolResult]
    func LookupIpamPool(ctx *Context, args *LookupIpamPoolArgs, opts ...InvokeOption) (*LookupIpamPoolResult, error)
func LookupIpamPoolOutput(ctx *Context, args *LookupIpamPoolOutputArgs, opts ...InvokeOption) LookupIpamPoolResultOutput

    > Note: This function is named LookupIpamPool in the Go SDK.

    public static class GetIpamPool 
{
    public static Task<GetIpamPoolResult> InvokeAsync(GetIpamPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetIpamPoolResult> Invoke(GetIpamPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIpamPoolResult> getIpamPool(GetIpamPoolArgs args, InvokeOptions options)
public static Output<GetIpamPoolResult> getIpamPool(GetIpamPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:ec2:getIpamPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    IpamPoolId string
    Id of the IPAM Pool.
    IpamPoolId string
    Id of the IPAM Pool.
    ipamPoolId String
    Id of the IPAM Pool.
    ipamPoolId string
    Id of the IPAM Pool.
    ipam_pool_id str
    Id of the IPAM Pool.
    ipamPoolId String
    Id of the IPAM Pool.

    getIpamPool Result

    The following output properties are available:

    AllocationDefaultNetmaskLength int
    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 int
    The maximum allowed netmask length for allocations made from this pool.
    AllocationMinNetmaskLength int
    The minimum allowed netmask length for allocations made from this pool.
    AllocationResourceTags List<Pulumi.AwsNative.Ec2.Outputs.IpamPoolTag>
    When specified, an allocation will not be allowed unless a resource has a matching set of tags.
    Arn string
    The Amazon Resource Name (ARN) of the IPAM Pool.
    AutoImport bool
    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.
    Description string
    The description 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 Pulumi.AwsNative.Ec2.IpamPoolIpamScopeType
    Determines whether this scope contains publicly routable space or space for a private network
    PoolDepth int
    The depth of this pool in the source pool hierarchy.
    ProvisionedCidrs List<Pulumi.AwsNative.Ec2.Outputs.IpamPoolProvisionedCidr>
    A list of cidrs representing the address space available for allocation in this pool.
    State Pulumi.AwsNative.Ec2.IpamPoolState
    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.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    AllocationDefaultNetmaskLength int
    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 int
    The maximum allowed netmask length for allocations made from this pool.
    AllocationMinNetmaskLength int
    The minimum allowed netmask length for allocations made from this pool.
    AllocationResourceTags []IpamPoolTag
    When specified, an allocation will not be allowed unless a resource has a matching set of tags.
    Arn string
    The Amazon Resource Name (ARN) of the IPAM Pool.
    AutoImport bool
    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.
    Description string
    The description 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 IpamPoolIpamScopeType
    Determines whether this scope contains publicly routable space or space for a private network
    PoolDepth int
    The depth of this pool in the source pool hierarchy.
    ProvisionedCidrs []IpamPoolProvisionedCidr
    A list of cidrs representing the address space available for allocation in this pool.
    State IpamPoolStateEnum
    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.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    allocationDefaultNetmaskLength Integer
    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 Integer
    The maximum allowed netmask length for allocations made from this pool.
    allocationMinNetmaskLength Integer
    The minimum allowed netmask length for allocations made from this pool.
    allocationResourceTags List<IpamPoolTag>
    When specified, an allocation will not be allowed unless a resource has a matching set of tags.
    arn String
    The Amazon Resource Name (ARN) of the IPAM Pool.
    autoImport Boolean
    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.
    description String
    The description 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 IpamPoolIpamScopeType
    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.
    provisionedCidrs List<IpamPoolProvisionedCidr>
    A list of cidrs representing the address space available for allocation in this pool.
    state IpamPoolState
    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.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    allocationDefaultNetmaskLength number
    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
    The maximum allowed netmask length for allocations made from this pool.
    allocationMinNetmaskLength number
    The minimum allowed netmask length for allocations made from this pool.
    allocationResourceTags IpamPoolTag[]
    When specified, an allocation will not be allowed unless a resource has a matching set of tags.
    arn string
    The Amazon Resource Name (ARN) of the IPAM Pool.
    autoImport boolean
    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.
    description string
    The description 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 IpamPoolIpamScopeType
    Determines whether this scope contains publicly routable space or space for a private network
    poolDepth number
    The depth of this pool in the source pool hierarchy.
    provisionedCidrs IpamPoolProvisionedCidr[]
    A list of cidrs representing the address space available for allocation in this pool.
    state IpamPoolState
    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.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    allocation_default_netmask_length int
    The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.
    allocation_max_netmask_length int
    The maximum allowed netmask length for allocations made from this pool.
    allocation_min_netmask_length int
    The minimum allowed netmask length for allocations made from this pool.
    allocation_resource_tags Sequence[IpamPoolTag]
    When specified, an allocation will not be allowed unless a resource has a matching set of tags.
    arn str
    The Amazon Resource Name (ARN) of the IPAM Pool.
    auto_import bool
    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.
    description str
    The description of the IPAM pool.
    ipam_arn str
    The Amazon Resource Name (ARN) of the IPAM this pool is a part of.
    ipam_pool_id str
    Id of the IPAM Pool.
    ipam_scope_arn str
    The Amazon Resource Name (ARN) of the scope this pool is a part of.
    ipam_scope_type IpamPoolIpamScopeType
    Determines whether this scope contains publicly routable space or space for a private network
    pool_depth int
    The depth of this pool in the source pool hierarchy.
    provisioned_cidrs Sequence[IpamPoolProvisionedCidr]
    A list of cidrs representing the address space available for allocation in this pool.
    state IpamPoolState
    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"
    state_message str
    An explanation of how the pool arrived at it current state.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    allocationDefaultNetmaskLength Number
    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
    The maximum allowed netmask length for allocations made from this pool.
    allocationMinNetmaskLength Number
    The minimum allowed netmask length for allocations made from this pool.
    allocationResourceTags List<Property Map>
    When specified, an allocation will not be allowed unless a resource has a matching set of tags.
    arn String
    The Amazon Resource Name (ARN) of the IPAM Pool.
    autoImport Boolean
    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.
    description String
    The description 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 "public" | "private"
    Determines whether this scope contains publicly routable space or space for a private network
    poolDepth Number
    The depth of this pool in the source pool hierarchy.
    provisionedCidrs List<Property Map>
    A list of cidrs representing the address space available for allocation in this pool.
    state "create-in-progress" | "create-complete" | "modify-in-progress" | "modify-complete" | "delete-in-progress" | "delete-complete"
    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.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    IpamPoolIpamScopeType

    IpamPoolProvisionedCidr

    Cidr string
    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 .
    Cidr string
    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 .
    cidr String
    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 .
    cidr string
    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 .
    cidr str
    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 .
    cidr String
    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 .

    IpamPoolState

    IpamPoolTag

    Key string
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    Value string
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    Key string
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    Value string
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    key String
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    value String
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    key string
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    value string
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    key str
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    value str
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    key String
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    value String
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws-native