pulumi-aws-kotlin/com.pulumi.aws.ec2.kotlin/Ec2Functions/getVpcIamPool

getVpcIamPool

suspend fun getVpcIamPool(argument: GetVpcIamPoolPlainArgs): GetVpcIamPoolResult

aws.ec2.VpcIpamPool provides details about an IPAM pool. This resource can prove useful when an ipam pool was created in another root module and you need the pool's id as an input variable. For example, pools can be shared via RAM and used to create vpcs with CIDRs from that pool.

Example Usage

The following example shows an account that has only 1 pool, perhaps shared via RAM, and using that pool id to create a VPC with a CIDR derived from AWS IPAM.

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetVpcIamPoolArgs;
import com.pulumi.aws.ec2.Vpc;
import com.pulumi.aws.ec2.VpcArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var testVpcIamPool = Ec2Functions.getVpcIamPool(GetVpcIamPoolArgs.builder()
            .filters(
                GetVpcIamPoolFilterArgs.builder()
                    .name("description")
                    .values("*test*")
                    .build(),
                GetVpcIamPoolFilterArgs.builder()
                    .name("address-family")
                    .values("ipv4")
                    .build())
            .build());
        var testVpc = new Vpc("testVpc", VpcArgs.builder()
            .ipv4IpamPoolId(testVpcIamPool.applyValue(getVpcIamPoolResult -> getVpcIamPoolResult.id()))
            .ipv4NetmaskLength(28)
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getVpcIamPool.

Parameters

argument

A collection of arguments for invoking getVpcIamPool.

suspend fun getVpcIamPool(allocationResourceTags: Map<String, String>? = null, filters: List<GetVpcIamPoolFilter>? = null, id: String? = null, ipamPoolId: String? = null, tags: Map<String, String>? = null): GetVpcIamPoolResult

Return

A collection of values returned by getVpcIamPool.

Parameters

allocationResourceTags

Tags that are required to create resources in using this pool.

filters

Custom filter block as described below.

id

ID of the IPAM pool.

ipamPoolId

ID of the IPAM pool you would like information on.

tags

Map of tags to assigned to the resource.

See also

.

suspend fun getVpcIamPool(argument: suspend GetVpcIamPoolPlainArgsBuilder.() -> Unit): GetVpcIamPoolResult

Return

A collection of values returned by getVpcIamPool.

Parameters

argument

Builder for com.pulumi.aws.ec2.kotlin.inputs.GetVpcIamPoolPlainArgs.

See also

.