IpamScope

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

Initializers

import com.aliyun.ros.cdk.vpc.IpamScope;
IpamScope.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .ipamId(java.lang.String)
    .ipamId(IResolvable)
//  .ipamScopeDescription(java.lang.String)
//  .ipamScopeDescription(IResolvable)
//  .ipamScopeName(java.lang.String)
//  .ipamScopeName(IResolvable)
//  .ipamScopeType(java.lang.String)
//  .ipamScopeType(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.
ipamId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property ipamId: The id of the Ipam instance.
ipamScopeDescription	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property ipamScopeDescription: The description of the IPAM's scope of action.
ipamScopeName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property ipamScopeName: The name of the IPAM scope.
ipamScopeType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property ipamScopeType: IPAM scope of action type: private.
tags	java.util.List<TagsProperty>	Property tags: Tags of ipam scope.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

ipamId^Required

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

Property ipamId: The id of the Ipam instance.

---

ipamScopeDescription^Optional

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

Property ipamScopeDescription: The description of the IPAM's scope of action.

It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

---

ipamScopeName^Optional

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

Property ipamScopeName: The name of the IPAM scope.

---

ipamScopeType^Optional

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

Property ipamScopeType: IPAM scope of action type: private.

Currently, only the role scope of the private network is supported.

---

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags of ipam scope.

---

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.IpamScope;
IpamScope.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 scope.
attrIpamId	com.aliyun.ros.cdk.core.IResolvable	Attribute IpamId: The id of the Ipam instance.
attrIpamScopeDescription	com.aliyun.ros.cdk.core.IResolvable	Attribute IpamScopeDescription: The description of the IPAM's scope of action.
attrIpamScopeId	com.aliyun.ros.cdk.core.IResolvable	Attribute IpamScopeId: The ID of the IPAM scope.
attrIpamScopeName	com.aliyun.ros.cdk.core.IResolvable	Attribute IpamScopeName: The name of the IPAM scope.
attrIpamScopeType	com.aliyun.ros.cdk.core.IResolvable	Attribute IpamScopeType: IPAM scope of action type.
attrTags	com.aliyun.ros.cdk.core.IResolvable	Attribute Tags: The tag of the IPAM scope.

---

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 scope.

---

attrIpamId^Required

public IResolvable getAttrIpamId();

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

Attribute IpamId: The id of the Ipam instance.

---

attrIpamScopeDescription^Required

public IResolvable getAttrIpamScopeDescription();

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

Attribute IpamScopeDescription: The description of the IPAM's scope of action.

---

attrIpamScopeId^Required

public IResolvable getAttrIpamScopeId();

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

Attribute IpamScopeId: The ID of the IPAM scope.

---

attrIpamScopeName^Required

public IResolvable getAttrIpamScopeName();

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

Attribute IpamScopeName: The name of the IPAM scope.

---

attrIpamScopeType^Required

public IResolvable getAttrIpamScopeType();

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

Attribute IpamScopeType: IPAM scope of action type.

---

attrTags^Required

public IResolvable getAttrTags();

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

Attribute Tags: The tag of the IPAM scope.

---