Ipam

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

Initializers

import com.aliyun.ros.cdk.vpc.Ipam;
Ipam.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .operatingRegionList(IResolvable)
    .operatingRegionList(java.util.List<java.lang.String)
    .operatingRegionList(IResolvable>)
//  .ipamDescription(java.lang.String)
//  .ipamDescription(IResolvable)
//  .ipamName(java.lang.String)
//  .ipamName(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(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.
operatingRegionList	com.aliyun.ros.cdk.core.IResolvable OR java.util.List	Property operatingRegionList: List of IPAM effective regions.
ipamDescription	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property ipamDescription: The description of IPAM.
ipamName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property ipamName: The name of the IPAM.
resourceGroupId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property resourceGroupId: The ID of the resource group.
tags	java.util.List<TagsProperty>	Property tags: Tags of ipam.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

operatingRegionList^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property operatingRegionList: List of IPAM effective regions.

---

ipamDescription^Optional

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

Property ipamDescription: The description of IPAM.

It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http:// 'or 'https. If the description is not filled in, it is blank. The default value is blank.

---

ipamName^Optional

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

Property ipamName: The name of the IPAM.

---

resourceGroupId^Optional

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

Property resourceGroupId: The ID of the resource group.

---

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags of ipam.

---

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.

session^Required

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

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

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

---

addDependency

public void addDependency(Resource resource)

resource^Required

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

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import com.aliyun.ros.cdk.vpc.Ipam;
Ipam.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• 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 IPAM.
attrDefaultResourceDiscoveryAssociationId	com.aliyun.ros.cdk.core.IResolvable	Attribute DefaultResourceDiscoveryAssociationId: After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.
attrDefaultResourceDiscoveryId	com.aliyun.ros.cdk.core.IResolvable	Attribute DefaultResourceDiscoveryId: After IPAM is created, the system creates resource discovery by default.
attrIpamDescription	com.aliyun.ros.cdk.core.IResolvable	Attribute IpamDescription: The description of IPAM.
attrIpamId	com.aliyun.ros.cdk.core.IResolvable	Attribute IpamId: The first ID of the resource.
attrIpamName	com.aliyun.ros.cdk.core.IResolvable	Attribute IpamName: The name of the IPAM.
attrOperatingRegionList	com.aliyun.ros.cdk.core.IResolvable	Attribute OperatingRegionList: List of IPAM effective regions.
attrPrivateDefaultScopeId	com.aliyun.ros.cdk.core.IResolvable	Attribute PrivateDefaultScopeId: After an IPAM is created, the scope of the private network IPAM created by the system by default.
attrPublicDefaultScopeId	com.aliyun.ros.cdk.core.IResolvable	Attribute PublicDefaultScopeId: After an IPAM is created, the public network IPAM is created by default.
attrResourceDiscoveryAssociationCount	com.aliyun.ros.cdk.core.IResolvable	Attribute ResourceDiscoveryAssociationCount: The number of resource discovery objects associated with IPAM.
attrResourceGroupId	com.aliyun.ros.cdk.core.IResolvable	Attribute ResourceGroupId: The ID of the resource group.
attrTags	com.aliyun.ros.cdk.core.IResolvable	Attribute Tags: The tag of the IPAM.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

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

---

attrCreateTime^Required

public IResolvable getAttrCreateTime();

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

Attribute CreateTime: The creation time of the IPAM.

---

attrDefaultResourceDiscoveryAssociationId^Required

public IResolvable getAttrDefaultResourceDiscoveryAssociationId();

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

Attribute DefaultResourceDiscoveryAssociationId: After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.

---

attrDefaultResourceDiscoveryId^Required

public IResolvable getAttrDefaultResourceDiscoveryId();

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

Attribute DefaultResourceDiscoveryId: After IPAM is created, the system creates resource discovery by default.

---

attrIpamDescription^Required

public IResolvable getAttrIpamDescription();

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

Attribute IpamDescription: The description of IPAM.

---

attrIpamId^Required

public IResolvable getAttrIpamId();

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

Attribute IpamId: The first ID of the resource.

---

attrIpamName^Required

public IResolvable getAttrIpamName();

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

Attribute IpamName: The name of the IPAM.

---

attrOperatingRegionList^Required

public IResolvable getAttrOperatingRegionList();

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

Attribute OperatingRegionList: List of IPAM effective regions.

---

attrPrivateDefaultScopeId^Required

public IResolvable getAttrPrivateDefaultScopeId();

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

Attribute PrivateDefaultScopeId: After an IPAM is created, the scope of the private network IPAM created by the system by default.

---

attrPublicDefaultScopeId^Required

public IResolvable getAttrPublicDefaultScopeId();

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

Attribute PublicDefaultScopeId: After an IPAM is created, the public network IPAM is created by default.

---

attrResourceDiscoveryAssociationCount^Required

public IResolvable getAttrResourceDiscoveryAssociationCount();

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

Attribute ResourceDiscoveryAssociationCount: The number of resource discovery objects associated with IPAM.

---

attrResourceGroupId^Required

public IResolvable getAttrResourceGroupId();

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

Attribute ResourceGroupId: The ID of the resource group.

---

attrTags^Required

public IResolvable getAttrTags();

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

Attribute Tags: The tag of the IPAM.

---