PrefixList

class aws_cdk.aws_ec2.PrefixList(scope, id, *, address_family=None, entries=None, prefix_list_name=None, max_entries=None)

Bases: Resource

A managed prefix list.

Resource:

AWS::EC2::PrefixList

ExampleMetadata:

infused

Example:

ec2.PrefixList.from_lookup(self, "PrefixListFromName",
    prefix_list_name="com.amazonaws.global.cloudfront.origin-facing"
)
Parameters:

  • scope (Construct)

  • id (str)

  • address_family (Optional[AddressFamily]) – The address family of the prefix list. Default: AddressFamily.IP_V4

  • entries (Optional[Sequence[Union[EntryProperty, Dict[str, Any]]]]) – The list of entries for the prefix list. Default: []

  • prefix_list_name (Optional[str]) – The name of the prefix list. Default: None

  • max_entries (Union[int, float, None]) – The maximum number of entries for the prefix list. Default: Automatically-calculated

Methods

apply_removal_policy(policy)

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).

Parameters:

policy (RemovalPolicy)

Return type:

None

to_egress_rule_config()

Produce the egress rule JSON for the given connection.

Return type:

Any

to_ingress_rule_config()

Produce the ingress rule JSON for the given connection.

Return type:

Any

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-ec2.PrefixList'
address_family

The address family of the prefix list.

can_inline_rule

Whether the rule can be inlined into a SecurityGroup or not.

connections

The network connections associated with this resource.

env

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

The tree node.

owner_id

The owner ID of the prefix list.

prefix_list_arn

The ARN of the prefix list.

Attribute:

true

prefix_list_id

The ID of the prefix list.

Attribute:

true

prefix_list_name

The name of the prefix list.

Attribute:

true

prefix_list_ref

A reference to a PrefixList resource.

stack

The stack in which this resource is defined.

unique_id

A unique identifier for this connection peer.

version

The version of the prefix list.

Static Methods

classmethod from_lookup(scope, id, *, prefix_list_name, address_family=None, owner_id=None)

Look up prefix list by name.

Parameters:

  • scope (Construct)

  • id (str)

  • prefix_list_name (str) – The name of the managed prefix list.

  • address_family (Optional[AddressFamily]) – The address family of the managed prefix list. Default: - Don’t filter on addressFamily

  • owner_id (Optional[str]) – The ID of the AWS account that owns the managed prefix list. Default: - Don’t filter on ownerId

Return type:

IPrefixList

classmethod from_prefix_list_id(scope, id, prefix_list_id)

Look up prefix list by id.

Parameters:

  • scope (Construct)

  • id (str)

  • prefix_list_id (str)

Return type:

IPrefixList

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct)

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct)

Return type:

bool