examples of AssociationProperty and AssociationPropertyMetadata - Resource Orchestration Service

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

Parameters

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

A literal value. For example, if you set AssociationPropertyMetadata to "RegionId": "cn-hangzhou", ROS resolves this value as the literal value cn-hangzhou.
A 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 following table describes the relationship between the values of AssociationProperty and the parameters in AssociationPropertyMetadata in ROS.

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 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 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 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 of 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.

JSON format:

{
 "ROSTemplateFormatVersion": "2015-09-01",
 "Parameters": {
  "VpcId": {
   "Type": "String",
   "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
  },
  "EcsZone": {
   "Type": "String",
   "AssociationProperty": "ZoneId"
  },
  "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
    AssociationProperty: ZoneId
  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: