AWS Native
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:
- Ipam
Pool stringId Id of the IPAM Pool.
- Ipam
Pool stringId Id of the IPAM Pool.
- ipam
Pool StringId Id of the IPAM Pool.
- ipam
Pool stringId Id of the IPAM Pool.
- ipam_
pool_ strid Id of the IPAM Pool.
- ipam
Pool StringId Id of the IPAM Pool.
getIPAMPool Result
The following output properties are available:
- Allocation
Default intNetmask Length 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 intNetmask Length The maximum allowed netmask length for allocations made from this pool.
- Allocation
Min intNetmask Length The minimum allowed netmask length for allocations made from this pool.
- List<Pulumi.
Aws Native. EC2. Outputs. IPAMPool Tag> 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.
- 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 string
- Ipam
Arn string The Amazon Resource Name (ARN) of the IPAM this pool is a part of.
- Ipam
Pool stringId Id of the IPAM Pool.
- Ipam
Scope stringArn The Amazon Resource Name (ARN) of the scope this pool is a part of.
- Ipam
Scope Pulumi.Type Aws Native. EC2. IPAMPool Ipam Scope Type 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 List<Pulumi.Aws Native. EC2. Outputs. IPAMPool Provisioned Cidr> A list of cidrs representing the address space available for allocation in this pool.
- State
Pulumi.
Aws Native. EC2. IPAMPool State 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 string An explanation of how the pool arrived at it current state.
- List<Pulumi.
Aws Native. EC2. Outputs. IPAMPool Tag> An array of key-value pairs to apply to this resource.
- Allocation
Default intNetmask Length 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 intNetmask Length The maximum allowed netmask length for allocations made from this pool.
- Allocation
Min intNetmask Length The minimum allowed netmask length for allocations made from this pool.
- []IPAMPool
Tag 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.
- 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 string
- Ipam
Arn string The Amazon Resource Name (ARN) of the IPAM this pool is a part of.
- Ipam
Pool stringId Id of the IPAM Pool.
- Ipam
Scope stringArn The Amazon Resource Name (ARN) of the scope this pool is a part of.
- Ipam
Scope IPAMPoolType Ipam Scope Type 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 []IPAMPoolProvisioned Cidr A list of cidrs representing the address space available for allocation in this pool.
- State
IPAMPool
State Enum 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 string An explanation of how the pool arrived at it current state.
- []IPAMPool
Tag An array of key-value pairs to apply to this resource.
- allocation
Default IntegerNetmask Length 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 IntegerNetmask Length The maximum allowed netmask length for allocations made from this pool.
- allocation
Min IntegerNetmask Length The minimum allowed netmask length for allocations made from this pool.
- List<IPAMPool
Tag> 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.
- auto
Import 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
- ipam
Arn String The Amazon Resource Name (ARN) of the IPAM this pool is a part of.
- ipam
Pool StringId Id of the IPAM Pool.
- ipam
Scope StringArn The Amazon Resource Name (ARN) of the scope this pool is a part of.
- ipam
Scope IPAMPoolType Ipam Scope Type Determines whether this scope contains publicly routable space or space for a private network
- pool
Depth Integer The depth of this pool in the source pool hierarchy.
- provisioned
Cidrs List<IPAMPoolProvisioned Cidr> A list of cidrs representing the address space available for allocation in this pool.
- state
IPAMPool
State 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 String An explanation of how the pool arrived at it current state.
- List<IPAMPool
Tag> An array of key-value pairs to apply to this resource.
- allocation
Default numberNetmask Length 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 numberNetmask Length The maximum allowed netmask length for allocations made from this pool.
- allocation
Min numberNetmask Length The minimum allowed netmask length for allocations made from this pool.
- IPAMPool
Tag[] 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.
- auto
Import 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
- ipam
Arn string The Amazon Resource Name (ARN) of the IPAM this pool is a part of.
- ipam
Pool stringId Id of the IPAM Pool.
- ipam
Scope stringArn The Amazon Resource Name (ARN) of the scope this pool is a part of.
- ipam
Scope IPAMPoolType Ipam Scope Type Determines whether this scope contains publicly routable space or space for a private network
- pool
Depth number The depth of this pool in the source pool hierarchy.
- provisioned
Cidrs IPAMPoolProvisioned Cidr[] A list of cidrs representing the address space available for allocation in this pool.
- state
IPAMPool
State 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 string An explanation of how the pool arrived at it current state.
- IPAMPool
Tag[] An array of key-value pairs to apply to this resource.
- allocation_
default_ intnetmask_ length 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_ intnetmask_ length The maximum allowed netmask length for allocations made from this pool.
- allocation_
min_ intnetmask_ length The minimum allowed netmask length for allocations made from this pool.
- Sequence[IPAMPool
Tag] 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_ strid Id of the IPAM Pool.
- ipam_
scope_ strarn The Amazon Resource Name (ARN) of the scope this pool is a part of.
- ipam_
scope_ IPAMPooltype Ipam Scope Type 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[IPAMPoolProvisioned Cidr] A list of cidrs representing the address space available for allocation in this pool.
- state
IPAMPool
State 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.
- Sequence[IPAMPool
Tag] An array of key-value pairs to apply to this resource.
- allocation
Default NumberNetmask Length 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 NumberNetmask Length The maximum allowed netmask length for allocations made from this pool.
- allocation
Min NumberNetmask Length The minimum allowed netmask length for allocations made from this pool.
- 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.
- auto
Import 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
- ipam
Arn String The Amazon Resource Name (ARN) of the IPAM this pool is a part of.
- ipam
Pool StringId Id of the IPAM Pool.
- ipam
Scope StringArn The Amazon Resource Name (ARN) of the scope this pool is a part of.
- ipam
Scope "public" | "private"Type Determines whether this scope contains publicly routable space or space for a private network
- pool
Depth Number The depth of this pool in the source pool hierarchy.
- provisioned
Cidrs 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"
- state
Message String An explanation of how the pool arrived at it current state.
- 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