aws.ec2.getPublicIpv4Pools

Explore with Pulumi AI

AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Returns all public IPv4 pools.
const example = aws.ec2.getPublicIpv4Pools({});

import pulumi
import pulumi_aws as aws

# Returns all public IPv4 pools.
example = aws.ec2.get_public_ipv4_pools()

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Returns all public IPv4 pools.
		_, err := ec2.GetPublicIpv4Pools(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    // Returns all public IPv4 pools.
    var example = Aws.Ec2.GetPublicIpv4Pools.Invoke();

});

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.GetPublicIpv4PoolsArgs;
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) {
        // Returns all public IPv4 pools.
        final var example = Ec2Functions.getPublicIpv4Pools();

    }
}

variables:
  # Returns all public IPv4 pools.
  example:
    fn::invoke:
      Function: aws:ec2:getPublicIpv4Pools
      Arguments: {}

Usage with Filter

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ec2.getPublicIpv4Pools({
    filters: [{
        name: "tag-key",
        values: ["ExampleTagKey"],
    }],
});

import pulumi
import pulumi_aws as aws

example = aws.ec2.get_public_ipv4_pools(filters=[{
    "name": "tag-key",
    "values": ["ExampleTagKey"],
}])

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.GetPublicIpv4Pools(ctx, &ec2.GetPublicIpv4PoolsArgs{
			Filters: []ec2.GetPublicIpv4PoolsFilter{
				{
					Name: "tag-key",
					Values: []string{
						"ExampleTagKey",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Ec2.GetPublicIpv4Pools.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetPublicIpv4PoolsFilterInputArgs
            {
                Name = "tag-key",
                Values = new[]
                {
                    "ExampleTagKey",
                },
            },
        },
    });

});

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.GetPublicIpv4PoolsArgs;
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 example = Ec2Functions.getPublicIpv4Pools(GetPublicIpv4PoolsArgs.builder()
            .filters(GetPublicIpv4PoolsFilterArgs.builder()
                .name("tag-key")
                .values("ExampleTagKey")
                .build())
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: aws:ec2:getPublicIpv4Pools
      Arguments:
        filters:
          - name: tag-key
            values:
              - ExampleTagKey

Using getPublicIpv4Pools

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 getPublicIpv4Pools(args: GetPublicIpv4PoolsArgs, opts?: InvokeOptions): Promise<GetPublicIpv4PoolsResult>
function getPublicIpv4PoolsOutput(args: GetPublicIpv4PoolsOutputArgs, opts?: InvokeOptions): Output<GetPublicIpv4PoolsResult>

def get_public_ipv4_pools(filters: Optional[Sequence[GetPublicIpv4PoolsFilter]] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPublicIpv4PoolsResult
def get_public_ipv4_pools_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetPublicIpv4PoolsFilterArgs]]]] = None,
                          tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPublicIpv4PoolsResult]

func GetPublicIpv4Pools(ctx *Context, args *GetPublicIpv4PoolsArgs, opts ...InvokeOption) (*GetPublicIpv4PoolsResult, error)
func GetPublicIpv4PoolsOutput(ctx *Context, args *GetPublicIpv4PoolsOutputArgs, opts ...InvokeOption) GetPublicIpv4PoolsResultOutput

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

public static class GetPublicIpv4Pools 
{
    public static Task<GetPublicIpv4PoolsResult> InvokeAsync(GetPublicIpv4PoolsArgs args, InvokeOptions? opts = null)
    public static Output<GetPublicIpv4PoolsResult> Invoke(GetPublicIpv4PoolsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPublicIpv4PoolsResult> getPublicIpv4Pools(GetPublicIpv4PoolsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:ec2/getPublicIpv4Pools:getPublicIpv4Pools
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetPublicIpv4PoolsFilter>