All Products
Search
Document Center

Resource Orchestration Service:AssociationProperty and AssociationPropertyMetadata

Last Updated:Dec 16, 2024

When you create a stack in the Resource Orchestration Service (ROS) console to manage multiple categories of resources, you may need to open multiple consoles to query resource parameters. In the Parameters section of a template, you can specify AssociationProperty for parameters to query the resources in the specified region and specify AssociationPropertyMetadata to add filter conditions for the parameters. This way, you can select parameter configurations based on optional values in the ROS console.

Parameters

You can specify one of the following types of values for parameters in AssociationPropertyMetadata:

  • Literal value. For example, if you set AssociationPropertyMetadata to "RegionId": "cn-hangzhou", ROS resolves this value as the literal value cn-hangzhou.

  • Variable. Specify a variable in the ${ParameterKey} format. For example, if you set AssociationPropertyMetadata to "VpcId": "${VpcId}", ROS resolves this value as a variable that varies based on the value of the VpcId parameter in the template.

    Note
    • If you want to specify a variable in the ${ParameterKey} format as a literal value, you can add an exclamation point (!) to ${ParameterKey} to use the ${!ParameterKey} format. For example, if you set a value to ${!Literal}, ROS resolves this value as ${Literal}.

    • If you want to specify a variable for a parameter in a Terraform template, add a dollar sign ($) to ${ParameterKey} to use the $${ParameterKey} format. For example, if you set AssociationPropertyMetadata to "VpcId": "$${VpcId}", ROS resolves this value as a variable that varies based on the value of the VpcId parameter in the Terraform template.

The supported parameters in AssociationPropertyMetadata vary based on different categories of resources that you specify as AssociationProperty values. The following section describes the mappings between the AssociationProperty values and the parameters in AssociationPropertyMetadata in ROS.

Basic resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

Auto

ROS automatically generates parameters, such as AssociationProperty and AssociationPropertyMetadata, based on the original data structure of Terraform.

Note

This value takes effect only for the JSON parameters in Terraform templates.

Overwrite: optional. Appends values to or overwrites the declarations of nested parameters in the inner level.

The value of Overwrite is of the dictionary data type and consists of key-value pairs.

  • Key

    The path of nested parameters in the inner level. You must follow the following rules to specify a path:

    • To specify an element in a list or set, you must add an asterisk (*).

    • To specify an element in an object, you must add the name of the element.

    • Separate multiple elements in a path with periods (.).

    • Asterisks (*) at the start of a path and in the middle of a path can be omitted. One or more asterisks (*) at the end of a path must be retained.

    Example:

    // The path of name is name. 
    // The path of address is address. 
    variable "user_information" {
      type = object({
        name    = string
        address = string
      })
    }
    
    // The path of an element in region_ids is *. 
    variable "region_ids" {
      type    = list(string)
    }
    
    // The path of internal is *.internal, which can be abbreviated as internal. 
    // The path of external is *.external, which can be abbreviated as external. 
    // The path of protocol is *.protocol, which can be abbreviated as protocol. 
    variable "docker_ports" {
      type = list(object({
        internal = number
        external = number
        protocol = string
      }))
    }
    
    // The path of b is *.b, which can be abbreviated as b. 
    // The path of an element in b is *.b.*, which can be abbreviated as b.*.
    // The path of c is *.c, which can be abbreviated as c. 
    // The path of d is *.c.*.d, which can be abbreviated as c.d. 
    // The path of an element in d is *.c.*.d.*, which can be abbreviated as c.d.*. 
    // The path of e is *.e, which can be abbreviated as e. 
    // The path of an element in e is *.e.*, which can be abbreviated as e.*. 
    // The path of an element in e is *.e.*.*, which can be abbreviated as e.*.*. You must retain the two asterisks (*) at the end of the path. 
    // The path of f is *.f, which can be abbreviated as f. 
    // The path of g is *.f.*.*.g, which can be abbreviated as f.g. 
    // The path of an element in g is *.f.*.*.g.*, which can be abbreviated as f.g.*. 
    variable "complex_type_demo" {
      type = list(object({
        b = list(string)
        c = list(object({
          d = list(string)
        }))
        e = list(list(string))
        f = list(list(object({
          g = list(string)
        })))
      }))
    }
  • Value

    The value that you want to append to the declaration of a parameter. For more information, see Overview.

AutoCompleteInput

The random string that is automatically generated by the system.

  • CharacterClasses

    • Class: the character type. Valid values:

      • lowercase

      • uppercase

      • number

      • specialCharacter

    • Min: the minimum number of characters in the string.

    • SpecialCharacters: the special characters in the string. This parameter is valid when Class is set to specialCharacter.

    • Start: specifies whether the string can start with a special character. This parameter is valid when Class is set to specialCharacter.

    • End: specifies whether the string can end with a special character. This parameter is valid when Class is set to specialCharacter.

  • Prefix: the prefix of the string.

  • Suffix: the suffix of the string.

  • Length: the number of characters in the string.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ManagedKubernetesClusterName": {
      "Type": "String",
      "Label": {
        "en": "Managed Kubernetes Cluster Name",
         
      },
      "AssociationProperty": "AutoCompleteInput",
      "AssociationPropertyMetadata": {
        "Length": 5,
        "Prefix": "cluster-for-mse-",
        "Suffix": "-by-ros",
        "CharacterClasses": [
          {
            "Class": "lowercase",
            "min": 1
          }
        ]
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ManagedKubernetesClusterName:
    Type: String
    Label:
      en: Managed Kubernetes Cluster Name
       
    AssociationProperty: AutoCompleteInput
    AssociationPropertyMetadata:
      Length: 5
      Prefix: cluster-for-mse-
      Suffix: '-by-ros'
      CharacterClasses:
        - Class: lowercase
          min: 1

ChargeType

The billing method. The following billing methods are supported:

  • pay-as-you-go

  • subscription

None.

Code

The code.

None.

CommaDelimitedList

The array in which elements are separated by commas (,).

None.

Cron

The CRON expression, which is a formatted string and specifies the execution time of a scheduled task.

None.

DateTime

The date.

  • GMTZone: the Greenwich Mean Time (GMT) time zone.

  • TimeZone: the description of the time zone.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "DateTime": {
          "Type": "String",
          "AssociationProperty": "DateTime"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      DateTime:
        Type: String
        AssociationProperty: DateTime
  • Example description

    In the example for DateTime, AssociationProperty is set to DateTime. This way, you can specify the date.

FileContent

The content that is read from a local file.

AcceptFileSuffixes: the formats of files that you can upload. Separate multiple file formats with commas (,).

GMTZone

The GMT time zone.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "GMTZone": {
          "Type": "String",
          "AssociationProperty": "GMTZone"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      GMTZone:
        Type: String
        AssociationProperty: GMTZone
  • Example description

    In the example for GMTZone, AssociationProperty is set to GMTZone. This way, you can specify the GMT time zone.

Json

The JSON object.

None.

List[Parameter]

The list of parameters. The ROS console displays the values of a parameter only after you click the relevant button.

This value takes effect only for JSON parameters.

Parameter: the declarations of parameters.

For more information, see Overview.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionIds": {
          "Label": {
            "en": "ECS Region Ids",
             
          },
          "MaxLength": 100,
          "MinLength": 1,
          "Type": "Json",
          "AssociationProperty": "List[Parameter]",
          "AssociationPropertyMetadata": {
            "Parameter": {
              "Type": "String",
              "AssociationProperty": "ALIYUN::ECS::RegionId",
              "MinLength": 1,
              "MaxLength": 64
            }
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionIds:
        Label:
          en: ECS Region Ids
           
        MaxLength: 100
        MinLength: 1
        Type: Json
        AssociationProperty: List[Parameter]
        AssociationPropertyMetadata:
          Parameter:
            Type: String
            AssociationProperty: ALIYUN::ECS::RegionId
            MinLength: 1
            MaxLength: 64
  • Example description

    In this example, AssociationProperty is set to List[Parameter], and Parameter is specified in AssociationPropertyMetadata. This way, you can add a list of Elastic Compute Service (ECS) region IDs in the ROS console.

List[Parameters]

The list of parameter sets. The parameter sets are displayed in a table in the ROS console.

This value takes effect only for JSON parameters.

  • Parameters: required. The declarations of parameter sets. The value of Parameters is of the dictionary data type and consists of key-value pairs.

    • Key: the parameter name.

    • Value: the parameter value. For more information, see Overview.

      Note

      Parameters of the basic data type can be easily parsed in a table. We recommend that you do not nest parameters because the parameters are displayed in a table.

    Example:

    • Sample code

      JSON format:

      {
        "ROSTemplateFormatVersion": "2015-09-01",
        "Parameters": {
          "RenameECS": {
            "Label": {
              "en": "Rename ECS",
               
            },
            "MaxLength": 100,
            "MinLength": 1,
            "Type": "Json",
            "AssociationProperty": "List[Parameters]",
            "AssociationPropertyMetadata": {
              "Parameters": {
                "InstanceId": {
                  "Type": "String",
                  "Label": {
                    "en": "ECS Instance Id",
                     
                  },
                  "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
                  "MinLength": 1,
                  "MaxLength": 64
                },
                "Name": {
                  "Type": "String",
                  "Label": {
                    "en": "New Name",
                     
                  },
                  "MinLength": 1
                }
              }
            }
          }
        }
      }

      YAML format:

      ROSTemplateFormatVersion: '2015-09-01'
      Parameters:
        RenameECS:
          Label:
            en: Rename ECS
             
          MaxLength: 100
          MinLength: 1
          Type: Json
          AssociationProperty: List[Parameters]
          AssociationPropertyMetadata:
            Parameters:
              InstanceId:
                Type: String
                Label:
                  en: ECS Instance Id
                   
                AssociationProperty: ALIYUN::ECS::Instance::InstanceId
                MinLength: 1
                MaxLength: 64
              Name:
                Type: String
                Label:
                  en: New Name
                   
                MinLength: 1
    • Example description

      In this example, AssociationProperty is set to List[Parameters], and Parameters is specified in AssociationPropertyMetadata. This way, ECS instance IDs are displayed in a table in the ROS console.

  • ListMetadata: specifies whether to show the components of a table. The value of ListMetadata is of the dictionary data type.

    • ShowHeader: specifies whether to show the header of the table. The value of ShowHeader is of the enumerated data type. Default value: true.

    • ShowRemove: specifies whether to show the removal icon of the table. The value of ShowRemove is of the enumerated data type. Default value: true.

    • ShowAddition: specifies whether to show the Add icon of the table. The value of ShowAddition is of the enumerated data type. Default value: true.

    • Order: the order in which parameter names are displayed as column names in the table from left to right. The value of Order is of the string data type. By default, all parameter names are displayed in alphabetical order.

OOSServiceRole

The Resource Access Management (RAM) role of CloudOps Orchestration Service (OOS).

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "OosServiceRole": {
          "Type": "String",
          "AssociationProperty": "OOSServiceRole",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      OosServiceRole:
        Type: String
        AssociationProperty: OOSServiceRole
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for OosServiceRole, AssociationProperty is set to OOSServiceRole. This way, you can specify the RAM role of OOS.

Password

The password.

None.

RateControl

The rate control for the OOS execution.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RateControl": {
          "Type": "String",
          "AssociationProperty": "RateControl"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RateControl:
        Type: String
        AssociationProperty: RateControl
  • Example description

    In the example for RateControl, AssociationProperty is set to RateControl. This way, you can configure the rate control for the OOS execution.

Tags

The tags.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ResourceType: the resource type that is used to group resources. Default value: ALIYUN::ECS::INSTANCE.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "Tags": {
          "Type": "String",
          "AssociationProperty": "Tags",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ResourceType": "ALIYUN::ECS::INSTANCE"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      Tags:
        Type: String
        AssociationProperty: Tags
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ResourceType: ALIYUN::ECS::INSTANCE
  • Example description

    In the example for Tags, AssociationProperty is set to Tags, and RegionId and ResourceType are specified in AssociationPropertyMetadata. This way, you can query the custom tags of the ECS instance.

Targets

The ECS instances that match a condition. You can select ECS instances by conditions such as instance ID, tag, or resource group.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "Targets": {
          "Type": "String",
          "AssociationProperty": "Targets",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      Targets:
        Type: String
        AssociationProperty: Targets
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for Targets, AssociationProperty is set to Targets, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ECS instances that match the condition.

TextArea

The rich text.

None.

TimeTriggerWeekly

The time picker that allows you to specify the interval by the day of a week.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "TimeTriggerWeekly": {
          "Type": "String",
          "AssociationProperty": "TimeTriggerWeekly"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      TimeTriggerWeekly:
        Type: String
        AssociationProperty: TimeTriggerWeekly
  • Example description

    In the example for TimeTriggerWeekly, AssociationProperty is set to TimeTriggerWeekly. This way, you can specify the interval by the day of week.

TimeZone

The time zone.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "TimeZone": {
          "Type": "String",
          "AssociationProperty": "TimeZone"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      TimeZone:
        Type: String
        AssociationProperty: TimeZone
  • Example description

    In the example for TimeZone, AssociationProperty is set to TimeZone. This way, you can specify the time zone.

Null

The ROS console displays the settings of a parameter only after you click the relevant button.

This value takes effect only for JSON parameters.

Note

If you specify AssociationPropertyMetadata and do not specify AssociationProperty for a parameter, the ROS console displays the parameter settings only after you click the relevant button.

  • Parameters: the declarations of parameter sets. The value of Parameters is of the dictionary data type and consists of key-value pairs.

    • Key: the parameter name.

    • Value: the parameter value. For more information, see Overview.

    Example:

    • Sample code

      JSON format:

      {
        "ROSTemplateFormatVersion": "2015-09-01",
        "Parameters": {
          "RenameECS": {
            "Label": {
              "en": "Rename ECS",
               
            },
            "MaxLength": 100,
            "MinLength": 1,
            "Type": "Json",
            "AssociationPropertyMetadata": {
              "Parameters": {
                "InstanceId": {
                  "Type": "String",
                  "Label": {
                    "en": "ECS Instance Id",
                     
                  },
                  "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
                  "MinLength": 1,
                  "MaxLength": 64
                },
                "Name": {
                  "Type": "String",
                  "Label": {
                    "en": "New Name",
                     
                  },
                  "MinLength": 1
                }
              }
            }
          }
        }
      }

      YAML format:

      ROSTemplateFormatVersion: '2015-09-01'
      Parameters:
        RenameECS:
          Label:
            en: Rename ECS
             
          MaxLength: 100
          MinLength: 1
          Type: Json
          AssociationPropertyMetadata:
            Parameters:
              InstanceId:
                Type: String
                Label:
                  en: ECS Instance Id
                   
                AssociationProperty: ALIYUN::ECS::Instance::InstanceId
                MinLength: 1
                MaxLength: 64
              Name:
                Type: String
                Label:
                  en: New Name
                   
                MinLength: 1
    • Example description

      In this example, AssociationProperty is not specified, and Parameters is specified in AssociationPropertyMetadata for RenameECS. This way, after you click Select Instances to select an ECS instance ID in the ROS console, a dialog box that prompts you to configure relevant parameters appears.

  • Metadata: The value of Metadata is of the dictionary data type. For more information, see Metadata.

Note

You can use Metadata together with List[Parameter] to nest parameters. No limit is imposed on nesting levels.

Container Registry resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::ACR::Namespace::Name

The namespace of the container image.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • Status: the status of the namespace. Valid values:

    • NORMAL

    • DELETING

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ACRNamespace": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ACR::Namespace::Name",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "Status": "NORMAL"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ACRNamespace:
    Type: String
    AssociationProperty: ALIYUN::ACR::Namespace::Name
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      Status: NORMAL

ALIYUN::ACR::Repo::RepoAttribute

The image repository of the Container Registry Personal Edition instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ACRRepo": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ACR::Repo::RepoAttribute",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ACRRepo:
    Type: String
    AssociationProperty: ALIYUN::ACR::Repo::RepoAttribute
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ALIYUN::ACR::Repo::Tag

The information about the tag of the container image.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • RepoName: the name of the image repository.

  • RepoNamespace: the name of the image repository namespace.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ACRTag": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ACR::Repo::Tag",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ACRTag:
    Type: String
    AssociationProperty: ALIYUN::ACR::Repo::Tag
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

Cloud-native Gateway resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::APIG::Gateway::GatewayId

The information about a cloud-native gateway.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • Keyword: the keyword, which is not case-sensitive and is used to perform exact searches.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "GatewayId":{
          "AssociationProperty":"ALIYUN::APIG::Gateway::GatewayId"
          "Type":"String"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      GatewayId:
        AssociationProperty: ALIYUN::APIG::Gateway::GatewayId
        Type: String
    
  • Example description

    In this example, AssociationProperty is set to ALIYUN::APIG::Gateway::GatewayId.

    This way, you can query the ID of the cloud-native gateway.

ALB resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::ALB::ACL::ACLId

The access control list (ACL) of Application Load Balancer (ALB).

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "RegionId"
        },
        "AlbACLId":{
          "AssociationProperty":"ALIYUN::ALB::ACL::ACLId",
          "AssociationPropertyMetadata": {
             "RegionId": "${RegionId}"
          },
          "Type":"String"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: RegionId
      AlbACLId:
        AssociationProperty: ALIYUN::ALB::ACL::ACLId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
        Type: String
  • Example description

    In the example for AlbACLId, AssociationProperty is set to ALIYUN::ALB::ACL::ACLId. This way, you can query the ACL ID of ALB.

ALIYUN::ALB::Instance::InstanceId

The ALB instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • VpcId: the ID of the virtual private cloud (VPC).

  • AddressType: the network type.

  • ZoneId: the zone ID.

  • PayType: the billing method of the ALB instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "AlbInstanceId":{
          "AssociationProperty":"ALIYUN::ALB::Instance::InstanceId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      AlbInstanceId:
        AssociationProperty: ALIYUN::ALB::Instance::InstanceId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for AlbInstanceId, AssociationProperty is set to ALIYUN::ALB::Instance::InstanceId. This way, you can query the ID of the ALB instance.

ALIYUN::ALB::LoadBalancer::LoadBalancerId

The ID of the ALB instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • VpcId: the VPC ID.

  • AddressType: the network type.

  • ZoneId: the zone ID.

  • PayType: the billing method of the ALB instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "AlbLoadBalancerId":{
          "AssociationProperty":"ALIYUN::ALB::LoadBalancer::LoadBalancerId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      AlbLoadBalancerId:
        AssociationProperty: ALIYUN::ALB::LoadBalancer::LoadBalancerId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for AlbLoadBalancerId, AssociationProperty is set to ALIYUN::ALB::LoadBalancer::LoadBalancerId. This way, you can query the ID of the ALB instance.

BOA resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::BSS::PricingModule::ModuleCode

The pricing module information about an Alibaba Cloud service in Alibaba Cloud Transactions and Bills Management OpenAPI (BSS OpenAPI or BOA).

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ProductCode: the service code.

  • ProductType: the service type.

  • SubscriptionType: the billing method. Valid values:

    • Subscription

    • PayAsYouGo

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "PricingModule": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::BSS::PricingModule::ModuleCode",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "ProductCode": "rds",
        "ProductType": "rds",
        "SubscriptionType": "PayAsYouGo"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  PricingModule:
    Type: String
    AssociationProperty: ALIYUN::BSS::PricingModule::ModuleCode
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      ProductCode: rds
      ProductType: rds
      SubscriptionType: PayAsYouGo

Certificate Management Service resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::CAS::Certificate::CertificateId

The certificate of the Server Load Balancer (SLB) instance.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "Certificate": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::CAS::Certificate::CertificateId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      Certificate:
        Type: String
        AssociationProperty: ALIYUN::CAS::Certificate::CertificateId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for Certificate, AssociationProperty is set to ALIYUN::CAS::Certificate::CertificateId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the certificate of the SLB instance in the specified region.

CEN resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::CEN::Instance::CenId

The information about the Cloud Enterprise Network (CEN) instance within the current Alibaba Cloud account.

  • ResourceGroupId: the ID of the resource group to which the CEN instance belongs.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ResourceGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId"
    },
    "CenId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CEN::Instance::CenId",
      "AssociationPropertyMetadata": {
        "ResourceGroupId": "${ResourceGroupId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ResourceGroupId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
  CenId:
    Type: String
    AssociationProperty: ALIYUN::CEN::Instance::CenId
    AssociationPropertyMetadata:
      ResourceGroupId: ${ResourceGroupId}

ALIYUN::CEN::TransitRouter::TransitRouterId

The information about the transit router that is connected to the CEN instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • CenId: the ID of the CEN instance.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ResourceGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId"
    },
    "CenId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CEN::Instance::CenId",
      "AssociationPropertyMetadata": {
        "ResourceGroupId": "${ResourceGroupId}"
      }
    },
    "TransitRouterId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CEN::TransitRouter::TransitRouterId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "CenId": "${CenId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ResourceGroupId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
  CenId:
    Type: String
    AssociationProperty: ALIYUN::CEN::Instance::CenId
    AssociationPropertyMetadata:
      ResourceGroupId: ${ResourceGroupId}
  TransitRouterId:
    Type: String
    AssociationProperty: ALIYUN::CEN::TransitRouter::TransitRouterId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      CenId: ${CenId}

CloudMonitor resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::CMS::Alarm::MetricSelector

The details of available metrics in CloudMonitor.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CMSMetricSelector": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CMS::Alarm::MetricSelector"
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CMSMetricSelector:
    Type: String
    AssociationProperty: ALIYUN::CMS::Alarm::MetricSelector

ALIYUN::CMS::Alarm::Rule

The threshold-triggered alert rule.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "Rule": {
          "AssociationProperty": "ALIYUN::CMS::Alarm::Rule",
          "Type": "String",
          "Description": {
             
            "en": "AlarmRule"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      Rule:
        AssociationProperty: ALIYUN::CMS::Alarm::Rule
        Type: String
        Description:
           
          en: AlarmRule
  • Example description

    In the example for Rule, AssociationProperty is set to ALIYUN::CMS::Alarm::Rule. This way, you can query the threshold-triggered alert rule.

ALIYUN::CMS::Alarm::SilenceTime

The mute period of the alert.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "SilenceTime": {
          "AssociationProperty": "ALIYUN::CMS::Alarm::SilenceTime",
          "Type": "String",
          "Description": {
             
            "en": "SilenceTime"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      SilenceTime:
        AssociationProperty: ALIYUN::CMS::Alarm::SilenceTime
        Type: String
        Description:
           
          en: SilenceTime
  • Example description

    In the example for SilenceTime, AssociationProperty is set to ALIYUN::CMS::Alarm::SilenceTime. This way, you can query the mute period of the alert.

ALIYUN::CMS::Alarm::TriggerResources

The resources that trigger alerts.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "TriggerResources": {
          "AssociationProperty": "ALIYUN::CMS::Alarm::TriggerResources",
          "Type": "String",
          "Description": {
             
            "en": "TriggerResources"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      TriggerResources:
        AssociationProperty: ALIYUN::CMS::Alarm::TriggerResources
        Type: String
        Description:
           
          en: TriggerResources
  • Example description

    In the example for TriggerResources, AssociationProperty is set to ALIYUN::CMS::Alarm::TriggerResources. This way, you can query the resources that trigger alerts.

ALIYUN::CMS::Event::EventFilterRule

The event-triggered alert rule.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "EventRule": {
          "AssociationProperty": "ALIYUN::CMS::Event::EventFilterRule",
          "Type": "String",
          "Description": {
             
            "en": "EventRule"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      EventRule:
        AssociationProperty: ALIYUN::CMS::Event::EventFilterRule
        Type: String
        Description:
           
          en: EventRule
  • Example description

    In the example for EventRule, AssociationProperty is set to ALIYUN::CMS::Event::EventFilterRule. This way, you can query the event-triggered alert rule.

ALIYUN::CMS::Event::EventLevel

The level of the event that triggers alerts.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "EventLevel": {
          "AssociationProperty": "ALIYUN::CMS::Event::EventLevel",
          "Type": "String",
          "Description": {
             
            "en": "EventLevel"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      EventLevel:
        AssociationProperty: ALIYUN::CMS::Event::EventLevel
        Type: String
        Description:
           
          en: EventLevel
  • Example description

    In the example for EventLevel, AssociationProperty is set to ALIYUN::CMS::Event::EventLevel. This way, you can query the level of the event that triggers alerts.

ALIYUN::CMS::Event::EventName

The name of the event that triggers alerts.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "EventName": {
          "AssociationProperty": "ALIYUN::CMS::Event::EventName",
          "Type": "String",
          "Description": {
             
            "en": "EventName"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      EventName:
        AssociationProperty: ALIYUN::CMS::Event::EventName
        Type: String
        Description:
           
          en: EventName
  • Example description

    In the example for EventName, AssociationProperty is set to ALIYUN::CMS::Event::EventName. This way, you can query the name of the event that triggers alerts.

ALIYUN::CMS::Product::ProductType

The cloud service to which the event-triggered alert rule is applied.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ProductType": {
          "AssociationProperty": "ALIYUN::CMS::Product::ProductType",
          "Type": "String",
          "Description": {
             
            "en": "ProductType"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ProductType:
        AssociationProperty: ALIYUN::CMS::Product::ProductType
        Type: String
        Description:
           
          en: ProductType
  • Example description

    In the example for ProductType, AssociationProperty is set to ALIYUN::CMS::Product::ProductType. This way, you can query the cloud service to which the event-triggered alert rule is applied.

Container Registry resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::CR::Instance::InstanceId

The information about the Container Registry Enterprise Edition instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • InstanceStatus: the status of the instance. Valid values:

    • PENDING: The instance is being initialized.

    • INIT_ERROR: The instance failed to be initialized.

    • STARTING: The instance is being started.

    • RUNNING: The instance is running.

    • STOPPING: The instance is being stopped.

    • STOPPED: The instance is stopped.

    • DELETING: The instance is being deleted.

    • DELETED: The instance is deleted.

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "CRInstanceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::CR::Instance::InstanceId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "InstanceStatus": "RUNNING"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      CRInstanceId:
        Type: String
        AssociationProperty: ALIYUN::CR::Instance::InstanceId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          InstanceStatus: RUNNING

ALIYUN::CR::NameSpace::Name

The information about the namespace of the Container Registry Enterprise Edition instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • NamespaceStatus: the status of the namespace. Valid values:

    • NORMAL

    • DELETING

  • InstanceId: the instance ID.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "CRNameSpace": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CR::NameSpace::Name",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "NamespaceStatus": "NORMAL"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  CRNameSpace:
    Type: String
    AssociationProperty: ALIYUN::CR::NameSpace::Name
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      NamespaceStatus: NORMAL

ALIYUN::CR::Repository::RepoName

The information about the repository of the Container Registry Enterprise Edition instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • RepoStatus: the status of the repository. Valid values:

    • NORMAL

    • DELETING

    • DELETED

    • ALL

  • InstanceId: the instance ID.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "CRRepository": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CR::Repository::RepoName",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "RepoStatus": "NORMAL"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  CRRepository:
    Type: String
    AssociationProperty: ALIYUN::CR::Repository::RepoName
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      RepoStatus: NORMAL

ALIYUN::CR::Repository::Tag

The information about the image tag of the Container Registry Enterprise Edition instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • RepoId: the repository ID.

  • InstanceId: the instance ID.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "CRRepositoryTag": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CR::Repository::Tag",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  CRRepositoryTag:
    Type: String
    AssociationProperty: ALIYUN::CR::Repository::Tag
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ACK resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::CS::Cluster::ClusterId

The ID of the Container Service for Kubernetes (ACK) cluster.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ClusterState: the status of the cluster. Valid values:

    • running: The cluster is running.

    • initial: The cluster is being initialized.

    • unavailable: The cluster is unavailable.

    • all: The cluster is in a specific state.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ClusterId":{
          "AssociationProperty":"ALIYUN::CS::Cluster::ClusterId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ClusterId:
        AssociationProperty: ALIYUN::CS::Cluster::ClusterId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for ClusterId, AssociationProperty is set to ALIYUN::CS::Cluster::ClusterId. This way, you can query the ID of the ACK cluster.

ALIYUN::CS::Cluster::ClusterNodePool

The node pool in the ACK cluster.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ClusterId: the ID of the ACK cluster.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ClusterId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::CS::Cluster::ClusterId"
        },
        "ClusterNodePool":{
          "AssociationProperty":"ALIYUN::CS::Cluster::ClusterId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "ClusterId": "${ClusterId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ClusterId:
        Type: String
        AssociationProperty: ALIYUN::CS::Cluster::ClusterId
      ClusterNodePool:
        AssociationProperty: ALIYUN::CS::Cluster::ClusterId
        Type: String
        AssociationPropertyMetadata:
          ClusterId: ${ClusterId}
  • Example description

    In the example for ClusterNodePool, AssociationProperty is set to ALIYUN::CS::Cluster::ClusterNodePool. This way, you can query the node pool in the ACK cluster.

ALIYUN::CS::Cluster::KubernetesVersion

The information about the Kubernetes version.

  • ClusterType: the cluster type.

    • Kubernetes: ACK dedicated cluster

    • ManagedKubernetes: ACK managed cluster, including ACK Pro cluster, ACK Basic cluster, ACK Serverless Pro cluster, ACK Serverless Basic cluster, ACK Edge Pro cluster, or ACK Edge Basic cluster

    • ExternalKubernetes: registered cluster

  • Profile: The scenario in which the cluster is used.

    • Default: non-edge computing scenario

    • Edge: edge computing scenario

    • Serverless: scenario that requires ACK Serverless clusters

  • Runtime: the runtime type.

    • docker

    • containerd

    • Sandboxed-Container.runv

  • KubernetesVersionPrefix: the prefix of the Kubernetes version.

  • AutoSelectLastest: automatically selects the latest version.

Example

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CSManagedKubernetesClusterServiceCidr": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CS::Cluster::KubernetesVersion",
      "AssociationPropertyMetadata": {
        "AutoSelectLastest": true
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CSManagedKubernetesClusterServiceCidr:
    Type: String
    AssociationProperty: ALIYUN::CS::Cluster::KubernetesVersion
    AssociationPropertyMetadata:
      AutoSelectLastest: true

ALIYUN::CS::ManagedKubernetesCluster::ServiceCidr

The information about the Service CIDR block of the ACK managed cluster.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ClusterType: the cluster type.

  • VpcId: the VPC ID.

  • NodeCidrMask: the maximum number of IP addresses of the node.

  • ContainerCidr: the CIDR block of the container.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "CSManagedKubernetesClusterServiceCidr": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CS::ManagedKubernetesCluster::ServiceCidr",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "VpcId": "${VpcId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  CSManagedKubernetesClusterServiceCidr:
    Type: String
    AssociationProperty: ALIYUN::CS::ManagedKubernetesCluster::ServiceCidr
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      VpcId: ${VpcId}

Compute Nest resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::ComputeNest::Artifact::ArtifactId

The information about the Compute Nest deployment package.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ArtifactType: the type of the deployment package.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ComputeNestArtifactArtifactId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ComputeNest::Artifact::ArtifactId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ComputeNestArtifactArtifactId:
    Type: String
    AssociationProperty: ALIYUN::ComputeNest::Artifact::ArtifactId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ALIYUN::ComputeNest::Artifact::ArtifactIdVersion

The information about the version of the Compute Nest deployment package.

  • ArtifactId: the ID of the deployment package.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ComputeNestArtifactArtifactId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ComputeNest::Artifact::ArtifactId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "ComputeNestArtifactArtifactIdVersion": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ComputeNest::Artifact::ArtifactIdVersion",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "ArtifactId": "${ComputeNestArtifactArtifactId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ComputeNestArtifactArtifactId:
    Type: String
    AssociationProperty: ALIYUN::ComputeNest::Artifact::ArtifactId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  ComputeNestArtifactArtifactIdVersion:
    Type: String
    AssociationProperty: ALIYUN::ComputeNest::Artifact::ArtifactIdVersion
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      ArtifactId: ${ComputeNestArtifactArtifactId}

ALIYUN::ComputeNest::Service::ServiceId

The ID of the service in Compute Nest.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • InUsed: specifies whether the service is used.

  • IsVendor: specifies whether the service belongs to a service provider.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ServiceId":{
          "AssociationProperty":"ALIYUN::ComputeNest::Service::ServiceId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ServiceId:
        AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for ServiceId, AssociationProperty is set to ALIYUN::ComputeNest::Service::ServiceId. This way, you can query the ID of the service in Compute Nest.

ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId

The ID of the service instance in Compute Nest.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ServiceType: the service type.

  • DeployType: the deployment type.

  • Status: the status of the service.

  • ServiceId: the service ID.

  • Version: the version of the service.

  • IsVendor: specifies whether the service belongs to a service provider.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ServiceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ComputeNest::Service::ServiceId"
        },
        "ServiceInstanceId":{
          "AssociationProperty":"ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "ServiceId": "${ServiceId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ServiceId:
        Type: String
        AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId
      ServiceInstanceId:
        AssociationProperty: ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId
        Type: String
        AssociationPropertyMetadata:
          ServiceId: ${ServiceId}
  • Example description

    In the example for ServiceInstanceId, AssociationProperty is set to ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId. This way, you can query the ID of the service instance in Compute Nest.

ALIYUN::ComputeNestSupplier::Service::ServiceVersion

The version of the service in Compute Nest.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ServiceId: the service ID.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ServiceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ComputeNest::Service::ServiceId"
        },
        "ServiceVersion":{
          "AssociationProperty":"ALIYUN::ComputeNestSupplier::Service::ServiceVersion",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "ServiceId": "${ServiceId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ServiceId:
        Type: String
        AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId
      ServiceVersion:
        AssociationProperty: ALIYUN::ComputeNestSupplier::Service::ServiceVersion
        Type: String
        AssociationPropertyMetadata:
          ServiceId: ${ServiceId}
  • Example description

    In the example for ServiceVersion, AssociationProperty is set to ALIYUN::ComputeNestSupplier::Service::ServiceVersion. This way, you can query the version of the service in Compute Nest.

Compute Nest service provider resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::ComputeNestSupplier::Service::ServiceVersion

The version of the service in Compute Nest.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ServiceId: the service ID.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ServiceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ComputeNest::Service::ServiceId"
        },
        "ServiceVersion":{
          "AssociationProperty":"ALIYUN::ComputeNestSupplier::Service::ServiceVersion",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "ServiceId": "${ServiceId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ServiceId:
        Type: String
        AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId
      ServiceVersion:
        AssociationProperty: ALIYUN::ComputeNestSupplier::Service::ServiceVersion
        Type: String
        AssociationPropertyMetadata:
          ServiceId: ${ServiceId}
  • Example description

    In the example for ServiceVersion, AssociationProperty is set to ALIYUN::ComputeNestSupplier::Service::ServiceVersion. This way, you can query the version of the service in Compute Nest.

DNS resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::DNS::Domain::ValidateDomain

The availability of the domain name of Alibaba Cloud DNS (DNS).

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • DomainType: the type of the domain name.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "DNSValidateDomain": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::DNS::Domain::ValidateDomain",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  DNSValidateDomain:
    Type: String
    AssociationProperty: ALIYUN::DNS::Domain::ValidateDomain
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

DashVector resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::DashVector::ApiKey

The API key of DashVector.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DashVectorApiKey": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::DashVector::ApiKey"
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DashVectorApiKey:
    Type: String
    AssociationProperty: ALIYUN::DashVector::ApiKey

Domain name resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::Domain::DomainName

The information about the domain name.

  • ShowDomainPrefixInput: specifies whether the prefix of the domain name can be specified.

  • MaxLength: the maximum length of the domain name.

  • CheckICP: checks the status of Internet Content Provider (ICP) filing.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DomainName": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Domain::DomainName "
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DomainName:
    Type: String
    AssociationProperty: 'ALIYUN::Domain::DomainName'

EAS resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::EAS::Instance::InstanceType

The specifications of the Elastic Algorithm Service (EAS) instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • SubscriptionType: the billing method. Valid values:

    • Subscription

    • PayAsYouGo

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "EASInstanceType": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::EAS::Instance::InstanceType",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "SubscriptionType": "PayAsYouGo"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  EASInstanceType:
    Type: String
    AssociationProperty: ALIYUN::EAS::Instance::InstanceType
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      SubscriptionType: PayAsYouGo

ALIYUN::EAS::Resource::ResourceId

The information about the resource group of EAS.

  • RegionId: the region ID. By default, the region ID of the stack is used.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "EASResourceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::EAS::Resource::ResourceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  EASResourceId:
    Type: String
    AssociationProperty: ALIYUN::EAS::Resource::ResourceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

EDS resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::ECD::Bundle::DesktopType

The information about the cloud computer type of Elastic Desktop Service (EDS).

  • RegionId: the region ID. By default, the region ID of the stack is used.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "DesktopType": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECD::Bundle::DesktopType",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  DesktopType:
    Type: String
    AssociationProperty: ALIYUN::ECD::Bundle::DesktopType
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

Elastic Container Instance resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::ECI::ContainerGroup::ContainerGroupId

The information about the container group of the elastic container instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • VSwitchId: the vSwitch ID of the instance.

  • ZoneId: the zone of the instance.

  • SecurityGroupId: the ID of the security group to which the instance belongs.

  • ComputeCategory: the computing power type.

  • Status: the status of the instance. Valid values:

    • Pending: The instance is being started.

    • Running: The instance is running.

    • Succeeded: The instance successfully runs.

    • Failed: The instance failed to run.

    • Scheduling: The instance is being created.

    • ScheduleFailed: The instance failed to be created.

    • Restarting: The instance is being restarted.

    • Updating: The instance is being updated.

    • Terminating: The instance is being terminated.

    • Expired: The instance expired.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ECIContainerGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECI::ContainerGroup::ContainerGroupId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "Status": "Running"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ECIContainerGroupId:
    Type: String
    AssociationProperty: ALIYUN::ECI::ContainerGroup::ContainerGroupId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      Status: Running

ECS resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::ECS::ZoneId

The zone ID of ECS.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • SystemDiskCategory: the category of the system disk.

  • InstanceType: the instance specifications.

  • InstanceChargeType: the billing method of the instance.

  • WithAvailableResource: specifies whether to filter a zone in which available instance types are supported.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::ZoneId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ALIYUN::ECS::ZoneId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}

ALIYUN::ECS::Command::CommandId

The ID of the Cloud Assistant command or Alibaba Cloud command.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ImageId: the image ID.

    You can use OSType of an image to limit the command type that you want to display in the ROS console.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "CommandId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Command::CommandId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      CommandId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Command::CommandId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for CommandId, AssociationProperty is set to ALIYUN::ECS::Command::CommandId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ECS Cloud Assistant command or Alibaba Cloud public command in the specified region.

ALIYUN::ECS::DeploymentSet::DeploymentSetId

The ID of the deployment set of ECS.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • Strategy: the deployment strategy. Valid values:

    • Availability: high availability strategy

    • AvailabilityGroup: high availability group strategy

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ECSDeploymentSetId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::DeploymentSet::DeploymentSetId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "Strategy": "Availability"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ECSDeploymentSetId:
    Type: String
    AssociationProperty: ALIYUN::ECS::DeploymentSet::DeploymentSetId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      Strategy: Availability

ALIYUN::ECS::Disk::DataDiskCategory

The category of the data disk.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

  • InstanceType: the instance specifications.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "InstanceType": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::InstanceType",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        },
        "DataDiskCategory": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Disk::DataDiskCategory",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}",
            "InstanceType": "${InstanceType}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      InstanceType:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::InstanceType
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
      DataDiskCategory:
        Type: String
        AssociationProperty: ALIYUN::ECS::Disk::DataDiskCategory
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
          InstanceType: ${InstanceType}
  • Example description

    In the example for DataDiskCategory, AssociationProperty is set to ALIYUN::ECS::Disk::DataDiskCategory, and RegionId, ZoneId, and InstanceType are specified in AssociationPropertyMetadata. This way, you can query the data disk category of the ECS instance.

ALIYUN::ECS::Disk::DiskId

The disk ID.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

  • InstanceId: the instance ID.

  • DiskType: the disk type.

  • Category: the category of the instance.

  • SnapshotId: the snapshot ID.

  • DiskChargeType: the billing method of the disk.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "DiskId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Disk::DiskId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      DiskId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Disk::DiskId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for DiskId, AssociationProperty is set to ALIYUN::ECS::Disk::DiskId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ID of the ECS disk in the specified region.

ALIYUN::ECS::Disk::SystemDiskCategory

The category of the system disk.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

  • InstanceType: the instance specifications.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "InstanceType": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::InstanceType",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        },
        "SystemDiskCategory": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Disk::SystemDiskCategory",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}",
            "InstanceType": "${InstanceType}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      InstanceType:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::InstanceType
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
      SystemDiskCategory:
        Type: String
        AssociationProperty: ALIYUN::ECS::Disk::SystemDiskCategory
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
          InstanceType: ${InstanceType}
  • Example description

    In the example for SystemDiskCategory, AssociationProperty is set to ALIYUN::ECS::Disk::SystemDiskCategory, and RegionId, ZoneId, and InstanceType are specified in AssociationPropertyMetadata. This way, you can query the system disk category of the ECS instance.

ALIYUN::ECS::Image::ImageId

The image ID.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • SupportedImageOwnerAlias: the supported image types.

  • InstanceType: the instance specifications.

  • ImageFamily: the name of the image family.

  • IsSupportIoOptimized: specifies whether the image can run on I/O optimized instances.

  • OSType: the OS type.

  • Architecture: the architecture of the image.

  • Usage: specifies whether the image is running on ECS instances.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ImageId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Image::ImageId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "SupportedImageOwnerAlias": ["system", "self", "others"]
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ImageId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Image::ImageId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          SupportedImageOwnerAlias:
            - system
            - self
            - others
  • Example description

    In the example for ImageId, AssociationProperty is set to ALIYUN::ECS::Image::ImageId, and RegionId and SupportedImageOwnerAlias are specified in AssociationPropertyMetadata. This way, you can query the ID of the ECS image in the specified region.

ALIYUN::ECS::Instance::AttributeSelector

The property selector of the ECS instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "AttributeSelector": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::AttributeSelector"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      AttributeSelector:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::AttributeSelector
  • Example description

    In the example for AttributeSelector, AssociationProperty is set to ALIYUN::ECS::Instance::AttributeSelector. This way, you can query the property selector of the ECS instance.

ALIYUN::ECS::Instance::InstanceId

The ID of the ECS instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • InstanceType: the instance specifications.

  • InstanceTypeFamily: the instance family of the instance.

  • Platform: the OS.

  • OSType: the OS type.

  • Status: the status of the instance.

  • NetworkType: the network type of the instance.

  • DisabledNetworkType: disables the network type of the instance.

  • ShowNetworkType: shows the network type of the instance.

  • InternetChargeType: the metering method of public bandwidth.

  • DisabledInternetChargeType: disables the metering method for public bandwidth.

  • ShowInternetChargeType: shows the metering method for public bandwidth.

  • ChargeType: the billing method of the instance.

  • DisabledChargeType: disables the billing method of the instance.

  • ShowChargeType: shows the billing method of the instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "InstanceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      InstanceId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::InstanceId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for InstanceId, AssociationProperty is set to ALIYUN::ECS::Instance::InstanceId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the existing ECS instances in the specified region.

ALIYUN::ECS::Instance::InstancePropertyEditor

The property editor of the ECS instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "InstancePropertyEditor": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::InstancePropertyEditor"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      InstancePropertyEditor:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::InstancePropertyEditor
  • Example description

    In the example for InstancePropertyEditor, AssociationProperty is set to ALIYUN::ECS::Instance::InstancePropertyEditor. This way, you can query the property editor of the ECS instance.

ALIYUN::ECS::Instance::InstanceType

The ECS instance specifications.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

  • InstanceChargeType: the billing method of the instance.

  • SpotStrategy: the bidding policy for the pay-as-you-go instance.

  • CreateACKClusterParams: the filter conditions, which are used to match the ECS instance specifications supported by ACK.

    • NetworkPlugin: the network component. Example: terway-eniip.

  • Constraints: the filter conditions, which are used to match instance specifications. You can specify multiple filter conditions.

    • InstanceType: the instance type. Example: ecs.c6.xlarge.

    • InstanceTypeFamily: the instance family to which the instance type belongs. Example: ecs.c6.

    • vCPU: the number of vCPUs that are supported by the instance type.

    • Memory: the memory size that is supported by the instance type.

    • Architecture: the vCPU architecture.

      • X86: x86-based computing

      • ARM: Arm-based computing

      • Heterogeneous: heterogeneous computing, such as GPU-accelerated, FPGA-accelerated, or NPU-accelerated

      • elastic_bareMetal: ECS Bare Metal Instance

    • CustomizeFamily: the custom instance family.

      • high-clockSpeed

      • general-purpose

      • compute-optimized

      • memory-optimized

      • big-data

      • local-ssd

      • arm-general-purpose

      • arm-compute-optimized

      • arm-memory-optimized

      • gpu-a100

      • gpu-a10

      • gpu-v100

      • gpu-t4

      • gpu-p100

      • gpu-p4

      • gpu-grid

      • gpu-arm

      • gpu-fpga-asic

      • gpu-other

      • basic

      • elastic-bareMetal-compute

      • elastic-bareMetal-GPU-compute

      • super-computeCluster-compute

      • super-computeCluster-GPU-compute

      • enhancement

      • current-recommendation

      • elastic-bareMetal-compute-china-CPU

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "InstanceType": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::InstanceType",
          "AssociationPropertyMetadata": {
            "Constraints": {
              "Architecture": [
                "X86"
              ],
              "vCPU": [
                4
              ],
              "Memory": [
                8
              ]
            }
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      InstanceType:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::InstanceType
        AssociationPropertyMetadata:
          Constraints:
            Architecture:
              - X86
            vCPU:
              - 4
            Memory:
              - 8
  • Example description

    In the example for InstanceType, AssociationProperty is set to ALIYUN::ECS::Instance::InstanceType, and Architecture, vCPU, and Memory are specified for Constraints in AssociationPropertyMetadata. This way, you can query the ECS instance specifications that are separately configured with the x86-based computing architecture, 4 vCPUs, and 8 GB memory in the specified region.

ALIYUN::ECS::Instance::MaxBandwidthIn

The maximum inbound public bandwidth of the ECS instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "MaxBandwidthIn": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::MaxBandwidthIn"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      MaxBandwidthIn:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::MaxBandwidthIn
  • Example description

    In the example for MaxBandwidthIn, AssociationProperty is set to ALIYUN::ECS::Instance::MaxBandwidthIn. This way, you can query the maximum inbound public bandwidth of the ECS instance.

ALIYUN::ECS::Instance::OSType

The OS type of the ECS instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • InstanceId: the ID of the ECS instance.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ECSInstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "ECSOSType": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::OSType",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "InstanceId": "${ECSInstanceId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ECSInstanceId:
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance::InstanceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  ECSOSType:
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance::OSType
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      InstanceId: ${ECSInstanceId}

ALIYUN::ECS::Instance::Password

The component of the password of the ECS instance.

Note

The password must be 8 to 30 characters in length. It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "password": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::Password"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      password:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::Password
  • Example description

    In the example for password, AssociationProperty is set to ALIYUN::ECS::Instance::Password. This way, you can impose limits on the password of the ECS instance by using the component.

    Limits: The password must be 8 to 30 characters in length. It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.

ALIYUN::ECS::Instance::RenewPeriod

The renewal period of the ECS instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RenewPeriod": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::RenewPeriod"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RenewPeriod:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::RenewPeriod
  • Example description

    In the example for RenewPeriod, AssociationProperty is set to ALIYUN::ECS::Instance::RenewPeriod. This way, you can query the renewal period of the ECS instance.

ALIYUN::ECS::Instance::StopMode

The mode in which the ECS instance is stopped.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "StopMode": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::StopMode"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      StopMode:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::StopMode
  • Example description

    In the example for StopMode, AssociationProperty is set to ALIYUN::ECS::Instance::StopMode. This way, you can query the mode in which the ECS instance is stopped.

ALIYUN::ECS::InstanceType::AvailableInstanceType

The available ECS instance types.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "AvailableInstanceType": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::InstanceType::AvailableInstanceType"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      AvailableInstanceType:
        Type: String
        AssociationProperty: ALIYUN::ECS::InstanceType::AvailableInstanceType
  • Example description

    In the example for AvailableInstanceType, AssociationProperty is set to ALIYUN::ECS::InstanceType::AvailableInstanceType. This way, you can query the available ECS instance types.

ALIYUN::ECS::KeyPair::KeyPairName

The key pair.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "KeyPairName": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::KeyPair::KeyPairName",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      KeyPairName:
        Type: String
        AssociationProperty: ALIYUN::ECS::KeyPair::KeyPairName
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for KeyPairName, AssociationProperty is set to ALIYUN::ECS::KeyPair::KeyPairName, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ECS key pair in the specified region.

ALIYUN::ECS::LaunchTemplate::LaunchTemplateId

The ID of the launch template.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "LaunchTemplateId":{
          "AssociationProperty":"ALIYUN::ECS::LaunchTemplate::LaunchTemplateId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      LaunchTemplateId:
        AssociationProperty: ALIYUN::ECS::LaunchTemplate::LaunchTemplateId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for LaunchTemplateId, AssociationProperty is set to ALIYUN::ECS::LaunchTemplate::LaunchTemplateId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ECS launch template in the specified region.

ALIYUN::ECS::LaunchTemplate::LaunchTemplateVersion

The version of the launch template.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • LaunchTemplateId: the ID of the launch template.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "LaunchTemplateId": {
          "AssociationProperty": "ALIYUN::ECS::LaunchTemplate::LaunchTemplateId",
          "Type": "String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "LaunchTemplateVersion": {
          "AssociationProperty": "ALIYUN::ECS::LaunchTemplate::LaunchTemplateVersion",
          "Type": "String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "LaunchTemplateId": "${LaunchTemplateId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      LaunchTemplateId:
        AssociationProperty: ALIYUN::ECS::LaunchTemplate::LaunchTemplateId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      LaunchTemplateVersion:
        AssociationProperty: ALIYUN::ECS::LaunchTemplate::LaunchTemplateVersion
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          LaunchTemplateId: ${LaunchTemplateId}
  • Example description

    In the example for LaunchTemplateVersion, AssociationProperty is set to ALIYUN::ECS::LaunchTemplate::LaunchTemplateVersion, and RegionId and LaunchTemplateId are specified in AssociationPropertyMetadata. This way, you can query the version of the specified ECS launch template.

ALIYUN::ECS::ManagedInstance::InstanceId

The ID of the managed ECS instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • OsType: the OS type of the managed instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "InstanceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::ManagedInstance::InstanceId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      InstanceId:
        Type: String
        AssociationProperty: ALIYUN::ECS::ManagedInstance::InstanceId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for InstanceId, AssociationProperty is set to ALIYUN::ECS::ManagedInstance::InstanceId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ID of the managed ECS instance in the specified region.

ALIYUN::ECS::RAM::Role

The RAM role that is assigned to the ECS instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "Role": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RAM::Role"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      Role:
        Type: String
        AssociationProperty: ALIYUN::ECS::RAM::Role
  • Example description

    In the example for Role, AssociationProperty is set to ALIYUN::ECS::RAM::Role. This way, you can query the RAM role that is assigned to the ECS instance.

ALIYUN::ECS::RegionId

The region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
  • Example description

    In the example for RegionId, AssociationProperty is set to ALIYUN::ECS::RegionId. This way, you can query available regions.

ALIYUN::ECS::RegionId::RegionDeploy

The ECS deployment region.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ECSRegionDeploy": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId::RegionDeploy"
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ECSRegionDeploy:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId::RegionDeploy

ALIYUN::ECS::RegionId::TargetRegionIds

The IDs of the destination regions of the ECS instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "TargetRegionIds": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId::TargetRegionIds"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      TargetRegionIds:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId::TargetRegionIds
  • Example description

    In the example for TargetRegionIds, AssociationProperty is set to ALIYUN::ECS::RegionId::TargetRegionIds. This way, you can query the destination region IDs of the ECS instance.

ALIYUN::ECS::ResourceGroup::ResourceGroupId

The resource group.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ResourceGroupId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ResourceGroupId:
        Type: String
        AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
  • Example description

    In the example for ResourceGroupId, AssociationProperty is set to ALIYUN::ECS::ResourceGroup::ResourceGroupId.

ALIYUN::ECS::SecurityGroup::PortRange

The port range of the ECS security group based on the IP protocol.

  • IpProtocol: the IP protocol. Valid values:

    • ALL: multiple protocols

    • TCP: Transmission Control Protocol (TCP)

    • UDP: User Datagram Protocol (UDP)

    • ICMP: Internet Control Message Protocol (ICMP)

    • GRE: Generic Routing Encapsulation (GRE)

    • ICMPv6: Internet Control Message Protocol for IPv6 (ICMPv6)

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ECSSecurityGroupPortRange": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::SecurityGroup::PortRange",
      "AssociationPropertyMetadata": {
        "IpProtocol": "ALL"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ECSSecurityGroupPortRange:
    Type: String
    AssociationProperty: ALIYUN::ECS::SecurityGroup::PortRange
    AssociationPropertyMetadata:
      IpProtocol: ALL

ALIYUN::ECS::SecurityGroup::SecurityGroupId

The ID of the security group.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • VpcId: the VPC ID.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "VpcId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "SecurityGroupId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::SecurityGroup::SecurityGroupId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "VpcId": "${VpcId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      VpcId:
        Type: String
        AssociationProperty: ALIYUN::ECS::VPC::VPCId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      SecurityGroupId:
        Type: String
        AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          VpcId: ${VpcId}
    
  • Example description

    In the example for SecurityGroupId, AssociationProperty is set to ALIYUN::ECS::SecurityGroup::SecurityGroupId, and RegionId and VpcId are specified in AssociationPropertyMetadata. This way, you can query the ID of the security group in the specified VPC in the specified region.

ALIYUN::ECS::Snapshot::AutoSnapshotPolicyId

The ID of the automatic snapshot policy.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "AutoSnapshotPolicyId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Snapshot::AutoSnapshotPolicyId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      AutoSnapshotPolicyId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Snapshot::AutoSnapshotPolicyId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for AutoSnapshotPolicyId, AssociationProperty is set to ALIYUN::ECS::Snapshot::AutoSnapshotPolicyId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the automatic snapshot policy of ECS in the specified region.

ALIYUN::ECS::Snapshot::SnapshotId

The ID of the disk snapshot of the ECS instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • InstanceId: the ID of the ECS instance.

  • DiskId: the disk ID.

  • Status: the status of the snapshot.

  • SnapshotType: the snapshot type.

  • Category: the category of the snapshot.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "DiskId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Disk::DiskId"
        },
        "SnapshotId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Snapshot::SnapshotId",
          "AssociationPropertyMetadata": {
            "DiskId": "${DiskId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      DiskId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Disk::DiskId
      SnapshotId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Snapshot::SnapshotId
        AssociationPropertyMetadata:
          DiskId: ${DiskId}
  • Example description

    In the example for SnapshotId, AssociationProperty is set to ALIYUN::ECS::Snapshot::SnapshotId. This way, you can query the ID of the disk snapshot of the ECS instance.

ALIYUN::ECS::TAG

The information about the tag of the ECS instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ResourceType: the resource type.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "Tag": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::TAG",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      Tag:
        Type: String
        AssociationProperty: ALIYUN::ECS::TAG
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for Tag, AssociationProperty is set to ALIYUN::ECS::TAG. This way, you can query the information about the tag of the ECS instance.

ALIYUN::ECS::VPC::VPCId

The VPC ID.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "VpcId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      VpcId:
        Type: String
        AssociationProperty: ALIYUN::ECS::VPC::VPCId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for VpcId, AssociationProperty is set to ALIYUN::ECS::VPC::VPCId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ID of the VPC in the specified region.

ALIYUN::ECS::VSwitch

The vSwitch.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

  • VpcId: the VPC ID.

  • InstanceType: the instance specifications.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "VSwitchId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::VSwitch",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      VSwitchId:
        Type: String
        AssociationProperty: ALIYUN::ECS::VSwitch
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
  • Example description

    In the example for VSwitchId, AssociationProperty is set to ALIYUN::ECS::VSwitch, and RegionId and ZoneId are specified in AssociationPropertyMetadata. This way, you can query the vSwitch in the specified region.

E-HPC resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::EHPC::Cluster::ClusterId

The cluster.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ClusterId":{
          "AssociationProperty":"ALIYUN::EHPC::Cluster::ClusterId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          },
          "Type":"String"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ClusterId:
        AssociationProperty: ALIYUN::EHPC::Cluster::ClusterId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
        Type: String
  • Example description

    In the example for ClusterId, AssociationProperty is set to ALIYUN::EHPC::Cluster::ClusterId. This way, you can query the ID of the Elastic High Performance Computing (E-HPC) cluster.

ALIYUN::EHPC::FileSystem::FileSystemId

The ID of the file system.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "FileSystemId":{
          "AssociationProperty":"ALIYUN::EHPC::FileSystem::FileSystemId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      FileSystemId:
        AssociationProperty: ALIYUN::EHPC::FileSystem::FileSystemId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for FileSystemId, AssociationProperty is set to ALIYUN::EHPC::FileSystem::FileSystemId. This way, you can query the file system ID in E-HPC.

ALIYUN::EHPC::FileSystem::MountTargetDomain

The mount target.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • VolumeId: the ID of the File Storage NAS (NAS) file system.

  • VpcId: the VPC ID.

  • VSwitchId: the vSwitch ID.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "MountTargetDomain":{
          "AssociationProperty":"ALIYUN::EHPC::FileSystem::MountTargetDomain",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      MountTargetDomain:
        AssociationProperty: ALIYUN::EHPC::FileSystem::MountTargetDomain
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for MountTargetDomain, AssociationProperty is set to ALIYUN::EHPC::FileSystem::MountTargetDomain. This way, you can query the mount targets of the E-HPC file system.

Auto Scaling resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId

The ID of the scaling group of Auto Scaling.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "AutoScalingGroupId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      AutoScalingGroupId:
        Type: String
        AssociationProperty: ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for AutoScalingGroupId, AssociationProperty is set to ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId. This way, you can query the ID of the scaling group of Auto Scaling.

ALIYUN::ESS::ECIScalingConfiguration::ContainerName

The configurations of the scaling group of the elastic container instance type.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ScalingGroupId: the ID of the scaling group.

  • ScalingConfigurationId: the ID of the scaling configuration.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ESSECIScalingConfigurationContainerName": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::ECIScalingConfiguration::ContainerName",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ESSECIScalingConfigurationContainerName:
    Type: String
    AssociationProperty: ALIYUN::ESS::ECIScalingConfiguration::ContainerName
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ALIYUN::ESS::ECIScalingConfiguration::ScalingConfigurationId

The ID of the scaling configuration.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ScalingGroupId: the ID of the scaling group.

  • AutoSelectFirst: specifies whether to use the first scaling configuration.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "AutoScalingGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "ServiceConnectionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::ECIScalingConfiguration::ScalingConfigurationId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "ScalingGroupId": "${AutoScalingGroupId}",
        "AutoSelectFirst": true
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  AutoScalingGroupId:
    Type: String
    AssociationProperty: ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  ServiceConnectionId:
    Type: String
    AssociationProperty: ALIYUN::ESS::ECIScalingConfiguration::ScalingConfigurationId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      ScalingGroupId: ${AutoScalingGroupId}
      AutoSelectFirst: true

ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId

The ID of the scaling configuration of Auto Scaling.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ScalingConfigurationId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ScalingConfigurationId:
        Type: String
        AssociationProperty: ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for ScalingConfigurationId, AssociationProperty is set to ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId. This way, you can query the ID of the scaling configuration of Auto Scaling.

Elasticsearch resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::Elasticsearch::Instance::InstanceType

The specifications of the Elasticsearch instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "Elasticsearch": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::Elasticsearch::Instance::InstanceType"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      Elasticsearch:
        Type: String
        AssociationProperty: ALIYUN::Elasticsearch::Instance::InstanceType
  • Example description

    In the example for Elasticsearch, AssociationProperty is set to ALIYUN::Elasticsearch::Instance::InstanceType. This way, you can query the specifications of the Elasticsearch instance.

EMR resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::Emr::ECSCluster::ClusterId

The E-MapReduce (EMR) clusters.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ClusterTypes: the cluster types. Valid values:

    • DATALAKE: DataLake cluster

    • OLAP: online analytical processing (OLAP) cluster

    • DATAFLOW: Dataflow cluster

    • DATASERVING: DataServing cluster

    • CUSTOM: custom cluster

    • HADOOP: Hadoop cluster

  • ClusterStates: an array of cluster states. Valid values:

    • STARTING: The cluster is being started.

    • START_FAILED: The cluster failed to be started.

    • BOOTSTRAPPING: The bootstrap action is being performed for the cluster.

    • RUNNING: The cluster is running.

    • TERMINATING: The cluster is being terminated.

    • TERMINATED: The cluster is terminated.

    • TERMINATED_WITH_ERRORS: The cluster is terminated due to an exception.

    • TERMINATE_FAILED: The cluster failed to be terminated.

  • PaymentTypes: the billing methods. Valid values:

    • Subscription

    • PayAsYouGo

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ClusterId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Emr::ECSCluster::ClusterId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "PaymentTypes": [
          "PayAsYouGo"
        ]
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ClusterId:
    Type: String
    AssociationProperty: ALIYUN::Emr::ECSCluster::ClusterId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      PaymentTypes:
        - PayAsYouGo

Function Compute 3.0 resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::FC3::Function::FunctionName

The information about the function in Function Compute 3.0.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • Prefix: the prefix of the function name.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "FC3FunctionName": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::FC3::Function::FunctionName",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  FC3FunctionName:
    Type: String
    AssociationProperty: ALIYUN::FC3::Function::FunctionName
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

Function Compute 2.0 resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::FC::Function::FunctionName

The information about the function in Function Compute 2.0.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • Prefix: the prefix of the function name.

  • ServiceName: the name of the service to which the function belongs.

  • Qualifier: the version or alias of the service to which the function belongs.

  • StartKey: the starting position of the items to be returned. The items that include and follow the item specified by StartKey are returned in alphabetical order.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "FCFunctionName": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::FC::Function::FunctionName",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  FCFunctionName:
    Type: String
    AssociationProperty: ALIYUN::FC::Function::FunctionName
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ALIYUN::FC::Service::ServiceName

The information about the service in Function Compute 2.0.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • Prefix: the prefix of the function name.

  • StartKey: the starting position of the items to be returned. The items that include and follow the item specified by StartKey are returned in alphabetical order.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "FCServiceName": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::FC::Service::ServiceName",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  FCServiceName:
    Type: String
    AssociationProperty: ALIYUN::FC::Service::ServiceName
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

Alibaba Cloud DevOps Flow resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::Flow::Connection::ConnectionId

The service connection in Alibaba Cloud DevOps.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • organizationId: the identifier or ID of the organization workspace. The value of organizationId is of the string data type. You can obtain this value from Alibaba Cloud DevOps endpoints. Example of an endpoint:

    https://devops.aliyun.com/organization/[OrganizationId]
  • sericeConnectionType: the type of the service connection.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "OrganizationId": {
      "Type": "String"
    },
    "SericeConnectionType": {
      "Type": "String",
      "Default": "aliyun_code"
    },
    "ServiceConnectionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Flow::Connection::ConnectionId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "organizationId": "${OrganizationId}",
        "sericeConnectionType": "${SericeConnectionType}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  OrganizationId:
    Type: String
  SericeConnectionType:
    Type: String
    Default: aliyun_code
  ServiceConnectionId:
    Type: String
    AssociationProperty: ALIYUN::Flow::Connection::ConnectionId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      organizationId: ${OrganizationId}
      sericeConnectionType: ${SericeConnectionType}

ALIYUN::Flow::Organization::OrganizationId

The organization workspace within the current account.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • accessLevel: the permission level.

  • minAccessLevel: the lowest permission level. You can use this parameter to query organization workspaces whose permission levels are higher than or equal to the lowest permission level.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "OrganizationId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Flow::Organization::OrganizationId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "accessLevel": 5,
        "minAccessLevel": 5
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  OrganizationId:
    Type: String
    AssociationProperty: ALIYUN::Flow::Organization::OrganizationId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      accessLevel: 5
      minAccessLevel: 5

Hologres resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::Hologres::Instance::InstanceId

The ID of the Hologres instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • cmsInstanceType: the type of the CloudMonitor instance. Valid values:

    • standard

    • follower

    • mc-acceleration

    • warehouse

    • high-memory

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "HologresInstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Hologres::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "cmsInstanceType": "standard"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  HologresInstanceId:
    Type: String
    AssociationProperty: ALIYUN::Hologres::Instance::InstanceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      cmsInstanceType: standard

InfluxDB resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::InfluxDB::Instance::InstanceType

The specifications of the Time Series Database for InfluxDB® (InfluxDB) instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "InfluxDB": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::InfluxDB::Instance::InstanceType",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      InfluxDB:
        Type: String
        AssociationProperty: ALIYUN::InfluxDB::Instance::InstanceType
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
  • Example description

    In the example for InfluxDB, AssociationProperty is set to ALIYUN::InfluxDB::Instance::InstanceType. This way, you can query the specifications of the InfluxDB instance.

ApsaraMQ for Kafka resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::Kafka::Instance::InstanceId

The information about the ApsaraMQ for Kafka instance in the specified region.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • OrderId: the order ID.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "InstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Kafka::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  InstanceId:
    Type: String
    AssociationProperty: ALIYUN::Kafka::Instance::InstanceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

Lindorm resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::Lindorm::Instance::InstanceId

The Lindorm instances.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • SupportEngine: the type of the engine that is supported by the instances. Valid values:

    • 1: LindormSearch

    • 2: LindormTSDB

    • 4: LindormTable

    • 8: LindormDFS

  • ServiceType: the category of the instance. Valid values:

    • lindorm: single-zone Lindorm instance

    • lindorm_multizone: multi-zone Lindorm instance

    • serverless_lindorm: Lindorm Serverless instance

    • lindorm_standalone: single-node Lindorm instance

    • lts: Lindorm Tunnel Service (LTS) instance

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "LindormInstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Lindorm::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "SupportEngine": 1,
        "ServiceType": "lindorm"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  LindormInstanceId:
    Type: String
    AssociationProperty: ALIYUN::Lindorm::Instance::InstanceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      SupportEngine: 1
      ServiceType: lindorm

ApsaraDB for MongoDB resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::MongoDB::Instance::InstanceType

The specifications of the ApsaraDB for MongoDB instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "InstanceType":{
          "AssociationProperty":"ALIYUN::MongoDB::Instance::InstanceType",
          "Type":"String"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      InstanceType:
        AssociationProperty: ALIYUN::MongoDB::Instance::InstanceType
        Type: String
  • Example description

    In the example for InstanceType, AssociationProperty is set to ALIYUN::MongoDB::Instance::InstanceType. This way, you can query the specifications of the ApsaraDB for MongoDB instance.

NAS resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::NAS::FileSystem::FileSystemId

The information about the file system.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • FileSystemType: the type of the file system. Valid values:

    • all (default): all types of file systems

    • standard: General-purpose NAS file system

    • extreme: Extreme NAS file system

    • cpfs: Cloud Parallel File Storage (CPFS) file system

  • VpcId: the VPC ID.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "NASFileSystemId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::NAS::FileSystem::FileSystemId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "FileSystemType": "all",
        "VpcId": "PayAsYouGo"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  NASFileSystemId:
    Type: String
    AssociationProperty: ALIYUN::NAS::FileSystem::FileSystemId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      FileSystemType: all
      VpcId: PayAsYouGo

ALIYUN::NAS::FileSystem::MountTargetDomain

The address of the mount target.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • FileSystemId: the ID of the file system.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "NASFileSystemId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::NAS::FileSystem::FileSystemId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "FileSystemType": "all",
        "VpcId": "PayAsYouGo"
      }
    },
    "NASMountTarget": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::NAS::FileSystem::MountTargetDomain",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "FileSystemId": "${NASFileSystemId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  NASFileSystemId:
    Type: String
    AssociationProperty: ALIYUN::NAS::FileSystem::FileSystemId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      FileSystemType: all
      VpcId: PayAsYouGo
  NASMountTarget:
    Type: String
    AssociationProperty: ALIYUN::NAS::FileSystem::MountTargetDomain
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      FileSystemId: ${NASFileSystemId}

NLB resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::NLB::LoadBalancer::LoadBalancerId

The ID of the Network Load Balancer (NLB) instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • VpcIds: the VPC IDs.

  • AddressType: the network type.

  • ZoneId: the zone ID.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "InstanceId":{
          "AssociationProperty":"ALIYUN::NLB::LoadBalancer::LoadBalancerId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      InstanceId:
        AssociationProperty: ALIYUN::NLB::LoadBalancer::LoadBalancerId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for InstanceId, AssociationProperty is set to ALIYUN::NLB::LoadBalancer::LoadBalancerId. This way, you can query the ID of the NLB instance.

ALIYUN::NLB::Zone::ZoneId

The zone of the NLB instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ShowRandom: shows the random option that is assigned by the system.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::NLB::Zone::ZoneId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ALIYUN::NLB::Zone::ZoneId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for ZoneId, AssociationProperty is set to ALIYUN::NLB::Zone::ZoneId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the zone of the NLB instance in the specified region.

OOS resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::OOS::Command::CommandContent

The script of the OOS execution.

CommandType: the command type.

Valid values:

  • RunBatScript

  • RunPowerShellScript

  • RunShellScript

  • RunPythonScript

  • RunPerlScript

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "CommandContent": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OOS::Command::CommandContent",
          "AssociationPropertyMetadata": {
            "CommandType": "RunPythonScript"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      CommandContent:
        Type: String
        AssociationProperty: ALIYUN::OOS::Command::CommandContent
        AssociationPropertyMetadata:
          CommandType: RunPythonScript
  • Example description

    In the example for CommandContent, AssociationProperty is set to ALIYUN::OOS::Command::CommandContent, and CommandType is specified in AssociationPropertyMetadata. This way, you can run the script of the OOS execution.

ALIYUN::OOS::Component::TimerTrigger

The component that you want to use for the OOS time trigger.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "TimerTrigger": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OOS::Component::TimerTrigger",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      TimerTrigger:
        Type: String
        AssociationProperty: ALIYUN::OOS::Component::TimerTrigger
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for TimerTrigger, AssociationProperty is set to ALIYUN::OOS::Component::TimerTrigger, and RegionId is specified in AssociationPropertyMetadata. This way, you can configure the component of the OOS time trigger.

ALIYUN::OOS::File::FileUrl

The URL to which you want to upload the file.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • FileType: the export format of the file.

    Valid values: local, https, gitub, and oss.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "FileUrl": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OOS::File::FileUrl",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      FileUrl:
        Type: String
        AssociationProperty: ALIYUN::OOS::File::FileUrl
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for FileUrl, AssociationProperty is set to ALIYUN::OOS::File::FileUrl. This way, you can upload the file to Object Storage Service (OSS).

ALIYUN::OOS::Package::PackageName

The name of the OOS software package.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "PackageName": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OOS::Package::PackageName",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      PackageName:
        Type: String
        AssociationProperty: ALIYUN::OOS::Package::PackageName
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for PackageName, AssociationProperty is set to ALIYUN::OOS::Package::PackageName, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the OOS software package in the specified region.

ALIYUN::OOS::Package::PackageVersion

The version of the OOS software package.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • TemplateName: the template name.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "PackageName": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OOS::Package::PackageName",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "PackageVersion": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OOS::Package::PackageVersion",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "TemplateName": "${PackageName}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      PackageName:
        Type: String
        AssociationProperty: ALIYUN::OOS::Package::PackageName
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      PackageVersion:
        Type: String
        AssociationProperty: ALIYUN::OOS::Package::PackageVersion
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          TemplateName: ${PackageName}
  • Example description

    In the example for PackageVersion, AssociationProperty is set to ALIYUN::OOS::Package::PackageVersion, and RegionId and TemplateName are specified in AssociationPropertyMetadata. This way, you can query the version of the OOS software package in the specified region.

ALIYUN::OOS::Parameter::Value

The common parameter of OOS.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ParameterValue": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OOS::Parameter::Value",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ParameterValue:
        Type: String
        AssociationProperty: ALIYUN::OOS::Parameter::Value
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for ParameterValue, AssociationProperty is set to ALIYUN::OOS::Parameter::Value, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the OOS common parameter in the specified region.

ALIYUN::OOS::PatchBaseline::PatchBaselineName

The information about the patch baseline of OOS.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • Name: the name of the patch baseline.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "OOSPatchBaselineName": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::OOS::PatchBaseline::PatchBaselineName",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  OOSPatchBaselineName:
    Type: String
    AssociationProperty: ALIYUN::OOS::PatchBaseline::PatchBaselineName
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ALIYUN::OOS::SecretParameter::Value

The encryption parameter of OOS.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "SecretParameter": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OOS::SecretParameter::Value",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      SecretParameter:
        Type: String
        AssociationProperty: ALIYUN::OOS::SecretParameter::Value
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for SecretParameter, AssociationProperty is set to ALIYUN::OOS::SecretParameter::Value, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the OOS encryption parameter in the specified region.

ALIYUN::OOS::Template::TemplateName

The OOS template.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "TemplateName": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OOS::Template::TemplateName",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      TemplateName:
        Type: String
        AssociationProperty: ALIYUN::OOS::Template::TemplateName
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for TemplateName, AssociationProperty is set to ALIYUN::OOS::Template::TemplateName, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the OOS template in the specified region.

ALIYUN::OOS::Template::TemplateVersion

The version of the OOS template.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • TemplateName: the template name.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "TemplateName": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OOS::Template::TemplateName",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "TemplateVersion": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OOS::Template::TemplateVersion",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "TemplateName": "${TemplateName}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      TemplateName:
        Type: String
        AssociationProperty: ALIYUN::OOS::Template::TemplateName
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      TemplateVersion:
        Type: String
        AssociationProperty: ALIYUN::OOS::Template::TemplateVersion
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          TemplateName: ${TemplateName}
  • Example description

    In the example for TemplateVersion, AssociationProperty is set to ALIYUN::OOS::Template::TemplateVersion, and RegionId and TemplateName are specified in AssociationPropertyMetadata. This way, you can query the version of the OOS template in the specified region.

OSS resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::OSS::Bucket::BucketName

The name of the OSS bucket.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "BucketName": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OSS::Bucket::BucketName",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      BucketName:
        Type: String
        AssociationProperty: ALIYUN::OSS::Bucket::BucketName
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for BucketName, AssociationProperty is set to ALIYUN::OSS::Bucket::BucketName, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the OSS bucket in the specified region.

ALIYUN::OSS::Bucket::Object

The OSS object.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ObjectType: the storage class of the object.

  • ValueType: the type of the object value.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "BucketObject": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::NLB::Zone::ZoneId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      BucketObject:
        Type: String
        AssociationProperty: ALIYUN::NLB::Zone::ZoneId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for BucketObject, AssociationProperty is set to ALIYUN::OSS::Bucket::Object, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the OSS object in the specified region.

ALIYUN::OSS::Object::ObjectName

The name of the OSS object.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • BucketName: the bucket name.

  • ValueType: the type of the address to be returned.

    • The default value is OSS Url. A value of OSS Url specifies that the complete address is to be returned, such as oss://beijing-test-delete/test.xml.

    • If you set ValueType to a different value, only the object name in the address is returned, such as test.xml.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "BucketName": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OSS::Bucket::BucketName",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "ObjectName": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OSS::Object::ObjectName",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "BucketName": "${BucketName}",
            "ValueType": "${BucketName}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      BucketName:
        Type: String
        AssociationProperty: ALIYUN::OSS::Bucket::BucketName
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      ObjectName:
        Type: String
        AssociationProperty: ALIYUN::OSS::Object::ObjectName
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          BucketName: ${BucketName}
          ValueType: ${BucketName}
  • Example description

    In the example for ObjectName, AssociationProperty is set to ALIYUN::OSS::Object::ObjectName, and RegionId and BucketName are specified in AssociationPropertyMetadata. This way, you can query the OSS object in the specified region.

UploadFilesToUserBucket

The component of uploading objects to OSS.

  • Mode: the mode of the component. Valid values:

    • normal

    • dragger (default)

  • RegionId: the region ID of the bucket. By default, the region ID of the current environment is used. Make sure that the value of RegionId is the same as the region ID of the current environment.

  • BucketName: the bucket name.

  • Multiple: specifies whether to upload multiple objects at a time. Only the following value is supported:

    • true

  • Directory: specifies whether you can upload folders. Only the following value is supported:

    • true

  • ValueType: the type of the return value. Default value: OSS Url.

  • ObjectNamePrefix: the path of the object that you want to upload.

  • AddSuffix: specifies whether to append a timestamp suffix to the name of the uploaded object. Only the following value is supported:

    • true

  • SuffixFormat: the format of the timestamp suffix. Example: YYYY-MM-DD.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "BucketName": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::OSS::Bucket::BucketName",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "UploadFilesToUserBucket": {
          "Type": "String",
          "AssociationProperty": "UploadFilesToUserBucket",
          "AssociationPropertyMetadata": {
            "Mode": "dragger",
            "BucketName": "${BucketName}",
            "Multiple": true,
            "Directory": true,
            "ValueType": "OSS Url",
            "AddSuffix": true,
            "SuffixFormat": "YYYY-MM-DD"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociatiROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      BucketName:
        Type: String
        AssociationProperty: ALIYUN::OSS::Bucket::BucketName
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      UploadFilesToUserBucket:
        Type: String
        AssociationProperty: UploadFilesToUserBucket
        AssociationPropertyMetadata:
          Mode: dragger
          BucketName: ${BucketName}
          Multiple: true
          Directory: true
          ValueType: OSS Url
          AddSuffix: true
          SuffixFormat: YYYY-MM-DD
  • Example description

    In this example, AssociationProperty in BucketName is set to ALIYUN::OSS::Bucket::BucketName, and RegionId and BucketName are specified in AssociationPropertyMetadata. This way, you can query the OSS objects in the specified region. In UploadFilesToUserBucket, AssociationProperty is set to UploadFilesToUserBucket, and BucketName is specified in AssociationPropertyMetadata. This way, you can upload objects to the specified bucket.

PolarDB resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::POLARDB::DBCluster::DBClusterId

The ID of the PolarDB cluster.

  • RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "DBClusterId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::POLARDB::DBCluster::DBClusterId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      DBClusterId:
        Type: String
        AssociationProperty: ALIYUN::POLARDB::DBCluster::DBClusterId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for DBClusterId, AssociationProperty is set to ALIYUN::POLARDB::DBCluster::DBClusterId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ID of the PolarDB cluster in the specified region.

ALIYUN::POLARDB::DBCluster::DBNodeClass

The available resources in a PolarDB cluster.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

  • PayType: the billing method. Valid values:

    • Postpaid (default): pay-as-you-go

    • Prepaid: subscription

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "DBNodeClass": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::POLARDB::DBCluster::DBNodeClass",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      DBNodeClass:
        Type: String
        AssociationProperty: ALIYUN::POLARDB::DBCluster::DBNodeClass
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}

RAM resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::RAM::Role

The RAM role.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "Role": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::RAM::Role",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      Role:
        Type: String
        AssociationProperty: ALIYUN::RAM::Role
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for Role, AssociationProperty is set to ALIYUN::RAM::Role, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the RAM role in the specified region.

ALIYUN::RAM::User

The RAM user.

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "User": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::RAM::User",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      User:
        Type: String
        AssociationProperty: ALIYUN::RAM::User
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for User, AssociationProperty is set to ALIYUN::RAM::User, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the RAM user in the specified region.

ApsaraDB RDS resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::RDS::Engine::EngineId

The database engine type of ApsaraDB RDS.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "Engine": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::RDS::Engine::EngineId"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      Engine:
        Type: String
        AssociationProperty: ALIYUN::RDS::Engine::EngineId
  • Example description

    In the example for Engine, AssociationProperty is set to ALIYUN::RDS::Engine::EngineId. This way, you can query the database engine type of ApsaraDB RDS.

ALIYUN::RDS::Engine::EngineVersion

The database engine version of ApsaraDB RDS.

Engine: the database engine type.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "Engine": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::RDS::Engine::EngineId"
        },
        "EngineVersion": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::RDS::Engine::EngineVersion",
          "AssociationPropertyMetadata": {
            "Engine": "${Engine}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      Engine:
        Type: String
        AssociationProperty: ALIYUN::RDS::Engine::EngineId
      EngineVersion:
        Type: String
        AssociationProperty: ALIYUN::RDS::Engine::EngineVersion
        AssociationPropertyMetadata:
          Engine: ${Engine}
  • Example description

    In the example for EngineVersion, AssociationProperty is set to ALIYUN::RDS::Engine::EngineVersion, and Engine is specified in AssociationPropertyMetadata. This way, you can query the database engine version of ApsaraDB RDS.

ALIYUN::RDS::Instance::AccountPassword

The password of the ApsaraDB RDS database account.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "AccountPassword": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::RDS::Instance::AccountPassword"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      AccountPassword:
        Type: String
        AssociationProperty: ALIYUN::RDS::Instance::AccountPassword
  • Example description

    In the example for AccountPassword, AssociationProperty is set to ALIYUN::RDS::Instance::AccountPassword. This way, you can query the password of the ApsaraDB RDS database account.

ALIYUN::RDS::Instance::InstanceId

The ID of the ApsaraDB RDS instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "RdsId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::RDS::Instance::InstanceId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      RdsId:
        Type: String
        AssociationProperty: ALIYUN::RDS::Instance::InstanceId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
  • Example description

    In the example for RdsId, AssociationProperty is set to ALIYUN::RDS::Instance::InstanceId, and RegionId and ZoneId are specified in AssociationPropertyMetadata. This way, you can query the existing ApsaraDB RDS instances that belong to the specified zone in the specified region.

ALIYUN::RDS::Instance::InstanceType

The specifications of the ApsaraDB RDS instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

  • InstanceChargeType: the billing method of the instance.

  • Category: the edition of the instance.

  • Engine: the database engine type.

  • EngineVersion: the database engine version.

  • DBInstanceClass: the instance type.

  • OrderType: the order type.

  • DBInstanceStorageType: the storage type of the instance.

  • DispenseMode: the allocation mode.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "InstanceType": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::RDS::Instance::InstanceType",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}",
            "Engine": "MySQL"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      InstanceType:
        Type: String
        AssociationProperty: ALIYUN::RDS::Instance::InstanceType
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
          Engine: MySQL
  • Example description

    In the example for InstanceType, AssociationProperty is set to ALIYUN::RDS::Instance::InstanceType, and RegionId, Engine, and ZoneId are specified in AssociationPropertyMetadata. This way, you can query the specifications of the ApsaraDB RDS instance of the specified database engine type in the specified zone.

Tair (Redis OSS-compatible) resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::Redis::Instance::InstanceId

The ID of the Tair (Redis OSS-compatible) instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • InstanceType: the instance specifications.

  • ChargeType: the billing method.

  • EditionType: the edition of the instance.

  • InstanceClass: the instance type.

  • NetworkType: the network type.

  • InstanceStatus: the status of the instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "InstanceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::Redis::Instance::InstanceId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      InstanceId:
        Type: String
        AssociationProperty: ALIYUN::Redis::Instance::InstanceId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for InstanceId, AssociationProperty is set to ALIYUN::Redis::Instance::InstanceId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ID of the Tair (Redis OSS-compatible) instance in the specified region.

ALIYUN::Redis::Instance::InstanceType

The specifications of the Tair (Redis OSS-compatible) instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

  • InstanceChargeType: the billing method of the instance.

  • Engine: the database engine type.

  • ProductType: the edition of the instance.

  • OrderType: the order type.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "Redis": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::Redis::Instance::InstanceType",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      Redis:
        Type: String
        AssociationProperty: ALIYUN::Redis::Instance::InstanceType
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
  • Example description

    In the example for Redis, AssociationProperty is set to ALIYUN::Redis::Instance::InstanceType. This way, you can query the specifications of the Tair (Redis OSS-compatible) instance.

Resource Management resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::ResourceManager::Account

The account in the resource directory.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ResourceAccount": {
          "AssociationProperty": "ALIYUN::ResourceManager::Account",
          "Type": "Json",
          "Description": {
             
            "en": "ResourceAccount"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ResourceAccount:
        AssociationProperty: ALIYUN::ResourceManager::Account
        Type: Json
        Description:
           
          en: ResourceAccount
  • Example description

    In the example for ResourceAccount, AssociationProperty is set to ALIYUN::ResourceManager::Account. This way, you can query the account in resource directory.

ALIYUN::ResourceManager::Folder

The resource directory.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ResourceFolder": {
          "AssociationProperty": "ALIYUN::ResourceManager::Folder",
          "Type": "Json",
          "Description": {
             
            "en": "ResourceFolder"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ResourceFolder:
        AssociationProperty: ALIYUN::ResourceManager::Folder
        Type: Json
        Description:
           
          en: ResourceFolder
  • Example description

    In the example for ResourceFolder, AssociationProperty is set to ALIYUN::ResourceManager::Folder. This way, you can query the resource directory within the current account.

SLB resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::SLB::ACL::ACLId

The ACL ID of SLB.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • AddressIPVersion: the type of the IP address.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "SlbACLId":{
          "AssociationProperty":"ALIYUN::SLB::ACL::ACLId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "AddressIPVersion":"${AddressIPVersion}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      SlbACLId:
        AssociationProperty: ALIYUN::SLB::ACL::ACLId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          AddressIPVersion: ${AddressIPVersion}
  • Example description

    In the example for SlbACLId, AssociationProperty is set to ALIYUN::SLB::ACL::ACLId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ACL of SLB in the specified region.

ALIYUN::SLB::Instance::InstanceType

The specifications of the SLB instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

  • InstanceChargeType: the metering method of the instance.

  • SpotStrategy: the bidding policy for the pay-as-you-go instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "InstanceType": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::SLB::Instance::InstanceType",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      InstanceType:
        Type: String
        AssociationProperty: ALIYUN::SLB::Instance::InstanceType
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
  • Example description

    In the example for InstanceType, AssociationProperty is set to ALIYUN::SLB::Instance::InstanceType, and RegionId and ZoneId are specified in AssociationPropertyMetadata. This way, you can query the specifications of the SLB instance in the specified zone.

ALIYUN::SLB::LoadBalancer::LoadBalancerId

The ID of the SLB instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • VpcId: the VPC ID.

  • VSwitchId: the vSwitch ID.

  • NetworkType: the network type of the NAT gateway.

  • InstanceChargeType: the metering method of the instance.

  • AddressType: the network type.

  • MasterZoneId: the primary zone ID of the SLB instance.

  • SlaveZoneId: the secondary zone ID of the SLB instance.

  • PayType: the billing method of the SLB instance.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "SlbInstanceId":{
          "AssociationProperty":"ALIYUN::SLB::LoadBalancer::LoadBalancerId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      SlbInstanceId:
        AssociationProperty: ALIYUN::SLB::LoadBalancer::LoadBalancerId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for SlbInstanceId, AssociationProperty is set to ALIYUN::SLB::LoadBalancer::LoadBalancerId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ID of the SLB instance in the specified region.

ALIYUN::SLB::LoadBalancer::ZoneId

The information about the zone of the SLB instance.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • MasterZoneId: the ID of the primary zone.

  • ZoneType: the zone type.

    • Master (default): primary

    • Slave: secondary

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "SLBZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::SLB::LoadBalancer::ZoneId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  SLBZoneId:
    Type: String
    AssociationProperty: ALIYUN::SLB::LoadBalancer::ZoneId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

Service Catalog resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::ServiceCatalog::LaunchOption::PortfolioId

The ID of the product portfolio of Service Catalog.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ProductId: the product ID.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "PortfolioId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ServiceCatalog::LaunchOption::PortfolioId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      PortfolioId:
        Type: String
        AssociationProperty: ALIYUN::ServiceCatalog::LaunchOption::PortfolioId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for PortfolioId, AssociationProperty is set to ALIYUN::ServiceCatalog::LaunchOption::PortfolioId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ID of the product portfolio of Service Catalog in the specified region.

ALIYUN::ServiceCatalog::ProductVersion::ProductVersionId

The ID of the product version of Service Catalog.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ProductId: the product ID.

  • Active: specifies whether to enable the product version.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ProductVersionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ServiceCatalog::ProductVersion::ProductVersionId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ProductVersionId:
        Type: String
        AssociationProperty: ALIYUN::ServiceCatalog::ProductVersion::ProductVersionId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for ProductVersionId, AssociationProperty is set to ALIYUN::ServiceCatalog::ProductVersion::ProductVersionId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ID of the product version of Service Catalog in the specified region.

Tag resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::Tag::TagKey

The information about the tag.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ResourceType: the resource type.

  • ShowSystem: specifies whether to filter system tags.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "TagKey": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Tag::TagKey",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  TagKey:
    Type: String
    AssociationProperty: ALIYUN::Tag::TagKey
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ALIYUN::Tag::TagValue

The tag value that corresponds to a specified a tag key.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ResourceType: the resource type.

  • Key: the tag key.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "TagKey": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Tag::TagKey",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "TagValue": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Tag::TagValue",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "Key": "${TagKey}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  TagKey:
    Type: String
    AssociationProperty: ALIYUN::Tag::TagKey
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  TagValue:
    Type: String
    AssociationProperty: ALIYUN::Tag::TagValue
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      Key: ${TagKey}

User resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::User::Account::AccountIds

The account IDs.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "AccountIds": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::User::Account::AccountIds"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      AccountIds:
        Type: String
        AssociationProperty: ALIYUN::User::Account::AccountIds
  • Example description

    In the example for AccountIds, AssociationProperty is set to ALIYUN::User::Account::AccountIds. This way, you can query the account IDs.

ALIYUN::User::AccountId

The ID of the Alibaba Cloud account.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "MasterAccountId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::User::AccountId"
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  MasterAccountId:
    Type: String
    AssociationProperty: ALIYUN::User::AccountId

ALIYUN::User::UserId

The ID of the Alibaba Cloud user.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CurrentAccountId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::User::UserId"
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CurrentAccountId:
    Type: String
    AssociationProperty: ALIYUN::User::UserId

VPC resource

Value of AssociationProperty

Description

Parameter in AssociationPropertyMetadata

ALIYUN::VPC::EIP::AllocationId

The information about the elastic IP address (EIP).

  • RegionId: the region ID. By default, the region ID of the stack is used.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "Eip": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::VPC::EIP::AllocationId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  Eip:
    Type: String
    AssociationProperty: ALIYUN::VPC::EIP::AllocationId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ALIYUN::VPC::NatGateway::NatGatewayId

The ID of the NAT gateway.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

  • VpcId: the VPC ID.

  • InstanceChargeType: the billing method of the instance.

  • NatType: the type of the NAT gateway.

  • NetworkType: the network type of the NAT gateway.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "VpcId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "NatGateway": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::VPC::NatGateway::NatGatewayId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}",
            "VpcId": "${VpcId}",
            "InstanceChargeType": "PostPaid",
            "NatType": "Enhanced",
            "NetworkType": "intranet"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      VpcId:
        Type: String
        AssociationProperty: ALIYUN::ECS::VPC::VPCId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      NatGateway:
        Type: String
        AssociationProperty: ALIYUN::VPC::NatGateway::NatGatewayId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
          VpcId: ${VpcId}
          InstanceChargeType: PostPaid
          NatType: Enhanced
          NetworkType: intranet
  • Example description

    In the example for NatGateway, AssociationProperty is set to ALIYUN::VPC::NatGateway::NatGatewayId, and RegionId, ZoneId, VpcId, InstanceChargeType, NatType, and NetworkType are specified in AssociationPropertyMetadata. This way, you can query the ID of the NAT gateway that matches the filter conditions in the specified region.

ALIYUN::VPC::VPC::CidrBlock

The CIDR block of the new VPC.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "CIDR": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::VPC::VPC::CidrBlock"
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      CIDR:
        Type: String
        AssociationProperty: ALIYUN::VPC::VPC::CidrBlock
  • Example description

    In the example for CIDR, AssociationProperty is set to ALIYUN::VPC::VPC::CidrBlock. This way, you can specify the CIDR block of the VPC.

ALIYUN::VPC::VSwitch::CidrBlock

The CIDR block that you want to use to create a vSwitch.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • VpcId: the VPC ID.

  • VpcCidrBlock: the CIDR block of the VPC.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "RegionId"
        },
        "VpcId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "CIDR": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::VPC::VSwitch::CidrBlock",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "VpcId": "${VpcId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: RegionId
      VpcId:
        Type: String
        AssociationProperty: ALIYUN::ECS::VPC::VPCId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      CIDR:
        Type: String
        AssociationProperty: ALIYUN::VPC::VSwitch::CidrBlock
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          VpcId: ${VpcId}
  • Example description

    In the example for CIDR, AssociationProperty is set to ALIYUN::VPC::VSwitch::CidrBlock, and RegionId and VpcId are specified in AssociationPropertyMetadata. This way, you can specify the CIDR block of the vSwitch.

ALIYUN::VPC::VSwitch::VSwitchId

The vSwitch ID.

  • RegionId: the region ID. By default, the region ID of the stack is used.

  • ZoneId: the zone ID.

  • VpcId: the VPC ID.

  • InstanceType: the instance specifications.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "VSwitchId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      VSwitchId:
        Type: String
        AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
  • Example description

    In the example for VSwitchId, AssociationProperty is set to ALIYUN::VPC::VSwitch::VSwitchId, and RegionId and ZoneId are specified in AssociationPropertyMetadata. This way, you can query the ID of the vSwitch in the specified region.

ALIYUN::VPC::VirtualBorderRouter::RouteTableId

The ID of the virtual border router (VBR).

RegionId: the region ID. By default, the region ID of the stack is used.

Example:

  • Sample code

    JSON format:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "RouteTableId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::VPC::VirtualBorderRouter::RouteTableId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML format:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      RouteTableId:
        Type: String
        AssociationProperty: ALIYUN::VPC::VirtualBorderRouter::RouteTableId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In the example for RouteTableId, AssociationProperty is set to ALIYUN::VPC::VirtualBorderRouter::RouteTableId, and RegionId is specified in AssociationPropertyMetadata. This way, you can query the ID of the VBR in the specified region.

ALIYUN::VPC::Zone::ZoneId

The information about the zone in the VPC.

  • RegionId: the region ID. By default, the region ID of the stack is used.

Sample code

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::VPC::Zone::ZoneId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::VPC::Zone::ZoneId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

Usage examples

Example 1: AssociationProperty

In this example, AssociationProperty is set to ALIYUN::ECS::Image::ImageId to query the IDs of all images in the specified region.

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "UserName": {
      "Label": "Username",
      "Description": "Enter the username",
      "Default": "anonymous",
      "Type": "String",
      "MinLength": "6",
      "MaxLength": "12",
      "AllowedValues": [
        "anonymous",
        "user-one",
        "user-two"
      ]
    },
    "PassWord": {
      "Label": "Password",
      "NoEcho": "True",
      "Description": "Enter the password",
      "Type": "String",
      "MinLength": "1",
      "MaxLength": "41",
      "AllowedPattern": "[a-zA-Z0-9]*"
    },
    "ImageId": {
      "Label": "Image",
      "Type": "String",
      "Description": "Select an image",
      "AssociationProperty": "ALIYUN::ECS::Image::ImageId",
      "Default": "centos_7_7_x64_20G_alibase_2020****.vhd"
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  UserName:
    Label: Username
    Description: Enter the username
    Default: anonymous
    Type: String
    MinLength: '6'
    MaxLength: '12'
    AllowedValues:
      - anonymous
      - user-one
      - user-two
  PassWord:
    Label: Password
    NoEcho: 'True'
    Description: Enter the password
    Type: String
    MinLength: '1'
    MaxLength: '41'
    AllowedPattern: '[a-zA-Z0-9]*'
  ImageId:
    Label: Image
    Type: String
    Description: Select an image
    AssociationProperty: ALIYUN::ECS::Image::ImageId
    Default: centos_7_7_x64_20G_alibase_2020****.vhd

The following section describes the parameters:

  • UserName: the username. The value of UserName is of the string data type and must be 6 to 12 characters in length. Valid values:

    • anonymous (default)

    • user-one

    • user-two

  • PassWord: the password. The value of PassWord is of the string data type. No default value is provided. The value must be 1 to 41 characters in length, and can contain letters and digits.

    NoEcho is set to true. A value of true specifies that ROS returns a password masked as asterisks (*) after you query the stack.

  • ImageId: the image ID. The value of ImageId is of the string data type.

    AssociationProperty is set to ALIYUN::ECS::Image::ImageId. This way, the ROS console checks whether the ID of the specified image is available when you create the stack. The ROS console also displays the IDs of other images that are available in the same region as the specified image in a drop-down list.

Example 2: AssociationPropertyMetadata

In this example, AssociationProperty and AssociationPropertyMetadata are specified to query the vSwitch in the specified VPC and zone. For AssociationPropertyMetadata, RegionId is set to the literal value cn-hangzhou, VpcId is set to the variable ${VpcId}, and ZoneId is set to the variable ${EcsZone}. ${VpcId} varies based on the value of ALIYUN::ECS::VPC::VPCId, and ${EcsZone} varies based on the value of ZoneId. This way, the vSwitch is associated with the specified VPC and zone.

Note

The AllowedValues parameter is specified for EcsZone. AutoChangeType is set to false in AssociationPropertyMetadata. This way, the ROS console displays the values of the AllowedValues parameter as a drop-down list.

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "EcsZone": {
      "Type": "String",
      "AllowedValues": [
        "cn-hangzhou-i",
        "cn-hangzhou-j",
        "cn-hangzhou-k",
        "cn-hangzhou-h"
      ],
      "AssociationPropertyMetadata": {
        "AutoChangeType": false
      }
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "RegionId": "cn-hangzhou",
        "VpcId": "${VpcId}",
        "ZoneId": "${EcsZone}"
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  EcsZone:
    Type: String
    AllowedValues:
      - cn-hangzhou-i
      - cn-hangzhou-j
      - cn-hangzhou-k
      - cn-hangzhou-h
    AssociationPropertyMetadata:
      AutoChangeType: false
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      RegionId: cn-hangzhou
      VpcId: ${VpcId}
      ZoneId: ${EcsZone}

Example 3: Automatic conversion of Terraform

If you set AssociationProperty to Auto, ROS automatically generates parameters, such as AssociationProperty and AssociationPropertyMetadata, based on the original data structure of Terraform.

  • Complete sample code of the template

    variable "user_information" {
      type = object({
        name    = string
        address = string
      })
      description = <<EOT
      {
        "AssociationProperty": "Auto",
        "AssociationPropertyMetadata": {
          "Overwrite": {
            "name": {
              "Label": {
                 
                "en": "Name"
              }
            }
          }
        }
      }
      EOT
    }
    
    variable "region_ids" {
      type    = list(string)
      description = <<EOT
      {
        "AssociationProperty": "Auto",
        "AssociationPropertyMetadata": {
          "Overwrite": {
            "*": {
              "AssociationProperty": "ALIYUN::ECS::RegionId"
            }
          }
        }
      }
      EOT
    }
    
    variable "docker_ports" {
      type = list(object({
        internal = number
        external = number
        protocol = string
      }))
      description = <<EOT
      {
        "AssociationProperty": "Auto",
        "AssociationPropertyMetadata": {
          "Overwrite": {
            "protocol": {
              "AllowedValues": ["TCP", "UDP", "ICMP"]
            },
            "internal": {
              "Label": {
                 
                "en": "Internal Port"
              }
            }
          }
        }
      }
      EOT
    }
    
    variable "complex_type_demo" {
      type = list(object({
        b = list(string)
        c = list(object({
          d = list(string)
        }))
        e = list(list(string))
        f = list(list(object({
          g = list(string)
        })))
      }))
      description = <<EOT
      {
        "AssociationProperty": "Auto",
        "AssociationPropertyMetadata": {
            "Overwrite": {
                "b": {
                    "MaxLength": 3,
                    "AssociationPropertyMetadata": {
                        "Something": "123"
                    },
                    "Label": {
                        "zh-cn": "B",
                        "en": "B"
                    }
                },
                "b.*": {
                    "AssociationProperty": "ALIYUN::ECS::RegionId"
                },
                "c": {
                    "Label": {
                        "zh-cn": "C",
                        "en": "C"
                    }
                },
                "c.d": {
                    "Label": {
                        "zh-cn": "C/D",
                        "en": "C/D"
                    }
                },
                "c.d.*": {
                    "AssociationProperty": "ALIYUN::ECS::RegionId"
                },
                "e": {
                    "Label": {
                        "zh-cn": "E",
                        "en": "E"
                    }
                },
                "e.*": {
                    "MaxLength": 3
                },
                "e.*.*": {
                    "AssociationProperty": "ALIYUN::ECS::RegionId"
                },
                "f.g": {
                    "Label": {
                        "zh-cn": "F/G",
                        "en": "F/G"
                    }
                },
                "f.g.*": {
                    "AssociationProperty": "ALIYUN::ECS::RegionId"
                }
            }
        }
      }
      EOT
    }
  • Sample code of the template after user_information is converted

    {
      "AssociationPropertyMetadata":{
        "Parameters":{
          "address":{
            "Type":"String"
          },
          "name":{
            "Type":"String",
            "Label":{
              "en":"Name",
               
            }
          }
        }
      }
    }
  • Sample code of the template after region_ids is converted

    {
      "AssociationPropertyMetadata":{
        "Parameter":{
          "AssociationProperty":"ALIYUN::ECS::RegionId",
          "Type":"String"
        }
      },
      "AssociationProperty":"List[Parameter]"
    }
  • Sample code of the template after docker_ports is converted

    {
      "AssociationPropertyMetadata":{
        "Parameters":{
          "internal":{
            "Type":"Number",
            "Label":{
              "en":"Internal Port",
               
            }
          },
          "protocol":{
            "Type":"String",
            "AllowedValues":[
              "TCP",
              "UDP",
              "ICMP"
            ]
          },
          "external":{
            "Type":"Number"
          }
        }
      },
      "AssociationProperty":"List[Parameters]"
    }
  • Sample code of the template after complex_type_demo is converted

    {
      "AssociationPropertyMetadata":{
        "Parameter":{
          "AssociationPropertyMetadata":{
            "Parameters":{
              "b":{
                "AssociationPropertyMetadata":{
                  "Parameter":{
                    "AssociationProperty":"ALIYUN::ECS::RegionId",
                    "Type":"String"
                  },
                  "Something":"123"
                },
                "AssociationProperty":"List[Parameter]",
                "Type":"Json",
                "Label":{
                  "en":"B",
                  "zh-cn":"B"
                },
                "MaxLength":3
              },
              "c":{
                "AssociationPropertyMetadata":{
                  "Parameter":{
                    "AssociationPropertyMetadata":{
                      "Parameters":{
                        "d":{
                          "AssociationPropertyMetadata":{
                            "Parameter":{
                              "AssociationProperty":"ALIYUN::ECS::RegionId",
                              "Type":"String"
                            }
                          },
                          "AssociationProperty":"List[Parameter]",
                          "Type":"Json",
                          "Label":{
                            "en":"C/D",
                            "zh-cn":"C/D"
                          }
                        }
                      }
                    },
                    "Type":"Json"
                  }
                },
                "AssociationProperty":"List[Parameter]",
                "Type":"Json",
                "Label":{
                  "en":"C",
                  "zh-cn":"C"
                }
              },
              "e":{
                "AssociationPropertyMetadata":{
                  "Parameter":{
                    "AssociationPropertyMetadata":{
                      "Parameter":{
                        "AssociationProperty":"ALIYUN::ECS::RegionId",
                        "Type":"String"
                      }
                    },
                    "AssociationProperty":"List[Parameter]",
                    "Type":"Json",
                    "MaxLength":3
                  }
                },
                "AssociationProperty":"List[Parameter]",
                "Type":"Json",
                "Label":{
                  "en":"E",
                  "zh-cn":"E"
                }
              },
              "f":{
                "AssociationPropertyMetadata":{
                  "Parameter":{
                    "AssociationPropertyMetadata":{
                      "Parameter":{
                        "AssociationPropertyMetadata":{
                          "Parameters":{
                            "g":{
                              "AssociationPropertyMetadata":{
                                "Parameter":{
                                  "AssociationProperty":"ALIYUN::ECS::RegionId",
                                  "Type":"String"
                                }
                              },
                              "AssociationProperty":"List[Parameter]",
                              "Type":"Json",
                              "Label":{
                                "en":"F/G",
                                "zh-cn":"F/G"
                              }
                            }
                          }
                        },
                        "Type":"Json"
                      }
                    },
                    "AssociationProperty":"List[Parameter]",
                    "Type":"Json"
                  }
                },
                "AssociationProperty":"List[Parameter]",
                "Type":"Json"
              }
            }
          },
          "Type":"Json"
        }
      },
      "AssociationProperty":"List[Parameter]"
    }

More examples

You can use AssociationProperty and AssociationPropertyMetadata to perform the following operations: