Environment

• Implements: IEnvironment

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

Initializers

import ros_cdk_arms
ros_cdk_arms.Environment(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

bind_resource_id^Required

• 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_name^Required

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

Property environmentName: The name of the environment.

environment_sub_type^Required

• 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_type^Required

• 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_instance^Optional

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

Property deletePromInstance: Cascade delete Prometheus instance.

Default value: true.

fee_package^Optional

• 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_id^Optional

• 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_type^Optional

• 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_id^Optional

• 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_id^Optional

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

Property resourceGroupId: The ID of the resource group.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags of Environment.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_arms
ros_cdk_arms.Environment.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_environment_id^Required

attr_environment_id: typing.Union[str, IResolvable]

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

Attribute EnvironmentId: The id of the environment.

attr_environment_name^Required

attr_environment_name: typing.Union[str, IResolvable]

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

Attribute EnvironmentName: The name of the environment.

attr_environment_sub_type^Required

attr_environment_sub_type: typing.Union[str, IResolvable]

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

Attribute EnvironmentSubType: The subtype of the environment.

attr_environment_type^Required

attr_environment_type: typing.Union[str, IResolvable]

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

Attribute EnvironmentType: The type of the environment.

attr_fee_package^Required

attr_fee_package: typing.Union[str, IResolvable]

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

Attribute FeePackage: The payable resource plan.

attr_grafana_workspace_id^Required

attr_grafana_workspace_id: typing.Union[str, IResolvable]

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

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

attr_managed_type^Required

attr_managed_type: typing.Union[str, IResolvable]

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

Attribute ManagedType: Specifies whether agents or exporters are managed.

attr_prometheus_instance_id^Required

attr_prometheus_instance_id: typing.Union[str, IResolvable]

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

Attribute PrometheusInstanceId: The ID of the Prometheus instance.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group.

props^Required

props: EnvironmentProps

• Type: EnvironmentProps