software.amazon.awscdk.services.ec2

Class CfnPrefixList

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ec2.CfnPrefixList

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.669Z")
public class CfnPrefixList
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::PrefixList`.

Specifies a managed prefix list. You can add one or more entries to the prefix list. Each entry consists of a CIDR block and an optional description.

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.*;
 CfnPrefixList cfnPrefixList = CfnPrefixList.Builder.create(this, "MyCfnPrefixList")
         .addressFamily("addressFamily")
         .maxEntries(123)
         .prefixListName("prefixListName")
         // the properties below are optional
         .entries(List.of(EntryProperty.builder()
                 .cidr("cidr")
                 // the properties below are optional
                 .description("description")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPrefixList.Builder A fluent builder for CfnPrefixList.
static interface	CfnPrefixList.EntryProperty An entry for a prefix list.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPrefixList(Construct scope, java.lang.String id, CfnPrefixListProps props) Create a new `AWS::EC2::PrefixList`.
protected	CfnPrefixList(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPrefixList(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddressFamily() The IP address type.
java.lang.String	getAttrArn() The ARN of the prefix list.
java.lang.String	getAttrOwnerId() The ID of the owner of the prefix list.
java.lang.String	getAttrPrefixListId() The ID of the prefix list.
java.lang.Number	getAttrVersion() The version of the prefix list.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getEntries() One or more entries for the prefix list.
java.lang.Number	getMaxEntries() The maximum number of entries for the prefix list.
java.lang.String	getPrefixListName() A name for the prefix list.
TagManager	getTags() The tags for the prefix list.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAddressFamily(java.lang.String value) The IP address type.
void	setEntries(IResolvable value) One or more entries for the prefix list.
void	setEntries(java.util.List<java.lang.Object> value) One or more entries for the prefix list.
void	setMaxEntries(java.lang.Number value) The maximum number of entries for the prefix list.
void	setPrefixListName(java.lang.String value) A name for the prefix list.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPrefixList

protected CfnPrefixList(software.amazon.jsii.JsiiObjectRef objRef)

CfnPrefixList

protected CfnPrefixList(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPrefixList

public CfnPrefixList(Construct scope,
                     java.lang.String id,
                     CfnPrefixListProps props)

Create a new `AWS::EC2::PrefixList`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The ARN of the prefix list.

For example, arn:aws:ec2:us-east-1:123456789012:prefix-list/pl-0123123123123abcd .

getAttrOwnerId

public java.lang.String getAttrOwnerId()

The ID of the owner of the prefix list.

For example, 123456789012 .

getAttrPrefixListId

public java.lang.String getAttrPrefixListId()

The ID of the prefix list.

For example, pl-0123123123123abcd .

getAttrVersion

public java.lang.Number getAttrVersion()

The version of the prefix list.

For example, 1 .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags for the prefix list.

getAddressFamily

public java.lang.String getAddressFamily()

The IP address type.

Valid Values: IPv4 | IPv6

setAddressFamily

public void setAddressFamily(java.lang.String value)

The IP address type.

Valid Values: IPv4 | IPv6

getMaxEntries

public java.lang.Number getMaxEntries()

The maximum number of entries for the prefix list.

setMaxEntries

public void setMaxEntries(java.lang.Number value)

The maximum number of entries for the prefix list.

getPrefixListName

public java.lang.String getPrefixListName()

A name for the prefix list.

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

setPrefixListName

public void setPrefixListName(java.lang.String value)

A name for the prefix list.

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

getEntries

public java.lang.Object getEntries()

One or more entries for the prefix list.

setEntries

public void setEntries(IResolvable value)

One or more entries for the prefix list.

setEntries

public void setEntries(java.util.List<java.lang.Object> value)

One or more entries for the prefix list.