All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::ARMS::EnvironmentFeature

Last Updated:Sep 10, 2024

ALIYUN::ARMS::EnvironmentFeature is used to install a feature.

Syntax

{
  "Type": "ALIYUN::ARMS::EnvironmentFeature",
  "Properties": {
    "EnvironmentId": String,
    "FeatureVersion": String,
    "FeatureName": String,
    "Config": Map
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

EnvironmentId

String

Yes

No

The environment ID.

None.

FeatureVersion

String

Yes

No

The version of the feature.

None.

FeatureName

String

Yes

No

The feature name.

None.

Config

Map

No

Yes

The metadata information about the feature.

None.

Return values

Fn::GetAtt

  • EnvironmentId: the environment ID.

  • FeatureStatus: the state of the feature.

  • Feature: the installation information about the feature.

  • FeatureName: the feature name.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      ExtensionResource:
        Type: ALIYUN::ARMS::EnvironmentFeature
        Properties:
          EnvironmentId: env-xxxxx
          FeatureVersion: 1.1.17
          FeatureName: metric-agent
    Outputs:
      EnvironmentId:
        Description: The environment ID.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - EnvironmentId
      FeatureStatus:
        Description: The status of the feature.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - FeatureStatus
      Feature:
        Description: The installation information of the feature.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - Feature
      FeatureName:
        Description: The name of the feature.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - FeatureName
    
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "ExtensionResource": {
          "Type": "ALIYUN::ARMS::EnvironmentFeature",
          "Properties": {
            "EnvironmentId": "env-xxxxx",
            "FeatureVersion": "1.1.17",
            "FeatureName": "metric-agent"
          }
        }
      },
      "Outputs": {
        "EnvironmentId": {
          "Description": "The environment ID.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "EnvironmentId"
            ]
          }
        },
        "FeatureStatus": {
          "Description": "The status of the feature.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "FeatureStatus"
            ]
          }
        },
        "Feature": {
          "Description": "The installation information of the feature.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Feature"
            ]
          }
        },
        "FeatureName": {
          "Description": "The name of the feature.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "FeatureName"
            ]
          }
        }
      }
    }