Skip to content

Environment

  • Implements: @alicloud/ros-cdk-arms.datasource.IEnvironment

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

Initializers

import { datasource } from '@alicloud/ros-cdk-arms'
new datasource.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.

scopeRequired

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

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • 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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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.

sessionRequired

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

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

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

addCount

public addCount(count: number | IResolvable): void

countRequired

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

addDependency

public addDependency(resource: Resource): void

resourceRequired

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

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

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

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct

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

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
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.
attrBindResourceId string | @alicloud/ros-cdk-core.IResolvable Attribute BindResourceId: The id or vpcId of the bound container instance.
attrBindResourceType string | @alicloud/ros-cdk-core.IResolvable Attribute BindResourceType: Binding resource type.
attrBindVpcCidr string | @alicloud/ros-cdk-core.IResolvable Attribute BindVpcCidr: The network segment of the bound vpc.
attrEnvironmentId string | @alicloud/ros-cdk-core.IResolvable Attribute EnvironmentId: The first ID of the resource.
attrEnvironmentName string | @alicloud/ros-cdk-core.IResolvable Attribute EnvironmentName: The name of the resource.
attrEnvironmentSubType string | @alicloud/ros-cdk-core.IResolvable Attribute EnvironmentSubType: Subtype of environment.
attrEnvironmentType string | @alicloud/ros-cdk-core.IResolvable Attribute EnvironmentType: Type of environment.
attrFeePackage string | @alicloud/ros-cdk-core.IResolvable Attribute FeePackage: Paid package.
attrGrafanaDatasourceUid string | @alicloud/ros-cdk-core.IResolvable Attribute GrafanaDatasourceUid: The uid of the Grafana data source.
attrGrafanaFolderUid string | @alicloud/ros-cdk-core.IResolvable Attribute GrafanaFolderUid: Binding Grafana directory uid.
attrManagedType string | @alicloud/ros-cdk-core.IResolvable Attribute ManagedType: Hosting type.
attrPrometheusInstanceId string | @alicloud/ros-cdk-core.IResolvable Attribute PrometheusInstanceId: The ID of the prometheus instance.
attrResourceGroupId string | @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrTags string | @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tag of the resource.
attrUserId string | @alicloud/ros-cdk-core.IResolvable Attribute UserId: User ID.
props EnvironmentProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrBindResourceIdRequired

public readonly attrBindResourceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute BindResourceId: The id or vpcId of the bound container instance.


attrBindResourceTypeRequired

public readonly attrBindResourceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute BindResourceType: Binding resource type.


attrBindVpcCidrRequired

public readonly attrBindVpcCidr: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute BindVpcCidr: The network segment of the bound vpc.


attrEnvironmentIdRequired

public readonly attrEnvironmentId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute EnvironmentId: The first ID of the resource.


attrEnvironmentNameRequired

public readonly attrEnvironmentName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute EnvironmentName: The name of the resource.


attrEnvironmentSubTypeRequired

public readonly attrEnvironmentSubType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute EnvironmentSubType: Subtype of environment.


attrEnvironmentTypeRequired

public readonly attrEnvironmentType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute EnvironmentType: Type of environment.


attrFeePackageRequired

public readonly attrFeePackage: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute FeePackage: Paid package.


attrGrafanaDatasourceUidRequired

public readonly attrGrafanaDatasourceUid: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute GrafanaDatasourceUid: The uid of the Grafana data source.


attrGrafanaFolderUidRequired

public readonly attrGrafanaFolderUid: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute GrafanaFolderUid: Binding Grafana directory uid.


attrManagedTypeRequired

public readonly attrManagedType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ManagedType: Hosting type.


attrPrometheusInstanceIdRequired

public readonly attrPrometheusInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PrometheusInstanceId: The ID of the prometheus instance.


attrResourceGroupIdRequired

public readonly attrResourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


attrTagsRequired

public readonly attrTags: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tag of the resource.


attrUserIdRequired

public readonly attrUserId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute UserId: User ID.


propsRequired

public readonly props: EnvironmentProps;