All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::ARMS::AddonRelease

Last Updated:Sep 10, 2024

ALIYUN::ARMS::AddonRelease is used to install an add-on release.

Syntax

{
  "Type": "ALIYUN::ARMS::AddonRelease",
  "Properties": {
    "AddonVersion": String,
    "EnvironmentId": String,
    "Name": String,
    "ReleaseName": String,
    "Values": Map
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

AddonVersion

String

Yes

No

The version of the add-on.

None.

EnvironmentId

String

Yes

No

The environment ID.

None.

Name

String

Yes

No

The add-on name.

None.

ReleaseName

String

No

No

The name that you want to use for the add-on after the add-on is installed.

If you do not specify this property, a default add-on name is generated based on the default rule.

Values

Map

No

Yes

The metadata.

None.

Return values

Fn::GetAtt

  • EnvironmentId: the environment ID.

  • Config: the configurations of the add-on release.

  • ReleaseName: the name that is used for the add-on after the add-on is installed.

  • Release: the information about the add-on release.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      ExtensionResource:
        Type: ALIYUN::ARMS::AddonRelease
        Properties:
          EnvironmentId: env-xxxx
          AddonVersion: 0.0.1
          ReleaseName: mysql-1695372983039
          Name: mysql
    Outputs:
      EnvironmentId:
        Description: The environment ID.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - EnvironmentId
      Config:
        Description: AddonRelease configuration information.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - Config
      ReleaseName:
        Description: The name of the add-on.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ReleaseName
      Release:
        Description: Release information.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - Release
    
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "ExtensionResource": {
          "Type": "ALIYUN::ARMS::AddonRelease",
          "Properties": {
            "EnvironmentId": "env-xxxx",
            "AddonVersion": "0.0.1",
            "ReleaseName": "mysql-1695372983039",
            "Name": "mysql"
          }
        }
      },
      "Outputs": {
        "EnvironmentId": {
          "Description": "The environment ID.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "EnvironmentId"
            ]
          }
        },
        "Config": {
          "Description": "AddonRelease configuration information.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Config"
            ]
          }
        },
        "ReleaseName": {
          "Description": "The name of the add-on.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ReleaseName"
            ]
          }
        },
        "Release": {
          "Description": "Release information.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Release"
            ]
          }
        }
      }
    }