software.amazon.awscdk.services.ec2

Class CfnPrefixList

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnPrefixList

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.275Z")
 @Stability(value=Stable)
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.

You must specify the maximum number of entries for the prefix list. The maximum number of entries cannot be changed later.

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPrefixList(software.constructs.Construct scope, 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
String	getAddressFamily() The IP address type.
String	getAttrArn() The ARN of the prefix list.
String	getAttrOwnerId() The ID of the owner of the prefix list.
String	getAttrPrefixListId() The ID of the prefix list.
Number	getAttrVersion() The version of the prefix list.
protected Map<String,Object>	getCfnProperties()
Object	getEntries() One or more entries for the prefix list.
Number	getMaxEntries() The maximum number of entries for the prefix list.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAddressFamily(String value) The IP address type.
void	setEntries(IResolvable value) One or more entries for the prefix list.
void	setEntries(List<Object> value) One or more entries for the prefix list.
void	setMaxEntries(Number value) The maximum number of entries for the prefix list.
void	setPrefixListName(String value) A name for the prefix list.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnPrefixList(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the prefix list.

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

getAttrOwnerId

@Stability(value=Stable)
 @NotNull
public String getAttrOwnerId()

The ID of the owner of the prefix list.

For example, 123456789012 .

getAttrPrefixListId

@Stability(value=Stable)
 @NotNull
public String getAttrPrefixListId()

The ID of the prefix list.

For example, pl-0123123123123abcd .

getAttrVersion

@Stability(value=Stable)
 @NotNull
public Number getAttrVersion()

The version of the prefix list.

For example, 1 .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags for the prefix list.

getAddressFamily

@Stability(value=Stable)
 @NotNull
public String getAddressFamily()

The IP address type.

Valid Values: IPv4 | IPv6

setAddressFamily

@Stability(value=Stable)
public void setAddressFamily(@NotNull
                                                      String value)

The IP address type.

Valid Values: IPv4 | IPv6

getMaxEntries

@Stability(value=Stable)
 @NotNull
public Number getMaxEntries()

The maximum number of entries for the prefix list.

setMaxEntries

@Stability(value=Stable)
public void setMaxEntries(@NotNull
                                                   Number value)

The maximum number of entries for the prefix list.

getPrefixListName

@Stability(value=Stable)
 @NotNull
public String getPrefixListName()

A name for the prefix list.

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

setPrefixListName

@Stability(value=Stable)
public void setPrefixListName(@NotNull
                                                       String value)

A name for the prefix list.

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

getEntries

@Stability(value=Stable)
 @Nullable
public Object getEntries()

One or more entries for the prefix list.

setEntries

@Stability(value=Stable)
public void setEntries(@Nullable
                                                IResolvable value)

One or more entries for the prefix list.

setEntries

@Stability(value=Stable)
public void setEntries(@Nullable
                                                List<Object> value)

One or more entries for the prefix list.