1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. arms
  5. Environment
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi

alicloud.arms.Environment

Explore with Pulumi AI

Provides a ARMS Environment resource. The arms environment.

For information about ARMS Environment and how to use it, see What is Environment.

NOTE: Available since v1.212.0.

Create Environment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: str,
                args: EnvironmentArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                environment_sub_type: Optional[str] = None,
                environment_type: Optional[str] = None,
                aliyun_lang: Optional[str] = None,
                bind_resource_id: Optional[str] = None,
                drop_metrics: Optional[str] = None,
                environment_name: Optional[str] = None,
                managed_type: Optional[str] = None,
                resource_group_id: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
type: alicloud:arms:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var alicloudEnvironmentResource = new AliCloud.Arms.Environment("alicloudEnvironmentResource", new()
{
    EnvironmentSubType = "string",
    EnvironmentType = "string",
    AliyunLang = "string",
    BindResourceId = "string",
    DropMetrics = "string",
    EnvironmentName = "string",
    ManagedType = "string",
    ResourceGroupId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := arms.NewEnvironment(ctx, "alicloudEnvironmentResource", &arms.EnvironmentArgs{
	EnvironmentSubType: pulumi.String("string"),
	EnvironmentType:    pulumi.String("string"),
	AliyunLang:         pulumi.String("string"),
	BindResourceId:     pulumi.String("string"),
	DropMetrics:        pulumi.String("string"),
	EnvironmentName:    pulumi.String("string"),
	ManagedType:        pulumi.String("string"),
	ResourceGroupId:    pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var alicloudEnvironmentResource = new Environment("alicloudEnvironmentResource", EnvironmentArgs.builder()
    .environmentSubType("string")
    .environmentType("string")
    .aliyunLang("string")
    .bindResourceId("string")
    .dropMetrics("string")
    .environmentName("string")
    .managedType("string")
    .resourceGroupId("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
alicloud_environment_resource = alicloud.arms.Environment("alicloudEnvironmentResource",
    environment_sub_type="string",
    environment_type="string",
    aliyun_lang="string",
    bind_resource_id="string",
    drop_metrics="string",
    environment_name="string",
    managed_type="string",
    resource_group_id="string",
    tags={
        "string": "string",
    })
Copy
const alicloudEnvironmentResource = new alicloud.arms.Environment("alicloudEnvironmentResource", {
    environmentSubType: "string",
    environmentType: "string",
    aliyunLang: "string",
    bindResourceId: "string",
    dropMetrics: "string",
    environmentName: "string",
    managedType: "string",
    resourceGroupId: "string",
    tags: {
        string: "string",
    },
});
Copy
type: alicloud:arms:Environment
properties:
    aliyunLang: string
    bindResourceId: string
    dropMetrics: string
    environmentName: string
    environmentSubType: string
    environmentType: string
    managedType: string
    resourceGroupId: string
    tags:
        string: string
Copy

Environment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Environment resource accepts the following input properties:

EnvironmentSubType
This property is required.
Changes to this property will trigger replacement.
string
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
EnvironmentType
This property is required.
Changes to this property will trigger replacement.
string
Type of environment.
AliyunLang string
The locale. The default is Chinese zh | en.
BindResourceId Changes to this property will trigger replacement. string
The id or vpcId of the bound container instance.
DropMetrics string
List of abandoned indicators.
EnvironmentName string
The name of the resource.
ManagedType Changes to this property will trigger replacement. string
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
ResourceGroupId string
The ID of the resource group.
Tags Dictionary<string, string>
The tag of the resource.
EnvironmentSubType
This property is required.
Changes to this property will trigger replacement.
string
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
EnvironmentType
This property is required.
Changes to this property will trigger replacement.
string
Type of environment.
AliyunLang string
The locale. The default is Chinese zh | en.
BindResourceId Changes to this property will trigger replacement. string
The id or vpcId of the bound container instance.
DropMetrics string
List of abandoned indicators.
EnvironmentName string
The name of the resource.
ManagedType Changes to this property will trigger replacement. string
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
ResourceGroupId string
The ID of the resource group.
Tags map[string]string
The tag of the resource.
environmentSubType
This property is required.
Changes to this property will trigger replacement.
String
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
environmentType
This property is required.
Changes to this property will trigger replacement.
String
Type of environment.
aliyunLang String
The locale. The default is Chinese zh | en.
bindResourceId Changes to this property will trigger replacement. String
The id or vpcId of the bound container instance.
dropMetrics String
List of abandoned indicators.
environmentName String
The name of the resource.
managedType Changes to this property will trigger replacement. String
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
resourceGroupId String
The ID of the resource group.
tags Map<String,String>
The tag of the resource.
environmentSubType
This property is required.
Changes to this property will trigger replacement.
string
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
environmentType
This property is required.
Changes to this property will trigger replacement.
string
Type of environment.
aliyunLang string
The locale. The default is Chinese zh | en.
bindResourceId Changes to this property will trigger replacement. string
The id or vpcId of the bound container instance.
dropMetrics string
List of abandoned indicators.
environmentName string
The name of the resource.
managedType Changes to this property will trigger replacement. string
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
resourceGroupId string
The ID of the resource group.
tags {[key: string]: string}
The tag of the resource.
environment_sub_type
This property is required.
Changes to this property will trigger replacement.
str
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
environment_type
This property is required.
Changes to this property will trigger replacement.
str
Type of environment.
aliyun_lang str
The locale. The default is Chinese zh | en.
bind_resource_id Changes to this property will trigger replacement. str
The id or vpcId of the bound container instance.
drop_metrics str
List of abandoned indicators.
environment_name str
The name of the resource.
managed_type Changes to this property will trigger replacement. str
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
resource_group_id str
The ID of the resource group.
tags Mapping[str, str]
The tag of the resource.
environmentSubType
This property is required.
Changes to this property will trigger replacement.
String
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
environmentType
This property is required.
Changes to this property will trigger replacement.
String
Type of environment.
aliyunLang String
The locale. The default is Chinese zh | en.
bindResourceId Changes to this property will trigger replacement. String
The id or vpcId of the bound container instance.
dropMetrics String
List of abandoned indicators.
environmentName String
The name of the resource.
managedType Changes to this property will trigger replacement. String
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
resourceGroupId String
The ID of the resource group.
tags Map<String>
The tag of the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:

EnvironmentId string
The first ID of the resource.
Id string
The provider-assigned unique ID for this managed resource.
EnvironmentId string
The first ID of the resource.
Id string
The provider-assigned unique ID for this managed resource.
environmentId String
The first ID of the resource.
id String
The provider-assigned unique ID for this managed resource.
environmentId string
The first ID of the resource.
id string
The provider-assigned unique ID for this managed resource.
environment_id str
The first ID of the resource.
id str
The provider-assigned unique ID for this managed resource.
environmentId String
The first ID of the resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Environment Resource

Get an existing Environment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EnvironmentState, opts?: CustomResourceOptions): Environment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aliyun_lang: Optional[str] = None,
        bind_resource_id: Optional[str] = None,
        drop_metrics: Optional[str] = None,
        environment_id: Optional[str] = None,
        environment_name: Optional[str] = None,
        environment_sub_type: Optional[str] = None,
        environment_type: Optional[str] = None,
        managed_type: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Environment
func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)
resources:  _:    type: alicloud:arms:Environment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AliyunLang string
The locale. The default is Chinese zh | en.
BindResourceId Changes to this property will trigger replacement. string
The id or vpcId of the bound container instance.
DropMetrics string
List of abandoned indicators.
EnvironmentId string
The first ID of the resource.
EnvironmentName string
The name of the resource.
EnvironmentSubType Changes to this property will trigger replacement. string
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
EnvironmentType Changes to this property will trigger replacement. string
Type of environment.
ManagedType Changes to this property will trigger replacement. string
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
ResourceGroupId string
The ID of the resource group.
Tags Dictionary<string, string>
The tag of the resource.
AliyunLang string
The locale. The default is Chinese zh | en.
BindResourceId Changes to this property will trigger replacement. string
The id or vpcId of the bound container instance.
DropMetrics string
List of abandoned indicators.
EnvironmentId string
The first ID of the resource.
EnvironmentName string
The name of the resource.
EnvironmentSubType Changes to this property will trigger replacement. string
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
EnvironmentType Changes to this property will trigger replacement. string
Type of environment.
ManagedType Changes to this property will trigger replacement. string
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
ResourceGroupId string
The ID of the resource group.
Tags map[string]string
The tag of the resource.
aliyunLang String
The locale. The default is Chinese zh | en.
bindResourceId Changes to this property will trigger replacement. String
The id or vpcId of the bound container instance.
dropMetrics String
List of abandoned indicators.
environmentId String
The first ID of the resource.
environmentName String
The name of the resource.
environmentSubType Changes to this property will trigger replacement. String
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
environmentType Changes to this property will trigger replacement. String
Type of environment.
managedType Changes to this property will trigger replacement. String
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
resourceGroupId String
The ID of the resource group.
tags Map<String,String>
The tag of the resource.
aliyunLang string
The locale. The default is Chinese zh | en.
bindResourceId Changes to this property will trigger replacement. string
The id or vpcId of the bound container instance.
dropMetrics string
List of abandoned indicators.
environmentId string
The first ID of the resource.
environmentName string
The name of the resource.
environmentSubType Changes to this property will trigger replacement. string
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
environmentType Changes to this property will trigger replacement. string
Type of environment.
managedType Changes to this property will trigger replacement. string
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
resourceGroupId string
The ID of the resource group.
tags {[key: string]: string}
The tag of the resource.
aliyun_lang str
The locale. The default is Chinese zh | en.
bind_resource_id Changes to this property will trigger replacement. str
The id or vpcId of the bound container instance.
drop_metrics str
List of abandoned indicators.
environment_id str
The first ID of the resource.
environment_name str
The name of the resource.
environment_sub_type Changes to this property will trigger replacement. str
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
environment_type Changes to this property will trigger replacement. str
Type of environment.
managed_type Changes to this property will trigger replacement. str
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
resource_group_id str
The ID of the resource group.
tags Mapping[str, str]
The tag of the resource.
aliyunLang String
The locale. The default is Chinese zh | en.
bindResourceId Changes to this property will trigger replacement. String
The id or vpcId of the bound container instance.
dropMetrics String
List of abandoned indicators.
environmentId String
The first ID of the resource.
environmentName String
The name of the resource.
environmentSubType Changes to this property will trigger replacement. String
Subtype of environment:

  • Type of CS: ACK is currently supported. ManagedKubernetes, Kubernetes, ExternalKubernetes, and One are also supported.
  • Type of ECS: currently supports ECS.
  • Type of Cloud: currently supports Cloud.
environmentType Changes to this property will trigger replacement. String
Type of environment.
managedType Changes to this property will trigger replacement. String
Hosting type:

  • none: unmanaged. The default value of the ACK cluster.
  • agent: Managed agent (including ksm). Default values of ASK, ACS, and Acone clusters.
  • agent-exproter: Managed agent and exporter. The default value of the cloud service type.
resourceGroupId String
The ID of the resource group.
tags Map<String>
The tag of the resource.

Import

ARMS Environment can be imported using the id, e.g.

$ pulumi import alicloud:arms/environment:Environment example <id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.