Skip to content

EnvironmentProps

Properties for defining a Environment.

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

Initializer 

import ros_cdk_arms
ros_cdk_arms.EnvironmentProps(
  bind_resource_id: typing.Union[str, IResolvable],
  environment_name: typing.Union[str, IResolvable],
  environment_sub_type: typing.Union[str, IResolvable],
  environment_type: typing.Union[str, IResolvable],
  delete_prom_instance: typing.Union[bool, IResolvable] = None,
  fee_package: typing.Union[str, IResolvable] = None,
  grafana_workspace_id: typing.Union[str, IResolvable] = None,
  managed_type: typing.Union[str, IResolvable] = None,
  prometheus_instance_id: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None
)

Properties

Name Type Description
bind_resource_id typing.Union[str, ros_cdk_core.IResolvable] Property bindResourceId: The ID of the resource bound to the environment, such as the container ID or VPC ID.
environment_name typing.Union[str, ros_cdk_core.IResolvable] Property environmentName: The name of the environment.
environment_sub_type typing.Union[str, ros_cdk_core.IResolvable] Property environmentSubType: The subtype of the environment.
environment_type typing.Union[str, ros_cdk_core.IResolvable] Property environmentType: The type of the environment.
delete_prom_instance typing.Union[bool, ros_cdk_core.IResolvable] Property deletePromInstance: Cascade delete Prometheus instance.
fee_package typing.Union[str, ros_cdk_core.IResolvable] Property feePackage: The payable resource plan.
grafana_workspace_id typing.Union[str, ros_cdk_core.IResolvable] Property grafanaWorkspaceId: The ID of the grafana workspace bound to the environment.
managed_type typing.Union[str, ros_cdk_core.IResolvable] Property managedType: Specifies whether agents or exporters are managed.
prometheus_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property prometheusInstanceId: The ID of the Prometheus instance.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
tags typing.List[TagsProperty] Property tags: Tags of Environment.

bind_resource_idRequired 

bind_resource_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

environment_nameRequired 

environment_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property environmentName: The name of the environment.

environment_sub_typeRequired 

environment_sub_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

environment_typeRequired 

environment_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property environmentType: The type of the environment.

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

delete_prom_instanceOptional 

delete_prom_instance: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property deletePromInstance: Cascade delete Prometheus instance.

Default value: true.

fee_packageOptional 

fee_package: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

grafana_workspace_idOptional 

grafana_workspace_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

managed_typeOptional 

managed_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

prometheus_instance_idOptional 

prometheus_instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

resource_group_idOptional 

resource_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

tagsOptional 

tags: typing.List[TagsProperty]

Property tags: Tags of Environment.