Skip to content

EnvironmentProps

Properties for defining a Environment.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-arms-environment

Initializer 

import { EnvironmentProps } from '@alicloud/ros-cdk-arms'
const environmentProps: EnvironmentProps = { ... }

Properties

Name Type Description
bindResourceId string | @alicloud/ros-cdk-core.IResolvable Property bindResourceId: The ID of the resource bound to the environment, such as the container ID or VPC ID.
environmentName string | @alicloud/ros-cdk-core.IResolvable Property environmentName: The name of the environment.
environmentSubType string | @alicloud/ros-cdk-core.IResolvable Property environmentSubType: The subtype of the environment.
environmentType string | @alicloud/ros-cdk-core.IResolvable Property environmentType: The type of the environment.
deletePromInstance boolean | @alicloud/ros-cdk-core.IResolvable Property deletePromInstance: Cascade delete Prometheus instance.
feePackage string | @alicloud/ros-cdk-core.IResolvable Property feePackage: The payable resource plan.
grafanaWorkspaceId string | @alicloud/ros-cdk-core.IResolvable Property grafanaWorkspaceId: The ID of the grafana workspace bound to the environment.
managedType string | @alicloud/ros-cdk-core.IResolvable Property managedType: Specifies whether agents or exporters are managed.
prometheusInstanceId string | @alicloud/ros-cdk-core.IResolvable Property prometheusInstanceId: The ID of the Prometheus instance.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
tags TagsProperty[] Property tags: Tags of Environment.

bindResourceIdRequired 

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

Property bindResourceId: The ID of the resource bound to the environment, such as the container ID or VPC ID.

For a Cloud environment, specify the region ID.

environmentNameRequired 

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

Property environmentName: The name of the environment.

environmentSubTypeRequired 

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

Property environmentSubType: The subtype of the environment.

Valid values: One: CS type environment ACK: CS type environment ECS: ECS type environment Cloud: cloud service

environmentTypeRequired 

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

Property environmentType: The type of the environment.

Valid values: CS: ACK ECS: ECS Cloud: cloud service

deletePromInstanceOptional 

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

Property deletePromInstance: Cascade delete Prometheus instance.

Default value: true.

feePackageOptional 

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

Property feePackage: The payable resource plan.

Valid values: If the EnvironmentType parameter is set to CS, set the value to CS_Basic or CS_Pro. Default value: CS_Basic. Otherwise, leave the parameter empty.

grafanaWorkspaceIdOptional 

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

Property grafanaWorkspaceId: The ID of the grafana workspace bound to the environment.

When passing space, the default share grafana is used.

managedTypeOptional 

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

Property managedType: Specifies whether agents or exporters are managed.

Valid values: none: No. By default, no managed agents or exporters are provided for ACK clusters. agent: Agents are managed. By default, managed agents are provided for ASK clusters, ACS clusters, and ACK One clusters. agent-exporter: Agents and exporters are managed. By default, managed agents and exporters are provided for cloud services.

prometheusInstanceIdOptional 

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

Property prometheusInstanceId: The ID of the Prometheus instance.

If no Prometheus instance is created, call the InitEnvironment operation to initialize a storage instance.

resourceGroupIdOptional 

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

Property resourceGroupId: The ID of the resource group.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags of Environment.