1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. getPrefixList

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.ec2.getPrefixList

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Resource schema of AWS::EC2::PrefixList Type

Using getPrefixList

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 getPrefixList(args: GetPrefixListArgs, opts?: InvokeOptions): Promise<GetPrefixListResult>
function getPrefixListOutput(args: GetPrefixListOutputArgs, opts?: InvokeOptions): Output<GetPrefixListResult>
Copy
def get_prefix_list(prefix_list_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetPrefixListResult
def get_prefix_list_output(prefix_list_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetPrefixListResult]
Copy
func LookupPrefixList(ctx *Context, args *LookupPrefixListArgs, opts ...InvokeOption) (*LookupPrefixListResult, error)
func LookupPrefixListOutput(ctx *Context, args *LookupPrefixListOutputArgs, opts ...InvokeOption) LookupPrefixListResultOutput
Copy

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

public static class GetPrefixList 
{
    public static Task<GetPrefixListResult> InvokeAsync(GetPrefixListArgs args, InvokeOptions? opts = null)
    public static Output<GetPrefixListResult> Invoke(GetPrefixListInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPrefixListResult> getPrefixList(GetPrefixListArgs args, InvokeOptions options)
public static Output<GetPrefixListResult> getPrefixList(GetPrefixListArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:ec2:getPrefixList
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PrefixListId This property is required. string
Id of Prefix List.
PrefixListId This property is required. string
Id of Prefix List.
prefixListId This property is required. String
Id of Prefix List.
prefixListId This property is required. string
Id of Prefix List.
prefix_list_id This property is required. str
Id of Prefix List.
prefixListId This property is required. String
Id of Prefix List.

getPrefixList Result

The following output properties are available:

AddressFamily Pulumi.AwsNative.Ec2.PrefixListAddressFamily
Ip Version of Prefix List.
Arn string
The Amazon Resource Name (ARN) of the Prefix List.
Entries List<Pulumi.AwsNative.Ec2.Outputs.PrefixListEntry>
Entries of Prefix List.
MaxEntries int
Max Entries of Prefix List.
OwnerId string
Owner Id of Prefix List.
PrefixListId string
Id of Prefix List.
PrefixListName string
Name of Prefix List.
Tags List<Pulumi.AwsNative.Outputs.Tag>
Tags for Prefix List
Version int
Version of Prefix List.
AddressFamily PrefixListAddressFamily
Ip Version of Prefix List.
Arn string
The Amazon Resource Name (ARN) of the Prefix List.
Entries []PrefixListEntry
Entries of Prefix List.
MaxEntries int
Max Entries of Prefix List.
OwnerId string
Owner Id of Prefix List.
PrefixListId string
Id of Prefix List.
PrefixListName string
Name of Prefix List.
Tags Tag
Tags for Prefix List
Version int
Version of Prefix List.
addressFamily PrefixListAddressFamily
Ip Version of Prefix List.
arn String
The Amazon Resource Name (ARN) of the Prefix List.
entries List<PrefixListEntry>
Entries of Prefix List.
maxEntries Integer
Max Entries of Prefix List.
ownerId String
Owner Id of Prefix List.
prefixListId String
Id of Prefix List.
prefixListName String
Name of Prefix List.
tags List<Tag>
Tags for Prefix List
version Integer
Version of Prefix List.
addressFamily PrefixListAddressFamily
Ip Version of Prefix List.
arn string
The Amazon Resource Name (ARN) of the Prefix List.
entries PrefixListEntry[]
Entries of Prefix List.
maxEntries number
Max Entries of Prefix List.
ownerId string
Owner Id of Prefix List.
prefixListId string
Id of Prefix List.
prefixListName string
Name of Prefix List.
tags Tag[]
Tags for Prefix List
version number
Version of Prefix List.
address_family PrefixListAddressFamily
Ip Version of Prefix List.
arn str
The Amazon Resource Name (ARN) of the Prefix List.
entries Sequence[PrefixListEntry]
Entries of Prefix List.
max_entries int
Max Entries of Prefix List.
owner_id str
Owner Id of Prefix List.
prefix_list_id str
Id of Prefix List.
prefix_list_name str
Name of Prefix List.
tags Sequence[root_Tag]
Tags for Prefix List
version int
Version of Prefix List.
addressFamily "IPv4" | "IPv6"
Ip Version of Prefix List.
arn String
The Amazon Resource Name (ARN) of the Prefix List.
entries List<Property Map>
Entries of Prefix List.
maxEntries Number
Max Entries of Prefix List.
ownerId String
Owner Id of Prefix List.
prefixListId String
Id of Prefix List.
prefixListName String
Name of Prefix List.
tags List<Property Map>
Tags for Prefix List
version Number
Version of Prefix List.

Supporting Types

PrefixListAddressFamily

PrefixListEntry

Cidr This property is required. string
The CIDR block.
Description string

A description for the entry.

Constraints: Up to 255 characters in length.

Cidr This property is required. string
The CIDR block.
Description string

A description for the entry.

Constraints: Up to 255 characters in length.

cidr This property is required. String
The CIDR block.
description String

A description for the entry.

Constraints: Up to 255 characters in length.

cidr This property is required. string
The CIDR block.
description string

A description for the entry.

Constraints: Up to 255 characters in length.

cidr This property is required. str
The CIDR block.
description str

A description for the entry.

Constraints: Up to 255 characters in length.

cidr This property is required. String
The CIDR block.
description String

A description for the entry.

Constraints: Up to 255 characters in length.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi