Skip to content

PrefixList

  • Implements: com.aliyun.ros.cdk.vpc.datasource.IPrefixList

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::PrefixList.

Initializers

import com.aliyun.ros.cdk.vpc.datasource.PrefixList;
PrefixList.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .prefixListId(java.lang.String)
    .prefixListId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .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.
prefixListId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property prefixListId: The ID of the query Prefix List.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

prefixListIdRequired

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

Property prefixListId: The ID of the query Prefix List.


refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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.datasource.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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The time when the prefix list was created.
attrEntries java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Entries: The CIDR address block list of the prefix list.
attrIpVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute IpVersion: The IP version of the prefix list.
attrMaxEntries java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MaxEntries: The maximum number of entries for CIDR address blocks in the prefix list.
attrOwnerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute OwnerId: The Alibaba Cloud account (primary account) to which the prefix list belongs.
attrPrefixListDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PrefixListDescription: The description of the prefix list.
attrPrefixListId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PrefixListId: The ID of the query Prefix List.
attrPrefixListName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PrefixListName: The name of the prefix list.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs.
attrShareType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ShareType: The share type of the prefix list.
attrTags java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The tags of PrefixList.
props PrefixListProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

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.


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 java.lang.Object getAttrCreateTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrEntriesRequired

public java.lang.Object getAttrEntries();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrIpVersionRequired

public java.lang.Object getAttrIpVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute IpVersion: The IP version of the prefix list.


attrMaxEntriesRequired

public java.lang.Object getAttrMaxEntries();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrOwnerIdRequired

public java.lang.Object getAttrOwnerId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrPrefixListDescriptionRequired

public java.lang.Object getAttrPrefixListDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PrefixListDescription: The description of the prefix list.


attrPrefixListIdRequired

public java.lang.Object getAttrPrefixListId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PrefixListId: The ID of the query Prefix List.


attrPrefixListNameRequired

public java.lang.Object getAttrPrefixListName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PrefixListName: The name of the prefix list.


attrResourceGroupIdRequired

public java.lang.Object getAttrResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrShareTypeRequired

public java.lang.Object getAttrShareType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ShareType: The share type of the prefix list.


attrTagsRequired

public java.lang.Object getAttrTags();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The tags of PrefixList.


propsRequired

public PrefixListProps getProps();