IpamPool
- Implements: IIpamPool
This class encapsulates and extends the ROS resource type ALIYUN::VPC::IpamPool.
Initializers
import com.aliyun.ros.cdk.vpc.IpamPool;
IpamPool.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.ipamScopeId(java.lang.String)
.ipamScopeId(IResolvable)
// .allocationDefaultCidrMask(java.lang.Number)
// .allocationDefaultCidrMask(IResolvable)
// .allocationMaxCidrMask(java.lang.Number)
// .allocationMaxCidrMask(IResolvable)
// .allocationMinCidrMask(java.lang.Number)
// .allocationMinCidrMask(IResolvable)
// .autoImport(java.lang.Boolean)
// .autoImport(IResolvable)
// .ipamPoolDescription(java.lang.String)
// .ipamPoolDescription(IResolvable)
// .ipamPoolName(java.lang.String)
// .ipamPoolName(IResolvable)
// .ipv6Isp(java.lang.String)
// .ipv6Isp(IResolvable)
// .ipVersion(java.lang.String)
// .ipVersion(IResolvable)
// .poolRegionId(java.lang.String)
// .poolRegionId(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .sourceIpamPoolId(java.lang.String)
// .sourceIpamPoolId(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. |
ipamScopeId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ipamScopeId: The ID of the IPAM scope. |
allocationDefaultCidrMask | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property allocationDefaultCidrMask: The default CIDR mask for allocation. |
allocationMaxCidrMask | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property allocationMaxCidrMask: The maximum CIDR mask for allocation. |
allocationMinCidrMask | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property allocationMinCidrMask: The minimum CIDR mask for allocation. |
autoImport | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property autoImport: Whether to automatically import the IPAM pool. |
ipamPoolDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ipamPoolDescription: The description of the IPAM pool. |
ipamPoolName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ipamPoolName: The name of the IPAM pool. |
ipv6Isp | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ipv6Isp: The IPv6 ISP for the IPAM pool. |
ipVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ipVersion: The IP version of the IPAM pool. |
poolRegionId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property poolRegionId: The ID of the region where the IPAM pool is located. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of the resource group to which the IPAM pool belongs. |
sourceIpamPoolId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property sourceIpamPoolId: The ID of the source IPAM pool. |
tags | java.util.List<TagsProperty> | Property tags: The tags of the IPAM pool. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
ipamScopeIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ipamScopeId: The ID of the IPAM scope.
This parameter is required.
allocationDefaultCidrMaskOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property allocationDefaultCidrMask: The default CIDR mask for allocation.
allocationMaxCidrMaskOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property allocationMaxCidrMask: The maximum CIDR mask for allocation.
allocationMinCidrMaskOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property allocationMinCidrMask: The minimum CIDR mask for allocation.
autoImportOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property autoImport: Whether to automatically import the IPAM pool.
ipamPoolDescriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ipamPoolDescription: The description of the IPAM pool.
ipamPoolNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ipamPoolName: The name of the IPAM pool.
ipv6IspOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ipv6Isp: The IPv6 ISP for the IPAM pool.
ipVersionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ipVersion: The IP version of the IPAM pool.
Valid values: IPv4, IPv6.
poolRegionIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property poolRegionId: The ID of the region where the IPAM pool is located.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group to which the IPAM pool belongs.
sourceIpamPoolIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property sourceIpamPoolId: The ID of the source IPAM pool.
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: The tags of the IPAM pool.
The maximum length is 21.
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.vpc.IpamPool;
IpamPool.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrIpamPoolId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IpamPoolId: The ID of the IPAM pool. |
props | IpamPoolProps | 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
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.
propsRequired
public IpamPoolProps getProps();
- Type: IpamPoolProps