AWS Native

v0.44.0 published on Wednesday, Dec 7, 2022 by Pulumi

getIPAMPool

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)
// Output-based functions aren't available in Java yet

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
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.EC2.Outputs.IPAMPoolTag>: 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
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 []IPAMPoolTag: 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
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<IPAMPoolTag>: 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
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 IPAMPoolTag[]: 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
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[IPAMPoolTag]: 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
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

Cidr string

cidr String

cidr string

cidr str

cidr String

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 -.

Package Details

Repository: https://github.com/pulumi/pulumi-aws-native
License: Apache-2.0