Skip to content

PublicIpAddressPool

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

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 creation time of the resource.


attrDescriptionRequired

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

Attribute Description: Description.


attrIpAddressRemainingRequired

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

Attribute IpAddressRemaining: Whether there is a free IP address.


attrIspRequired

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

Attribute Isp: Service providers.


attrPublicIpAddressPoolIdRequired

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

Attribute PublicIpAddressPoolId: The first ID of the resource.


attrPublicIpAddressPoolNameRequired

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

Attribute PublicIpAddressPoolName: The name of the resource.


attrResourceGroupIdRequired

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

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


attrTagsRequired

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

Attribute Tags: The tags of PrefixList.


attrTotalIpNumRequired

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

Attribute TotalIpNum: Total ip number of PublicIpAddressPool.


attrUsedIpNumRequired

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

Attribute UsedIpNum: Used ip number of PublicIpAddressPool.