Skip to content

PrefixList

This class encapsulates and extends the ROS resource type ALIYUN::VPC::PrefixList, which is used to create a prefix list.

Initializers

import com.aliyun.ros.cdk.vpc.PrefixList;
PrefixList.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .entries(IResolvable)
//  .entries(java.util.List<IResolvable)
//  .entries(EntriesProperty>)
//  .ipVersion(java.lang.String)
//  .ipVersion(IResolvable)
//  .maxEntries(java.lang.Number)
//  .maxEntries(IResolvable)
//  .prefixListDescription(java.lang.String)
//  .prefixListDescription(IResolvable)
//  .prefixListName(java.lang.String)
//  .prefixListName(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
entries com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEntriesProperty> Property entries: The CIDR address block list of the prefix list.
ipVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ipVersion: The IP version of the prefix list.
maxEntries java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxEntries: The maximum number of entries for CIDR address blocks in the prefix list.
prefixListDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property prefixListDescription: The description of the prefix list.
prefixListName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property prefixListName: The name of the prefix list.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which the VPC belongs.
tags java.util.List<TagsProperty> Property tags: Tags of prefix list.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

entriesOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEntriesProperty>

Property entries: The CIDR address block list of the prefix list.


ipVersionOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ipVersion: The IP version of the prefix list.

Value:

  • IPvv4:IPv4 version.
  • IPv6:IPv6.

maxEntriesOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maxEntries: The maximum number of entries for CIDR address blocks in the prefix list.


prefixListDescriptionOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property prefixListDescription: The description of the prefix list.

It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with http:// or https.


prefixListNameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property prefixListName: The name of the prefix list.


resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group to which the VPC belongs.


tagsOptional

Property tags: Tags of prefix list.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.vpc.PrefixList;
PrefixList.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The time when the prefix list was created.
attrEntries com.aliyun.ros.cdk.core.IResolvable Attribute Entries: The CIDR address block list of the prefix list.
attrIpVersion com.aliyun.ros.cdk.core.IResolvable Attribute IpVersion: The IP version of the prefix list.
attrMaxEntries com.aliyun.ros.cdk.core.IResolvable Attribute MaxEntries: The maximum number of entries for CIDR address blocks in the prefix list.
attrOwnerId com.aliyun.ros.cdk.core.IResolvable Attribute OwnerId: The Alibaba Cloud account (primary account) to which the prefix list belongs.
attrPrefixListDescription com.aliyun.ros.cdk.core.IResolvable Attribute PrefixListDescription: The description of the prefix list.
attrPrefixListId com.aliyun.ros.cdk.core.IResolvable Attribute PrefixListId: The ID of the query Prefix List.
attrPrefixListName com.aliyun.ros.cdk.core.IResolvable Attribute PrefixListName: The name of the prefix list.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs.
attrShareType com.aliyun.ros.cdk.core.IResolvable Attribute ShareType: The share type of the prefix list.
attrTags com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The tags of PrefixList.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrCreateTimeRequired

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The time when the prefix list was created.


attrEntriesRequired

public IResolvable getAttrEntries();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Entries: The CIDR address block list of the prefix list.


attrIpVersionRequired

public IResolvable getAttrIpVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute IpVersion: The IP version of the prefix list.


attrMaxEntriesRequired

public IResolvable getAttrMaxEntries();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MaxEntries: The maximum number of entries for CIDR address blocks in the prefix list.


attrOwnerIdRequired

public IResolvable getAttrOwnerId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OwnerId: The Alibaba Cloud account (primary account) to which the prefix list belongs.


attrPrefixListDescriptionRequired

public IResolvable getAttrPrefixListDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PrefixListDescription: The description of the prefix list.


attrPrefixListIdRequired

public IResolvable getAttrPrefixListId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PrefixListId: The ID of the query Prefix List.


attrPrefixListNameRequired

public IResolvable getAttrPrefixListName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PrefixListName: The name of the prefix list.


attrResourceGroupIdRequired

public IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs.


attrShareTypeRequired

public IResolvable getAttrShareType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ShareType: The share type of the prefix list.


attrTagsRequired

public IResolvable getAttrTags();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The tags of PrefixList.