Environment

This class encapsulates and extends the ROS resource type ALIYUN::APIG::Environment.

Initializers

import com.aliyun.ros.cdk.apig.Environment;
Environment.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .environmentName(java.lang.String)
    .environmentName(IResolvable)
    .gatewayId(java.lang.String)
    .gatewayId(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.
environmentName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property environmentName: The name of the environment.
gatewayId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property gatewayId: Gateway id.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: Description of the environment, which can include information such as the purpose of the environment and its owner.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

environmentName^Required

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

Property environmentName: The name of the environment.

---

gatewayId^Required

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

Property gatewayId: Gateway id.

---

description^Optional

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

Property description: Description of the environment, which can include information such as the purpose of the environment and its owner.

---

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.apig.Environment;
Environment.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.
attrDescription	com.aliyun.ros.cdk.core.IResolvable	Attribute Description: Description of the environment.
attrEnvironmentId	com.aliyun.ros.cdk.core.IResolvable	Attribute EnvironmentId: The ID of the environment.
attrEnvironmentName	com.aliyun.ros.cdk.core.IResolvable	Attribute EnvironmentName: The name of the resource.
attrGatewayId	com.aliyun.ros.cdk.core.IResolvable	Attribute GatewayId: The ID of the Gateway.

---

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

---

attrDescription^Required

public IResolvable getAttrDescription();

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

Attribute Description: Description of the environment.

---

attrEnvironmentId^Required

public IResolvable getAttrEnvironmentId();

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

Attribute EnvironmentId: The ID of the environment.

---

attrEnvironmentName^Required

public IResolvable getAttrEnvironmentName();

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

Attribute EnvironmentName: The name of the resource.

---

attrGatewayId^Required

public IResolvable getAttrGatewayId();

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

Attribute GatewayId: The ID of the Gateway.

---