UserDefineRegion
- Implements: IUserDefineRegion
This class encapsulates and extends the ROS resource type ALIYUN::EDAS::UserDefineRegion.
Initializers
import com.aliyun.ros.cdk.edas.UserDefineRegion;
UserDefineRegion.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.regionName(java.lang.String)
.regionName(IResolvable)
.regionTag(java.lang.String)
.regionTag(IResolvable)
// .debugEnable(java.lang.Boolean)
// .debugEnable(IResolvable)
// .description(java.lang.String)
// .description(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. |
regionName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property regionName: Logical region (or namespace) name. |
regionTag | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property regionTag: Logic region (or namespace) ID (format: "physical region ID: logical zone identifier", or "logical zone identifier"). |
debugEnable | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property debugEnable: Whether debug is enable. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: Logic region (or namespace) description. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
regionNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property regionName: Logical region (or namespace) name.
regionTagRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property regionTag: Logic region (or namespace) ID (format: "physical region ID: logical zone identifier", or "logical zone identifier").
debugEnableOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property debugEnable: Whether debug is enable.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: Logic region (or namespace) description.
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.edas.UserDefineRegion;
UserDefineRegion.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. |
attrBelongRegion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BelongRegion: Under the physical region ID. |
attrDebugEnable | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DebugEnable: Whether debug is enable. |
attrId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Id: Resource ID. |
attrRegionName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RegionName: Region name. |
attrUserId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UserId: User account ID. |
props | UserDefineRegionProps | 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
attrBelongRegionRequired
public java.lang.Object getAttrBelongRegion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BelongRegion: Under the physical region ID.
attrDebugEnableRequired
public java.lang.Object getAttrDebugEnable();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DebugEnable: Whether debug is enable.
attrIdRequired
public java.lang.Object getAttrId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Id: Resource ID.
attrRegionNameRequired
public java.lang.Object getAttrRegionName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RegionName: Region name.
attrUserIdRequired
public java.lang.Object getAttrUserId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UserId: User account ID.
propsRequired
public UserDefineRegionProps getProps();
- Type: UserDefineRegionProps