Skip to content

PublicIpAddressPool

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

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::PublicIpAddressPool, which is used to query the basic information about an available IP address pool.

Initializers

import com.aliyun.ros.cdk.vpc.datasource.PublicIpAddressPool;
PublicIpAddressPool.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .publicIpAddressPoolId(java.lang.String)
    .publicIpAddressPoolId(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.
publicIpAddressPoolId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property publicIpAddressPoolId: The first ID of the resource.
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

publicIpAddressPoolIdRequired

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

Property publicIpAddressPoolId: The first ID of the resource.


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.PublicIpAddressPool;
PublicIpAddressPool.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 creation time of the resource.
attrDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: Description.
attrIpAddressRemaining java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute IpAddressRemaining: Whether there is a free IP address.
attrIsp java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Isp: Service providers.
attrPublicIpAddressPoolId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PublicIpAddressPoolId: The first ID of the resource.
attrPublicIpAddressPoolName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PublicIpAddressPoolName: The name of the resource.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs.
attrTags java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The tags of PrefixList.
attrTotalIpNum java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TotalIpNum: Total ip number of PublicIpAddressPool.
attrUsedIpNum java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute UsedIpNum: Used ip number of PublicIpAddressPool.
props PublicIpAddressPoolProps 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 creation time of the resource.


attrDescriptionRequired

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

Attribute Description: Description.


attrIpAddressRemainingRequired

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

Attribute IpAddressRemaining: Whether there is a free IP address.


attrIspRequired

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

Attribute Isp: Service providers.


attrPublicIpAddressPoolIdRequired

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

Attribute PublicIpAddressPoolId: The first ID of the resource.


attrPublicIpAddressPoolNameRequired

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

Attribute PublicIpAddressPoolName: The name of the resource.


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.


attrTagsRequired

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

Attribute Tags: The tags of PrefixList.


attrTotalIpNumRequired

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

Attribute TotalIpNum: Total ip number of PublicIpAddressPool.


attrUsedIpNumRequired

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

Attribute UsedIpNum: Used ip number of PublicIpAddressPool.


propsRequired

public PublicIpAddressPoolProps getProps();