Environment

This class encapsulates and extends the ROS resource type ALIYUN::ARMS::Environment, which is used to create an environment.

Initializers

import { Environment } from '@alicloud/ros-cdk-arms'
new Environment(scope: Construct, id: string, props: EnvironmentProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	EnvironmentProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: EnvironmentProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { Environment } from '@alicloud/ros-cdk-arms'
Environment.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrEnvironmentId	@alicloud/ros-cdk-core.IResolvable	Attribute EnvironmentId: The id of the environment.
attrEnvironmentName	@alicloud/ros-cdk-core.IResolvable	Attribute EnvironmentName: The name of the environment.
attrEnvironmentSubType	@alicloud/ros-cdk-core.IResolvable	Attribute EnvironmentSubType: The subtype of the environment.
attrEnvironmentType	@alicloud/ros-cdk-core.IResolvable	Attribute EnvironmentType: The type of the environment.
attrFeePackage	@alicloud/ros-cdk-core.IResolvable	Attribute FeePackage: The payable resource plan.
attrGrafanaWorkspaceId	@alicloud/ros-cdk-core.IResolvable	Attribute GrafanaWorkspaceId: The ID of the grafana workspace bound to the environment.
attrManagedType	@alicloud/ros-cdk-core.IResolvable	Attribute ManagedType: Specifies whether agents or exporters are managed.
attrPrometheusInstanceId	@alicloud/ros-cdk-core.IResolvable	Attribute PrometheusInstanceId: The ID of the Prometheus instance.
attrResourceGroupId	@alicloud/ros-cdk-core.IResolvable	Attribute ResourceGroupId: The ID of the resource group.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrEnvironmentId^Required

public readonly attrEnvironmentId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnvironmentId: The id of the environment.

---

attrEnvironmentName^Required

public readonly attrEnvironmentName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnvironmentName: The name of the environment.

---

attrEnvironmentSubType^Required

public readonly attrEnvironmentSubType: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnvironmentSubType: The subtype of the environment.

---

attrEnvironmentType^Required

public readonly attrEnvironmentType: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnvironmentType: The type of the environment.

---

attrFeePackage^Required

public readonly attrFeePackage: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute FeePackage: The payable resource plan.

---

attrGrafanaWorkspaceId^Required

public readonly attrGrafanaWorkspaceId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute GrafanaWorkspaceId: The ID of the grafana workspace bound to the environment.

---

attrManagedType^Required

public readonly attrManagedType: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ManagedType: Specifies whether agents or exporters are managed.

---

attrPrometheusInstanceId^Required

public readonly attrPrometheusInstanceId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute PrometheusInstanceId: The ID of the Prometheus instance.

---

attrResourceGroupId^Required

public readonly attrResourceGroupId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

---