We recommend new projects start with resources from the AWS provider.
aws-native.ec2.getIpamAllocation
We recommend new projects start with resources from the AWS provider.
Resource Schema of AWS::EC2::IPAMAllocation Type
Using getIpamAllocation
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 getIpamAllocation(args: GetIpamAllocationArgs, opts?: InvokeOptions): Promise<GetIpamAllocationResult>
function getIpamAllocationOutput(args: GetIpamAllocationOutputArgs, opts?: InvokeOptions): Output<GetIpamAllocationResult>def get_ipam_allocation(cidr: Optional[str] = None,
                        ipam_pool_allocation_id: Optional[str] = None,
                        ipam_pool_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetIpamAllocationResult
def get_ipam_allocation_output(cidr: Optional[pulumi.Input[str]] = None,
                        ipam_pool_allocation_id: Optional[pulumi.Input[str]] = None,
                        ipam_pool_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetIpamAllocationResult]func LookupIpamAllocation(ctx *Context, args *LookupIpamAllocationArgs, opts ...InvokeOption) (*LookupIpamAllocationResult, error)
func LookupIpamAllocationOutput(ctx *Context, args *LookupIpamAllocationOutputArgs, opts ...InvokeOption) LookupIpamAllocationResultOutput> Note: This function is named LookupIpamAllocation in the Go SDK.
public static class GetIpamAllocation 
{
    public static Task<GetIpamAllocationResult> InvokeAsync(GetIpamAllocationArgs args, InvokeOptions? opts = null)
    public static Output<GetIpamAllocationResult> Invoke(GetIpamAllocationInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetIpamAllocationResult> getIpamAllocation(GetIpamAllocationArgs args, InvokeOptions options)
public static Output<GetIpamAllocationResult> getIpamAllocation(GetIpamAllocationArgs args, InvokeOptions options)
fn::invoke:
  function: aws-native:ec2:getIpamAllocation
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Cidr string
- The CIDR you would like to allocate from the IPAM pool. Note the following: - If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
 - Possible values: Any available IPv4 or IPv6 CIDR. 
- IpamPool stringAllocation Id 
- Id of the allocation.
- IpamPool stringId 
- Id of the IPAM Pool.
- Cidr string
- The CIDR you would like to allocate from the IPAM pool. Note the following: - If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
 - Possible values: Any available IPv4 or IPv6 CIDR. 
- IpamPool stringAllocation Id 
- Id of the allocation.
- IpamPool stringId 
- Id of the IPAM Pool.
- cidr String
- The CIDR you would like to allocate from the IPAM pool. Note the following: - If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
 - Possible values: Any available IPv4 or IPv6 CIDR. 
- ipamPool StringAllocation Id 
- Id of the allocation.
- ipamPool StringId 
- Id of the IPAM Pool.
- cidr string
- The CIDR you would like to allocate from the IPAM pool. Note the following: - If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
 - Possible values: Any available IPv4 or IPv6 CIDR. 
- ipamPool stringAllocation Id 
- Id of the allocation.
- ipamPool stringId 
- Id of the IPAM Pool.
- cidr str
- The CIDR you would like to allocate from the IPAM pool. Note the following: - If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
 - Possible values: Any available IPv4 or IPv6 CIDR. 
- ipam_pool_ strallocation_ id 
- Id of the allocation.
- ipam_pool_ strid 
- Id of the IPAM Pool.
- cidr String
- The CIDR you would like to allocate from the IPAM pool. Note the following: - If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
 - Possible values: Any available IPv4 or IPv6 CIDR. 
- ipamPool StringAllocation Id 
- Id of the allocation.
- ipamPool StringId 
- Id of the IPAM Pool.
getIpamAllocation Result
The following output properties are available:
- IpamPool stringAllocation Id 
- Id of the allocation.
- IpamPool stringAllocation Id 
- Id of the allocation.
- ipamPool StringAllocation Id 
- Id of the allocation.
- ipamPool stringAllocation Id 
- Id of the allocation.
- ipam_pool_ strallocation_ id 
- Id of the allocation.
- ipamPool StringAllocation Id 
- Id of the allocation.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
