Skip to content

IpamPoolAllocation

This class encapsulates and extends the ROS resource type ALIYUN::VPC::IpamPoolAllocation.

Initializers

import com.aliyun.ros.cdk.vpc.IpamPoolAllocation;
IpamPoolAllocation.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .ipamPoolId(java.lang.String)
    .ipamPoolId(IResolvable)
//  .cidr(java.lang.String)
//  .cidr(IResolvable)
//  .cidrMask(java.lang.Number)
//  .cidrMask(IResolvable)
//  .ipamPoolAllocationDescription(java.lang.String)
//  .ipamPoolAllocationDescription(IResolvable)
//  .ipamPoolAllocationName(java.lang.String)
//  .ipamPoolAllocationName(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.
ipamPoolId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ipamPoolId: The ID of the IPAM Pool.
cidr java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cidr: The allocated address segment.
cidrMask java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property cidrMask: Create a custom reserved network segment from The IPAM address pool by entering a mask.
ipamPoolAllocationDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ipamPoolAllocationDescription: The description of the ipam pool alloctaion.
ipamPoolAllocationName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ipamPoolAllocationName: The name of the ipam pool allocation.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

ipamPoolIdRequired

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

Property ipamPoolId: The ID of the IPAM Pool.


cidrOptional

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

Property cidr: The allocated address segment.


cidrMaskOptional

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

Property cidrMask: Create a custom reserved network segment from The IPAM address pool by entering a mask.

Enter at least one of Cidr or **CidrMask.


ipamPoolAllocationDescriptionOptional

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

Property ipamPoolAllocationDescription: The description of the ipam pool alloctaion.

It must be 1 to 256 characters in length and must start with an English letter or Chinese character, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.


ipamPoolAllocationNameOptional

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

Property ipamPoolAllocationName: The name of the ipam pool allocation.

It must be 1 to 128 characters in length and cannot start with 'http:// 'or 'https.


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.IpamPoolAllocation;
IpamPoolAllocation.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.
attrCidr java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Cidr: The allocated address segment.
attrCreateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: Instance creation time.
attrIpamPoolAllocationDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute IpamPoolAllocationDescription: The description of the ipam pool alloctaion.
attrIpamPoolAllocationId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute IpamPoolAllocationId: The instance ID of the ipam pool allocation.
attrIpamPoolAllocationName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute IpamPoolAllocationName: The name of the ipam pool allocation.
attrIpamPoolId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute IpamPoolId: The ID of the IPAM Pool.
attrResourceOwnerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceOwnerId: The ID of the Alibaba Cloud account (primary account) to which the resource belongs.
attrResourceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceType: The type of resource.
attrSourceCidr java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SourceCidr: The source address segment.
props IpamPoolAllocationProps 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

attrCidrRequired

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

Attribute Cidr: The allocated address segment.


attrCreateTimeRequired

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

Attribute CreateTime: Instance creation time.


attrIpamPoolAllocationDescriptionRequired

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

Attribute IpamPoolAllocationDescription: The description of the ipam pool alloctaion.


attrIpamPoolAllocationIdRequired

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

Attribute IpamPoolAllocationId: The instance ID of the ipam pool allocation.


attrIpamPoolAllocationNameRequired

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

Attribute IpamPoolAllocationName: The name of the ipam pool allocation.


attrIpamPoolIdRequired

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

Attribute IpamPoolId: The ID of the IPAM Pool.


attrResourceOwnerIdRequired

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

Attribute ResourceOwnerId: The ID of the Alibaba Cloud account (primary account) to which the resource belongs.


attrResourceTypeRequired

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

Attribute ResourceType: The type of resource.


attrSourceCidrRequired

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

Attribute SourceCidr: The source address segment.


propsRequired

public IpamPoolAllocationProps getProps();