1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. arms
  5. Environment
Alibaba Cloud v3.55.0 published on Tuesday, Apr 30, 2024 by Pulumi

alicloud.arms.Environment

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.55.0 published on Tuesday, Apr 30, 2024 by Pulumi

    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, Any]] = 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 string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var environmentResource = new AliCloud.Arms.Environment("environmentResource", new()
    {
        EnvironmentSubType = "string",
        EnvironmentType = "string",
        AliyunLang = "string",
        BindResourceId = "string",
        DropMetrics = "string",
        EnvironmentName = "string",
        ManagedType = "string",
        ResourceGroupId = "string",
        Tags = 
        {
            { "string", "any" },
        },
    });
    
    example, err := arms.NewEnvironment(ctx, "environmentResource", &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.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var environmentResource = new Environment("environmentResource", EnvironmentArgs.builder()        
        .environmentSubType("string")
        .environmentType("string")
        .aliyunLang("string")
        .bindResourceId("string")
        .dropMetrics("string")
        .environmentName("string")
        .managedType("string")
        .resourceGroupId("string")
        .tags(Map.of("string", "any"))
        .build());
    
    environment_resource = alicloud.arms.Environment("environmentResource",
        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": "any",
        })
    
    const environmentResource = new alicloud.arms.Environment("environmentResource", {
        environmentSubType: "string",
        environmentType: "string",
        aliyunLang: "string",
        bindResourceId: "string",
        dropMetrics: "string",
        environmentName: "string",
        managedType: "string",
        resourceGroupId: "string",
        tags: {
            string: "any",
        },
    });
    
    type: alicloud:arms:Environment
    properties:
        aliyunLang: string
        bindResourceId: string
        dropMetrics: string
        environmentName: string
        environmentSubType: string
        environmentType: string
        managedType: string
        resourceGroupId: string
        tags:
            string: any
    

    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

    The Environment resource accepts the following input properties:

    EnvironmentSubType string
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    EnvironmentType string
    Type of environment.
    AliyunLang string
    The locale. The default is Chinese zh | en.
    BindResourceId string
    The id or vpcId of the bound container instance.
    DropMetrics string
    List of abandoned indicators.
    EnvironmentName string
    The name of the resource.
    ManagedType 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, object>
    The tag of the resource.
    EnvironmentSubType string
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    EnvironmentType string
    Type of environment.
    AliyunLang string
    The locale. The default is Chinese zh | en.
    BindResourceId string
    The id or vpcId of the bound container instance.
    DropMetrics string
    List of abandoned indicators.
    EnvironmentName string
    The name of the resource.
    ManagedType 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]interface{}
    The tag of the resource.
    environmentSubType String
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    environmentType String
    Type of environment.
    aliyunLang String
    The locale. The default is Chinese zh | en.
    bindResourceId String
    The id or vpcId of the bound container instance.
    dropMetrics String
    List of abandoned indicators.
    environmentName String
    The name of the resource.
    managedType 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,Object>
    The tag of the resource.
    environmentSubType string
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    environmentType string
    Type of environment.
    aliyunLang string
    The locale. The default is Chinese zh | en.
    bindResourceId string
    The id or vpcId of the bound container instance.
    dropMetrics string
    List of abandoned indicators.
    environmentName string
    The name of the resource.
    managedType 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]: any}
    The tag of the resource.
    environment_sub_type str
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    environment_type str
    Type of environment.
    aliyun_lang str
    The locale. The default is Chinese zh | en.
    bind_resource_id 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 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, Any]
    The tag of the resource.
    environmentSubType String
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    environmentType String
    Type of environment.
    aliyunLang String
    The locale. The default is Chinese zh | en.
    bindResourceId String
    The id or vpcId of the bound container instance.
    dropMetrics String
    List of abandoned indicators.
    environmentName String
    The name of the resource.
    managedType 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<Any>
    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, Any]] = 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 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 string
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    EnvironmentType string
    Type of environment.
    ManagedType 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, object>
    The tag of the resource.
    AliyunLang string
    The locale. The default is Chinese zh | en.
    BindResourceId 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 string
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    EnvironmentType string
    Type of environment.
    ManagedType 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]interface{}
    The tag of the resource.
    aliyunLang String
    The locale. The default is Chinese zh | en.
    bindResourceId 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 String
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    environmentType String
    Type of environment.
    managedType 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,Object>
    The tag of the resource.
    aliyunLang string
    The locale. The default is Chinese zh | en.
    bindResourceId 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 string
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    environmentType string
    Type of environment.
    managedType 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]: any}
    The tag of the resource.
    aliyun_lang str
    The locale. The default is Chinese zh | en.
    bind_resource_id 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 str
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    environment_type str
    Type of environment.
    managed_type 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, Any]
    The tag of the resource.
    aliyunLang String
    The locale. The default is Chinese zh | en.
    bindResourceId 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 String
    Subtype of environment:

    • Type of CS: ACK is currently supported.
    • Type of ECS: currently supports ECS.
    • Type of Cloud: currently supports Cloud.
    environmentType String
    Type of environment.
    managedType 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<Any>
    The tag of the resource.

    Import

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

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

    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.
    alicloud logo
    Alibaba Cloud v3.55.0 published on Tuesday, Apr 30, 2024 by Pulumi