ALIYUN::OOS::Parameter-Resource Orchestration Service(ROS)-阿里云帮助中心

The ALIYUN::OOS::Parameter resource creates a common parameter.

Syntax

{
  "Type": "ALIYUN::OOS::Parameter",
  "Properties": {
    "Type": String,
    "Constraints": String,
    "Description": String,
    "Value": String,
    "Name": String,
    "ResourceGroupId": String
  }
}

Properties

Property Name	Type	Required	Update allowed	Description	Constraints
Type	String	Yes	No	The type of the parameter.	Valid values: String StringList
Constraints	String	No	No	The constraints of the parameter.	Valid values: AllowedValues: The allowed values for the parameter. The value is a string that represents an array. AllowedPattern: A regular expression. MinLength: The minimum length of the parameter. MaxLength: The maximum length of the parameter.
Description	String	No	Yes	The description of the parameter.	The description can be up to 200 characters long.
Value	String	Yes	Yes	The value of the parameter.	The value can be up to 4096 characters long.
Name	String	Yes	No	The name of the parameter.	The name can be up to 200 characters long. It cannot start with `ALIYUN`, `ACS`, `ALIBABA`, `ALICLOUD`, or `OOS`. The name can contain letters, digits, hyphens (-), and underscores (_).
ResourceGroupId	String	No	Yes	The ID of the resource group.	None

Return values

Fn::GetAtt

Name: The name of the parameter.
Value: The value of the parameter.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  Parameter:
    Type: ALIYUN::OOS::Parameter
    Properties:
      Type: String
      Value: echo hello world
      Description: Prefix for Interruption Handler parameters
      Name:
        Fn::Join:
          - ''
          - - /ecs-test-handler/run_commands/test-SampleWebAppAutoScalingGroup-
            - Ref: ALIYUN::StackId
Outputs:
  Value:
    Description: The Value of the parameter.
    Value:
      Fn::GetAtt:
        - Parameter
        - Value
  Name:
    Description: The Name of the parameter.
    Value:
      Fn::GetAtt:
        - Parameter
        - Name

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "Parameter": {
      "Type": "ALIYUN::OOS::Parameter",
      "Properties": {
        "Type": "String",
        "Value": "echo hello world",
        "Description": "Prefix for Interruption Handler parameters",
        "Name": {
          "Fn::Join": [
            "",
            [
              "/ecs-test-handler/run_commands/test-SampleWebAppAutoScalingGroup-",
              {
                "Ref": "ALIYUN::StackId"
              }
            ]
          ]
        }
      }
    }
  },
  "Outputs": {
    "Value": {
      "Description": "The Value of the parameter.",
      "Value": {
        "Fn::GetAtt": [
          "Parameter",
          "Value"
        ]
      }
    },
    "Name": {
      "Description": "The Name of the parameter.",
      "Value": {
        "Fn::GetAtt": [
          "Parameter",
          "Name"
        ]
      }
    }
  }
}