ALIYUN::OOS::Parameter - Resource Orchestration Service - Alibaba Cloud Documentation Center

ALIYUN::OOS::Parameter is used to create a common parameter.

Syntax

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

Properties


Property	Type	Required	Editable	Description	Constraint
Type	String	Yes	No	The data type of the parameter.	Valid values: String StringList
Constraints	String	No	No	The constraints of the parameter.	Valid values: AllowedValues: the valid values of the parameter. This value can be a string in the array format. AllowedPattern: the regular expression of the parameter. 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 in length.
Value	String	Yes	Yes	The value of the parameter.	The parameter value can be up to 4,096 characters in length.
Name	String	Yes	No	The name of the parameter.	The name can be up to 200 characters in length. 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

Response parameters

Fn::GetAtt

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

Examples

YAMLformat

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

JSONformat

{
  "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"
        ]
      }
    }
  }
}