Skip to content

EnvironmentProps

Properties for defining a Environment.

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

Initializer 

import com.aliyun.ros.cdk.arms.EnvironmentProps;
EnvironmentProps.builder()
    .bindResourceId(java.lang.String)
    .bindResourceId(IResolvable)
    .environmentName(java.lang.String)
    .environmentName(IResolvable)
    .environmentSubType(java.lang.String)
    .environmentSubType(IResolvable)
    .environmentType(java.lang.String)
    .environmentType(IResolvable)
//  .deletePromInstance(java.lang.Boolean)
//  .deletePromInstance(IResolvable)
//  .feePackage(java.lang.String)
//  .feePackage(IResolvable)
//  .grafanaWorkspaceId(java.lang.String)
//  .grafanaWorkspaceId(IResolvable)
//  .managedType(java.lang.String)
//  .managedType(IResolvable)
//  .prometheusInstanceId(java.lang.String)
//  .prometheusInstanceId(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

Properties

Name Type Description
bindResourceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property bindResourceId: The ID of the resource bound to the environment, such as the container ID or VPC ID.
environmentName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property environmentName: The name of the environment.
environmentSubType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property environmentSubType: The subtype of the environment.
environmentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property environmentType: The type of the environment.
deletePromInstance java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletePromInstance: Cascade delete Prometheus instance.
feePackage java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property feePackage: The payable resource plan.
grafanaWorkspaceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property grafanaWorkspaceId: The ID of the grafana workspace bound to the environment.
managedType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property managedType: Specifies whether agents or exporters are managed.
prometheusInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property prometheusInstanceId: The ID of the Prometheus instance.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
tags java.util.List<TagsProperty> Property tags: Tags of Environment.

bindResourceIdRequired 

public java.lang.Object getBindResourceId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getEnvironmentName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property environmentName: The name of the environment.

environmentSubTypeRequired 

public java.lang.Object getEnvironmentSubType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getEnvironmentType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property environmentType: The type of the environment.

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

deletePromInstanceOptional 

public java.lang.Object getDeletePromInstance();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property deletePromInstance: Cascade delete Prometheus instance.

Default value: true.

feePackageOptional 

public java.lang.Object getFeePackage();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getGrafanaWorkspaceId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getManagedType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getPrometheusInstanceId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

tagsOptional 

public java.util.List<TagsProperty> getTags();

Property tags: Tags of Environment.