aws-cdk-lib.aws_ec2.PrefixList

class PrefixList (construct)

LanguageType name
.NETAmazon.CDK.AWS.EC2.PrefixList
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#PrefixList
Javasoftware.amazon.awscdk.services.ec2.PrefixList
Pythonaws_cdk.aws_ec2.PrefixList
TypeScript (source)aws-cdk-lib » aws_ec2 » PrefixList

Implements IConstruct, IDependable, IResource, IPrefixList

A managed prefix list.

Example

new ec2.PrefixList(this, 'EmptyPrefixList', {
  maxEntries: 100,
});

Initializer

new PrefixList(scope: Construct, id: string, props?: PrefixListProps)

Parameters

  • scope Construct
  • id string
  • props PrefixListProps

Construct Props

NameTypeDescription
addressFamily?AddressFamilyThe address family of the prefix list.
entries?EntryProperty[]The list of entries for the prefix list.
maxEntries?numberThe maximum number of entries for the prefix list.
prefixListName?stringThe name of the prefix list.

addressFamily?

Type: AddressFamily (optional, default: AddressFamily.IP_V4)

The address family of the prefix list.


entries?

Type: EntryProperty[] (optional, default: [])

The list of entries for the prefix list.


maxEntries?

Type: number (optional, default: Automatically-calculated)

The maximum number of entries for the prefix list.


prefixListName?

Type: string (optional, default: None)

The name of the prefix list.

Properties

NameTypeDescription
addressFamilystringThe address family of the prefix list.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
ownerIdstringThe owner ID of the prefix list.
prefixListArnstringThe ARN of the prefix list.
prefixListIdstringThe ID of the prefix list.
prefixListNamestringThe name of the prefix list.
stackStackThe stack in which this resource is defined.
versionnumberThe version of the prefix list.

addressFamily

Type: string

The address family of the prefix list.


env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node

Type: Node

The tree node.


ownerId

Type: string

The owner ID of the prefix list.


prefixListArn

Type: string

The ARN of the prefix list.


prefixListId

Type: string

The ID of the prefix list.


prefixListName

Type: string

The name of the prefix list.


stack

Type: Stack

The stack in which this resource is defined.


version

Type: number

The version of the prefix list.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.
static fromPrefixListId(scope, id, prefixListId)Look up prefix list by id.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromPrefixListId(scope, id, prefixListId)

public static fromPrefixListId(scope: Construct, id: string, prefixListId: string): IPrefixList

Parameters

  • scope Construct
  • id string
  • prefixListId string

Returns

  • IPrefixList

Look up prefix list by id.