Package software.amazon.awscdk.services.ec2

Interface CfnPrefixListProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPrefixListProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:03.117Z")
@Stability(Stable)
public interface CfnPrefixListProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPrefixList.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnPrefixListProps cfnPrefixListProps = CfnPrefixListProps.builder()
         .addressFamily("addressFamily")
         .prefixListName("prefixListName")
         // the properties below are optional
         .entries(List.of(EntryProperty.builder()
                 .cidr("cidr")
                 // the properties below are optional
                 .description("description")
                 .build()))
         .maxEntries(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPrefixListProps.Builder	A builder for CfnPrefixListProps
static final class	CfnPrefixListProps.Jsii$Proxy	An implementation for CfnPrefixListProps

Method Summary

Modifier and Type	Method	Description
static CfnPrefixListProps.Builder	builder()
String	getAddressFamily()	The IP address type.
default Object	getEntries()	The entries for the prefix list.
default Number	getMaxEntries()	The maximum number of entries for the prefix list.
String	getPrefixListName()	A name for the prefix list.
default List<CfnTag>	getTags()	The tags for the prefix list.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddressFamily

@Stability(Stable)
@NotNull
String getAddressFamily()

The IP address type.

Valid Values: IPv4 | IPv6

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-addressfamily

getPrefixListName

@Stability(Stable)
@NotNull
String getPrefixListName()

A name for the prefix list.

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-prefixlistname

getEntries

@Stability(Stable)
@Nullable
default Object getEntries()

The entries for the prefix list.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPrefixList.EntryProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-entries

getMaxEntries

@Stability(Stable)
@Nullable
default Number getMaxEntries()

The maximum number of entries for the prefix list.

You can't modify the entries and the size of a prefix list at the same time.

This property is required when you create a prefix list.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-maxentries

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags for the prefix list.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-tags

builder

@Stability(Stable)
static CfnPrefixListProps.Builder builder()

Returns:

a CfnPrefixListProps.Builder of CfnPrefixListProps