getSubnets

AWS v6.83.1 (6.x), Mar 9 26

Viewing docs for AWS v6.83.1 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aws

Viewing docs for AWS v6.83.1 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aws

Using getSubnets

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 getSubnets(args: GetSubnetsArgs, opts?: InvokeOptions): Promise<GetSubnetsResult>
function getSubnetsOutput(args: GetSubnetsOutputArgs, opts?: InvokeOptions): Output<GetSubnetsResult>

def get_subnets(filters: Optional[Sequence[GetSubnetsFilter]] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetSubnetsResult
def get_subnets_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetSubnetsFilterArgs]]]] = None,
                tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetSubnetsResult]

func GetSubnets(ctx *Context, args *GetSubnetsArgs, opts ...InvokeOption) (*GetSubnetsResult, error)
func GetSubnetsOutput(ctx *Context, args *GetSubnetsOutputArgs, opts ...InvokeOption) GetSubnetsResultOutput

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

public static class GetSubnets 
{
    public static Task<GetSubnetsResult> InvokeAsync(GetSubnetsArgs args, InvokeOptions? opts = null)
    public static Output<GetSubnetsResult> Invoke(GetSubnetsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSubnetsResult> getSubnets(GetSubnetsArgs args, InvokeOptions options)
public static Output<GetSubnetsResult> getSubnets(GetSubnetsArgs args, InvokeOptions options)

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

The following arguments are supported:

Filters List<GetSubnetsFilter>: Custom filter block as described below.
Tags Dictionary<string, string>: Map of tags, each pair of which must exactly match a pair on the desired subnets.

Filters []GetSubnetsFilter: Custom filter block as described below.
Tags map[string]string: Map of tags, each pair of which must exactly match a pair on the desired subnets.

filters List<GetSubnetsFilter>: Custom filter block as described below.
tags Map<String,String>: Map of tags, each pair of which must exactly match a pair on the desired subnets.

filters GetSubnetsFilter[]: Custom filter block as described below.
tags {[key: string]: string}: Map of tags, each pair of which must exactly match a pair on the desired subnets.

filters Sequence[GetSubnetsFilter]: Custom filter block as described below.
tags Mapping[str, str]: Map of tags, each pair of which must exactly match a pair on the desired subnets.

filters List<Property Map>: Custom filter block as described below.
tags Map<String>: Map of tags, each pair of which must exactly match a pair on the desired subnets.

getSubnets Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>: List of all the subnet ids found.
Tags Dictionary<string, string>
Filters List<GetSubnetsFilter>

Id string: The provider-assigned unique ID for this managed resource.
Ids []string: List of all the subnet ids found.
Tags map[string]string
Filters []GetSubnetsFilter

id String: The provider-assigned unique ID for this managed resource.
ids List<String>: List of all the subnet ids found.
tags Map<String,String>
filters List<GetSubnetsFilter>

id string: The provider-assigned unique ID for this managed resource.
ids string[]: List of all the subnet ids found.
tags {[key: string]: string}
filters GetSubnetsFilter[]

id str: The provider-assigned unique ID for this managed resource.
ids Sequence[str]: List of all the subnet ids found.
tags Mapping[str, str]
filters Sequence[GetSubnetsFilter]

id String: The provider-assigned unique ID for this managed resource.
ids List<String>: List of all the subnet ids found.
tags Map<String>
filters List<Property Map>

Supporting Types

GetSubnetsFilter

Name string: Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against tag Name, use:
Values List<string>: Set of values that are accepted for the given field. Subnet IDs will be selected if any one of the given values match.

Name string: Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against tag Name, use:
Values []string: Set of values that are accepted for the given field. Subnet IDs will be selected if any one of the given values match.

name String: Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against tag Name, use:
values List<String>: Set of values that are accepted for the given field. Subnet IDs will be selected if any one of the given values match.

name string: Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against tag Name, use:
values string[]: Set of values that are accepted for the given field. Subnet IDs will be selected if any one of the given values match.

name str: Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against tag Name, use:
values Sequence[str]: Set of values that are accepted for the given field. Subnet IDs will be selected if any one of the given values match.

name String: Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against tag Name, use:
values List<String>: Set of values that are accepted for the given field. Subnet IDs will be selected if any one of the given values match.