Environment

• Implements: IEnvironment

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

Initializers

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

scope^Required

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

id^Required

• Type: string

props^Required

• Type: EnvironmentProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

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

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

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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.

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: string | IResolvable;

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

Attribute EnvironmentId: The id of the environment.

attrEnvironmentName^Required

public readonly attrEnvironmentName: string | IResolvable;

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

Attribute EnvironmentName: The name of the environment.

attrEnvironmentSubType^Required

public readonly attrEnvironmentSubType: string | IResolvable;

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

Attribute EnvironmentSubType: The subtype of the environment.

attrEnvironmentType^Required

public readonly attrEnvironmentType: string | IResolvable;

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

Attribute EnvironmentType: The type of the environment.

attrFeePackage^Required

public readonly attrFeePackage: string | IResolvable;

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

Attribute FeePackage: The payable resource plan.

attrGrafanaWorkspaceId^Required

public readonly attrGrafanaWorkspaceId: string | IResolvable;

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

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

attrManagedType^Required

public readonly attrManagedType: string | IResolvable;

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

Attribute ManagedType: Specifies whether agents or exporters are managed.

attrPrometheusInstanceId^Required

public readonly attrPrometheusInstanceId: string | IResolvable;

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

Attribute PrometheusInstanceId: The ID of the Prometheus instance.

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

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

Attribute ResourceGroupId: The ID of the resource group.

props^Required

public readonly props: EnvironmentProps;

• Type: EnvironmentProps