Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ec2
  5. getCoipPools
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.ec2.getCoipPools

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Provides information for multiple EC2 Customer-Owned IP Pools, such as their identifiers.

Using getCoipPools

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 getCoipPools(args: GetCoipPoolsArgs, opts?: InvokeOptions): Promise<GetCoipPoolsResult>
function getCoipPoolsOutput(args: GetCoipPoolsOutputArgs, opts?: InvokeOptions): Output<GetCoipPoolsResult>
Copy
def get_coip_pools(filters: Optional[Sequence[GetCoipPoolsFilter]] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetCoipPoolsResult
def get_coip_pools_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetCoipPoolsFilterArgs]]]] = None,
                   tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetCoipPoolsResult]
Copy
func GetCoipPools(ctx *Context, args *GetCoipPoolsArgs, opts ...InvokeOption) (*GetCoipPoolsResult, error)
func GetCoipPoolsOutput(ctx *Context, args *GetCoipPoolsOutputArgs, opts ...InvokeOption) GetCoipPoolsResultOutput
Copy

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

public static class GetCoipPools 
{
    public static Task<GetCoipPoolsResult> InvokeAsync(GetCoipPoolsArgs args, InvokeOptions? opts = null)
    public static Output<GetCoipPoolsResult> Invoke(GetCoipPoolsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCoipPoolsResult> getCoipPools(GetCoipPoolsArgs args, InvokeOptions options)
public static Output<GetCoipPoolsResult> getCoipPools(GetCoipPoolsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:ec2/getCoipPools:getCoipPools
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Filters List<GetCoipPoolsFilter>

Custom filter block as described below.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

Tags Dictionary<string, string>
Mapping of tags, each pair of which must exactly match a pair on the desired aws_ec2_coip_pools.
Filters []GetCoipPoolsFilter

Custom filter block as described below.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

Tags map[string]string
Mapping of tags, each pair of which must exactly match a pair on the desired aws_ec2_coip_pools.
filters List<GetCoipPoolsFilter>

Custom filter block as described below.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

tags Map<String,String>
Mapping of tags, each pair of which must exactly match a pair on the desired aws_ec2_coip_pools.
filters GetCoipPoolsFilter[]

Custom filter block as described below.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

tags {[key: string]: string}
Mapping of tags, each pair of which must exactly match a pair on the desired aws_ec2_coip_pools.
filters Sequence[GetCoipPoolsFilter]

Custom filter block as described below.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

tags Mapping[str, str]
Mapping of tags, each pair of which must exactly match a pair on the desired aws_ec2_coip_pools.
filters List<Property Map>

Custom filter block as described below.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

tags Map<String>
Mapping of tags, each pair of which must exactly match a pair on the desired aws_ec2_coip_pools.

getCoipPools Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
PoolIds List<string>
Set of COIP Pool Identifiers
Filters List<GetCoipPoolsFilter>
Tags Dictionary<string, string>
Id string
The provider-assigned unique ID for this managed resource.
PoolIds []string
Set of COIP Pool Identifiers
Filters []GetCoipPoolsFilter
Tags map[string]string
id String
The provider-assigned unique ID for this managed resource.
poolIds List<String>
Set of COIP Pool Identifiers
filters List<GetCoipPoolsFilter>
tags Map<String,String>
id string
The provider-assigned unique ID for this managed resource.
poolIds string[]
Set of COIP Pool Identifiers
filters GetCoipPoolsFilter[]
tags {[key: string]: string}
id str
The provider-assigned unique ID for this managed resource.
pool_ids Sequence[str]
Set of COIP Pool Identifiers
filters Sequence[GetCoipPoolsFilter]
tags Mapping[str, str]
id String
The provider-assigned unique ID for this managed resource.
poolIds List<String>
Set of COIP Pool Identifiers
filters List<Property Map>
tags Map<String>

Supporting Types

GetCoipPoolsFilter

Name This property is required. string
Name of the field to filter by, as defined by the underlying AWS API.
Values This property is required. List<string>
Set of values that are accepted for the given field. A COIP Pool will be selected if any one of the given values matches.
Name This property is required. string
Name of the field to filter by, as defined by the underlying AWS API.
Values This property is required. []string
Set of values that are accepted for the given field. A COIP Pool will be selected if any one of the given values matches.
name This property is required. String
Name of the field to filter by, as defined by the underlying AWS API.
values This property is required. List<String>
Set of values that are accepted for the given field. A COIP Pool will be selected if any one of the given values matches.
name This property is required. string
Name of the field to filter by, as defined by the underlying AWS API.
values This property is required. string[]
Set of values that are accepted for the given field. A COIP Pool will be selected if any one of the given values matches.
name This property is required. str
Name of the field to filter by, as defined by the underlying AWS API.
values This property is required. Sequence[str]
Set of values that are accepted for the given field. A COIP Pool will be selected if any one of the given values matches.
name This property is required. String
Name of the field to filter by, as defined by the underlying AWS API.
values This property is required. List<String>
Set of values that are accepted for the given field. A COIP Pool will be selected if any one of the given values matches.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws