AssociationProperty and AssociationPropertyMetadata - CloudOps Orchestration Service

When you use OOS to create executions that require selecting multiple resources, you typically need to open multiple consoles to find resource parameter information. In the Parameters section of a template, you can specify AssociationProperty to obtain the resources in the specified region and specify AssociationPropertyMetadata to add filter conditions for the parameters. This simplifies operations that you perform to configure parameter settings in the console.

Parameter description

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

A literal value. For example: "RegionId": "cn-hangzhou", OOS will fill in the specific region cn-hangzhou.
A variable in the format ${ParameterKey}. For example: "VpcId": "${VpcId}", OOS will dynamically obtain the value corresponding to the VpcId parameter in the current template.
Note
- If you want to set ${ParameterKey} as a fixed value, you can add an exclamation mark (!). For example: ${!Literal} indicates the value is ${Literal}.
- If you want to use parameter variables in a Terraform template, you need to add an additional $ before $. For example: "VpcId": "$${VpcId}", OOS will dynamically obtain the value corresponding to VpcId in the Terraform template.

The following table shows the corresponding AssociationPropertyMetadata when OOS supports different resources for AssociationProperty.

Custom resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::Resource::Data::API

Used for querying data based on parameters through Alibaba Cloud product OpenAPI.

APIAction: Cloud product and cloud product API information.
OptionsGetter: Defines the data layer parsing mode.
ValueGetter: Defines the name of the parsing attribute.
LabelGetter: Defines the attribute displayed in the page for query results.
PageFilterKeys: Pagination filtering attributes.
- PageSize: Page size.
- PageNumber: Page number.
- TotalCount: Total number of items.

Examples:

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "PolicyClasses": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Resource::Data::API",
      "AssociationPropertyMetadata": {
        "APIAction": "APIG/ListPolicyClasses",
        "OptionsGetter": "data.items",
        "ValueGetter": "classId",
        "LabelGetter": "name",
        "PageFilterKeys": {
          "PageSize": "pageSize",
          "PageNumber": "pageNumber",
          "TotalCount": "totalSize",
        }
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  PolicyClasses:
    Type: String
    AssociationProperty: ALIYUN::Resource::Data::API
    AssociationPropertyMetadata:
      APIAction: APIG/ListPolicyClasses
      OptionsGetter: data.items
      ValueGetter: classId
      LabelGetter: name
      PageFilterKeys:
        PageSize: pageSize
        PageNumber: pageNumber
        TotalCount: totalSize

Example description
In the example for PolicyClasses, AssociationProperty is set to ALIYUN::Resource::Data::API, and APIAction, OptionsGetter, ValueGetter, LabelGetter, and PageFilterKeys are specified in AssociationPropertyMetadata. This way, you can call the ListPolicyClasses API of Cloud-native API Gateway (APIG) to query the policy template ID (classId) and display the policy template name.

Basic resources

AssociationProperty value	Description	Corresponding AssociationPropertyMetadata
Auto	OOS will automatically generate fields such as AssociationProperty and AssociationPropertyMetadata based on the Terraform original data structure. 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, add ``. To specify an element in an object, you must add the name of the element. Use `.` to separate paths. You can omit `` at the beginning and in the middle of a path. You cannot omit one or more `` at the end of a path. Examples: // 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "ManagedKubernetesClusterName": { "Type": "String", "Label": { "en": "Managed Kubernetes Cluster Name", "zh-cn": "ACK托管版集群名称" }, "AssociationProperty": "AutoCompleteInput", "AssociationPropertyMetadata": { "Length": 5, "Prefix": "cluster-for-mse-", "Suffix": "-by-OOS", "CharacterClasses": [ { "Class": "lowercase", "min": 1 } ] } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: ManagedKubernetesClusterName: Type: String Label: en: Managed Kubernetes Cluster Name zh-cn: ACK托管版集群名称 AssociationProperty: AutoCompleteInput AssociationPropertyMetadata: Length: 5 Prefix: cluster-for-mse- Suffix: '-by-OOS' CharacterClasses: - Class: lowercase min: 1`
ChargeType	The billing method. Valid values: 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. Examples: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "DateTime": { "Type": "String", "AssociationProperty": "DateTime" } } }` YAML format: `FormatVersion: 'OOS-2019-06-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.	Examples: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "GMTZone": { "Type": "String", "AssociationProperty": "GMTZone" } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 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. Examples: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionIds": { "Label": { "en": "ECS Region Ids", "zh-cn": "ECS地域列表" }, "MaxLength": 100, "MinLength": 1, "Type": "Json", "AssociationProperty": "List[Parameter]", "AssociationPropertyMetadata": { "Parameter": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId", "MinLength": 1, "MaxLength": 64 } } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionIds: Label: en: ECS Region Ids zh-cn: ECS地域列表 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 AssociationPropertyMetadata is set to Parameter. This way, you can add a list of Elastic Compute Service (ECS) region IDs in the ROS console.
List[Parameters]	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. Examples: Sample code JSON format: { "FormatVersion": "OOS-2019-06-01", "Parameters": { "RenameECS": { "Label": { "en": "Rename ECS", "zh-cn": "重命名ECS" }, "MaxLength": 100, "MinLength": 1, "Type": "Json", "AssociationProperty": "List[Parameters]", "AssociationPropertyMetadata": { "Parameters": { "InstanceId": { "Type": "String", "Label": { "en": "ECS Instance Id", "zh-cn": "ECS实例ID" }, "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId", "MinLength": 1, "MaxLength": 64 }, "Name": { "Type": "String", "Label": { "en": "New Name", "zh-cn": "新名称" }, "MinLength": 1 } } } } } } YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RenameECS: Label: en: Rename ECS zh-cn: 重命名ECS MaxLength: 100 MinLength: 1 Type: Json AssociationProperty: List[Parameters] AssociationPropertyMetadata: Parameters: InstanceId: Type: String Label: en: ECS Instance Id zh-cn: ECS实例ID AssociationProperty: ALIYUN::ECS::Instance::InstanceId MinLength: 1 MaxLength: 64 Name: Type: String Label: en: New Name zh-cn: 新名称 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: controls 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 Operation Orchestration Service (OOS).	RegionId: the region ID. By default, the region ID of the stack is used. Examples: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "OosServiceRole": { "Type": "String", "AssociationProperty": "OOSServiceRole", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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.	Examples: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RateControl": { "Type": "String", "AssociationProperty": "RateControl" } } }` YAML format: `FormatVersion: 'OOS-2019-06-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. Examples: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "Tags": { "Type": "String", "AssociationProperty": "Tags", "AssociationPropertyMetadata": { "RegionId": "${RegionId}", "ResourceType": "ALIYUN::ECS::INSTANCE" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 filter condition. You can select ECS instances based on a filter condition, such as an instance ID, a tag, or a resource group.	RegionId: the region ID. By default, the region ID of the stack is used. Examples: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "Targets": { "Type": "String", "AssociationProperty": "Targets", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 filter condition.
TextArea	The rich text.	None
TimeTriggerWeekly	The time picker that allows you to specify the interval by the day of a week.	Examples: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "TimeTriggerWeekly": { "Type": "String", "AssociationProperty": "TimeTriggerWeekly" } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 a week.
TimeZone	The time zone.	Examples: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "TimeZone": { "Type": "String", "AssociationProperty": "TimeZone" } } }` YAML format: `FormatVersion: 'OOS-2019-06-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.
None	After you click Select Instances in the ROS console, a dialog box that prompts you to configure relevant parameters appears. 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. Key: the parameter name. Value: the parameter value. For more information, see Overview. Examples: Sample code JSON format: { "FormatVersion": "OOS-2019-06-01", "Parameters": { "RenameECS": { "Label": { "en": "Rename ECS", "zh-cn": "重命名ECS" }, "MaxLength": 100, "MinLength": 1, "Type": "Json", "AssociationPropertyMetadata": { "Parameters": { "InstanceId": { "Type": "String", "Label": { "en": "ECS Instance Id", "zh-cn": "ECS实例ID" }, "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId", "MinLength": 1, "MaxLength": 64 }, "Name": { "Type": "String", "Label": { "en": "New Name", "zh-cn": "新名称" }, "MinLength": 1 } } } } } } YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RenameECS: Label: en: Rename ECS zh-cn: 重命名ECS MaxLength: 100 MinLength: 1 Type: Json AssociationPropertyMetadata: Parameters: InstanceId: Type: String Label: en: ECS Instance Id zh-cn: ECS实例ID AssociationProperty: ALIYUN::ECS::Instance::InstanceId MinLength: 1 MaxLength: 64 Name: Type: String Label: en: New Name zh-cn: 新名称 MinLength: 1` Example description In this example, AssociationProperty is not specified, and Parameters is specified in AssociationPropertyMetadata. 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 metadata. The value of Metadata is of the dictionary data type. For more information, see Metadata. Note You can use List[Parameter] to implement nested structures, and there is no limit on the nesting depth.

ACR resources

AssociationProperty values	Description	Corresponding 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`: normal. `DELETING`: being deleted. Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ACRNamespace": { "Type": "String", "AssociationProperty": "ALIYUN::ACR::Namespace::Name", "AssociationPropertyMetadata": { "RegionId": "${RegionId}", "Status": "NORMAL" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ACRRepo": { "Type": "String", "AssociationProperty": "ALIYUN::ACR::Repo::RepoAttribute", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 namespace. Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ACRTag": { "Type": "String", "AssociationProperty": "ALIYUN::ACR::Repo::Tag", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ACRTag: Type: String AssociationProperty: ALIYUN::ACR::Repo::Tag AssociationPropertyMetadata: RegionId: ${RegionId}`

Cloud-native Gateway resource

AssociationProperty value

Description

Corresponding 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:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "GatewayId":{
      "AssociationProperty":"ALIYUN::APIG::Gateway::GatewayId"
      "Type":"String"
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  GatewayId:
    AssociationProperty: ALIYUN::APIG::Gateway::GatewayId
    Type: String

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 resources

AssociationProperty value	Description	Corresponding 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. The following sample code provides an example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "RegionId" }, "AlbACLId":{ "AssociationProperty":"ALIYUN::ALB::ACL::ACLId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" }, "Type":"String" } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: RegionId AlbACLId: AssociationProperty: ALIYUN::ALB::ACL::ACLId AssociationPropertyMetadata: RegionId: ${RegionId} Type: String` 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. The following sample code provides an example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "AlbInstanceId":{ "AssociationProperty":"ALIYUN::ALB::Instance::InstanceId", "Type":"String", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId AlbInstanceId: AssociationProperty: ALIYUN::ALB::Instance::InstanceId Type: String AssociationPropertyMetadata: RegionId: ${RegionId}` 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 ID of the virtual private cloud (VPC). AddressType: the network type. ZoneId: the zone ID. PayType: the billing method of the ALB instance. The following sample code provides an example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "AlbLoadBalancerId":{ "AssociationProperty":"ALIYUN::ALB::LoadBalancer::LoadBalancerId", "Type":"String", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId AlbLoadBalancerId: AssociationProperty: ALIYUN::ALB::LoadBalancer::LoadBalancerId Type: String AssociationPropertyMetadata: RegionId: ${RegionId}` 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.

Bailian resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::Bailian::ApiKey::ApiKeyInfo

Queries the Alibaba Cloud Model Studio API-KEY information.

Sample code:

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "ApiKeyInfo": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Bailian::ApiKey::ApiKeyInfo"
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  ApiKeyInfo:
    Type: String
    AssociationProperty: ALIYUN::Bailian::ApiKey::ApiKeyInfo

BSS resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::BSS::PricingModule::ModuleCode

Queries the pricing information about an Alibaba Cloud service.

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: the subscription billing method.
- PayAsYouGo: the pay-as-you-go billing method.

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-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

CAS resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::CAS::Certificate::CertificateId

The certificate of the SLB instance.

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

Example:

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "Certificate": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CAS::Certificate::CertificateId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  Certificate:
    Type: String
    AssociationProperty: ALIYUN::CAS::Certificate::CertificateId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

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 resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::CEN::Instance::CenId

Queries the information about your CEN instances.

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

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "ResourceGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId"
    },
    "CenId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CEN::Instance::CenId",
      "AssociationPropertyMetadata": {
        "ResourceGroupId": "${ResourceGroupId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-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

Queries the information about transit routers that are connected to a 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:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-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}

CMS resources

AssociationProperty value	Description	Corresponding AssociationPropertyMetadata
ALIYUN::CMS::Alarm::MetricSelector	The information about available metrics in CloudMonitor.	Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "CMSMetricSelector": { "Type": "String", "AssociationProperty": "ALIYUN::CMS::Alarm::MetricSelector" } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: CMSMetricSelector: Type: String AssociationProperty: ALIYUN::CMS::Alarm::MetricSelector`
ALIYUN::CMS::Alarm::Rule	The threshold-triggered alert rule.	Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "Rule": { "AssociationProperty": "ALIYUN::CMS::Alarm::Rule", "Type": "String", "Description": { "zh-cn": "选择阈值报警规则", "en": "AlarmRule" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: Rule: AssociationProperty: ALIYUN::CMS::Alarm::Rule Type: String Description: zh-cn: 选择阈值报警规则 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "SilenceTime": { "AssociationProperty": "ALIYUN::CMS::Alarm::SilenceTime", "Type": "String", "Description": { "zh-cn": "报警沉默周期", "en": "SilenceTime" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: SilenceTime: AssociationProperty: ALIYUN::CMS::Alarm::SilenceTime Type: String Description: zh-cn: 报警沉默周期 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "TriggerResources": { "AssociationProperty": "ALIYUN::CMS::Alarm::TriggerResources", "Type": "String", "Description": { "zh-cn": "选择报警资源触发器", "en": "TriggerResources" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: TriggerResources: AssociationProperty: ALIYUN::CMS::Alarm::TriggerResources Type: String Description: zh-cn: 选择报警资源触发器 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "EventRule": { "AssociationProperty": "ALIYUN::CMS::Event::EventFilterRule", "Type": "String", "Description": { "zh-cn": "选择事件报警规则", "en": "EventRule" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: EventRule: AssociationProperty: ALIYUN::CMS::Event::EventFilterRule Type: String Description: zh-cn: 选择事件报警规则 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "EventLevel": { "AssociationProperty": "ALIYUN::CMS::Event::EventLevel", "Type": "String", "Description": { "zh-cn": "选择事件报警级别", "en": "EventLevel" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: EventLevel: AssociationProperty: ALIYUN::CMS::Event::EventLevel Type: String Description: zh-cn: 选择事件报警级别 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "EventName": { "AssociationProperty": "ALIYUN::CMS::Event::EventName", "Type": "String", "Description": { "zh-cn": "选择事件报警名称", "en": "EventName" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: EventName: AssociationProperty: ALIYUN::CMS::Event::EventName Type: String Description: zh-cn: 选择事件报警名称 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "ProductType": { "AssociationProperty": "ALIYUN::CMS::Product::ProductType", "Type": "String", "Description": { "zh-cn": "选择事件报警名称", "en": "ProductType" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: ProductType: AssociationProperty: ALIYUN::CMS::Product::ProductType Type: String Description: zh-cn: 选择事件报警名称 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.

CR resources

AssociationProperty values	Description	Corresponding 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`: initializing. `INIT_ERROR`: initialization failed. `STARTING`: starting. `RUNNING`: running. `STOPPING`: stopping. `STOPPED`: stopped. `DELETING`: deleting. `DELETED`: deleted. Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "CRInstanceId": { "Type": "String", "AssociationProperty": "ALIYUN::CR::Instance::InstanceId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}", "InstanceStatus": "RUNNING" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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`: normal. `DELETING`: deleting. InstanceId: the instance ID. Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "CRNameSpace": { "Type": "String", "AssociationProperty": "ALIYUN::CR::NameSpace::Name", "AssociationPropertyMetadata": { "RegionId": "${RegionId}", "NamespaceStatus": "NORMAL" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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`: normal. `DELETING`: deleting. `DELETED`: deleted. `ALL`: all repository statuses. InstanceId: the instance ID. Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "CRRepository": { "Type": "String", "AssociationProperty": "ALIYUN::CR::Repository::RepoName", "AssociationPropertyMetadata": { "RegionId": "${RegionId}", "RepoStatus": "NORMAL" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "CRRepositoryTag": { "Type": "String", "AssociationProperty": "ALIYUN::CR::Repository::Tag", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId CRRepositoryTag: Type: String AssociationProperty: ALIYUN::CR::Repository::Tag AssociationPropertyMetadata: RegionId: ${RegionId}`

CS resources

AssociationProperty value	Description	Corresponding AssociationPropertyMetadata
ALIYUN::CS::Cluster::ClusterId	The ID of the 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ClusterId":{ "AssociationProperty":"ALIYUN::CS::Cluster::ClusterId", "Type":"String", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ClusterId: AssociationProperty: ALIYUN::CS::Cluster::ClusterId Type: String AssociationPropertyMetadata: RegionId: ${RegionId}` 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "ClusterId": { "Type": "String", "AssociationProperty": "ALIYUN::CS::Cluster::ClusterId" }, "ClusterNodePool":{ "AssociationProperty":"ALIYUN::CS::Cluster::ClusterId", "Type":"String", "AssociationPropertyMetadata": { "ClusterId": "${ClusterId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: ClusterId: Type: String AssociationProperty: ALIYUN::CS::Cluster::ClusterId ClusterNodePool: AssociationProperty: ALIYUN::CS::Cluster::ClusterId Type: String AssociationPropertyMetadata: ClusterId: ${ClusterId}` 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 Edition cluster, ACK Serverless Pro cluster, ACK Serverless Basic Edition cluster, ACK Edge Pro cluster, and ACK Edge Basic Edition cluster. `ExternalKubernetes`: registered cluster. Profile: the scenario in which the cluster is used. Valid values: `Default`: non-edge scenario cluster. `Edge`: edge scenario cluster. `Serverless`: ASK cluster. Runtime: the runtime type. Valid values: `docker`: Docker runtime. `containerd`: containerd runtime. `Sandboxed-Container.runv`: sandboxed container. KubernetesVersionPrefix: the prefix of the Kubernetes version. AutoSelectLastest: automatically selects the latest version. Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "CSManagedKubernetesClusterServiceCidr": { "Type": "String", "AssociationProperty": "ALIYUN::CS::Cluster::KubernetesVersion", "AssociationPropertyMetadata": { "AutoSelectLastest": true } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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: { "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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}`

ComputeNest resources

AssociationProperty value	Description	Corresponding AssociationPropertyMetadata
ALIYUN::ComputeNest::Artifact::ArtifactId	The information about the Compute Nest artifact.	RegionId: the region ID. By default, the region ID of the stack is used. ArtifactType: the artifact type. Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ComputeNestArtifactArtifactId": { "Type": "String", "AssociationProperty": "ALIYUN::ComputeNest::Artifact::ArtifactId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 artifact.	ArtifactId: the artifact ID. Sample code JSON format: { "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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 Compute Nest service.	RegionId: the region ID. By default, the region ID of the stack is used. InUsed: specifies whether the service is in use. IsVendor: specifies whether the service belongs to a service provider. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ServiceId":{ "AssociationProperty":"ALIYUN::ComputeNest::Service::ServiceId", "Type":"String", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ServiceId: AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId Type: String AssociationPropertyMetadata: RegionId: ${RegionId}` Description In the example for ServiceId, AssociationProperty is set to ALIYUN::ComputeNest::Service::ServiceId. This way, you can query the ID of the Compute Nest service.
ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId	The ID of the Compute Nest service instance.	RegionId: the region ID. By default, the region ID of the stack is used. ServiceType: the type of the Compute Nest service. DeployType: the deployment type. Status: the status of the service. ServiceId: the service ID. Version: the version of the Compute Nest service. IsVendor: specifies whether the Compute Nest service belongs to a service provider. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "ServiceId": { "Type": "String", "AssociationProperty": "ALIYUN::ComputeNest::Service::ServiceId" }, "ServiceInstanceId":{ "AssociationProperty":"ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId", "Type":"String", "AssociationPropertyMetadata": { "ServiceId": "${ServiceId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: ServiceId: Type: String AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId ServiceInstanceId: AssociationProperty: ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId Type: String AssociationPropertyMetadata: ServiceId: ${ServiceId}` Description In the example for ServiceInstanceId, AssociationProperty is set to ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId. This way, you can query the ID of the Compute Nest service instance.
ALIYUN::ComputeNestSupplier::Service::ServiceVersion	The version of the Compute Nest service.	RegionId: the region ID. By default, the region ID of the stack is used. ServiceId: the ID of the Compute Nest service. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "ServiceId": { "Type": "String", "AssociationProperty": "ALIYUN::ComputeNest::Service::ServiceId" }, "ServiceVersion":{ "AssociationProperty":"ALIYUN::ComputeNestSupplier::Service::ServiceVersion", "Type":"String", "AssociationPropertyMetadata": { "ServiceId": "${ServiceId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: ServiceId: Type: String AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId ServiceVersion: AssociationProperty: ALIYUN::ComputeNestSupplier::Service::ServiceVersion Type: String AssociationPropertyMetadata: ServiceId: ${ServiceId}` Description In the example for ServiceVersion, AssociationProperty is set to ALIYUN::ComputeNestSupplier::Service::ServiceVersion. This way, you can query the version of the Compute Nest service.

ComputeNestSupplier resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ComputeNestSupplier::Service::ServiceVersion

The version of the Compute Nest service.

RegionId: the region ID. By default, the region ID of the stack is used.
ServiceId: the ID of the Compute Nest service.

Example:

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "ServiceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ComputeNest::Service::ServiceId"
    },
    "ServiceVersion":{
      "AssociationProperty":"ALIYUN::ComputeNestSupplier::Service::ServiceVersion",
      "Type":"String",
      "AssociationPropertyMetadata": {
        "ServiceId": "${ServiceId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  ServiceId:
    Type: String
    AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId
  ServiceVersion:
    AssociationProperty: ALIYUN::ComputeNestSupplier::Service::ServiceVersion
    Type: String
    AssociationPropertyMetadata:
      ServiceId: ${ServiceId}

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

DNS resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::DNS::Domain::ValidateDomain

Checks 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:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "DNSValidateDomain": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::DNS::Domain::ValidateDomain",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  DNSValidateDomain:
    Type: String
    AssociationProperty: ALIYUN::DNS::Domain::ValidateDomain
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

DashVector resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::DashVector::ApiKey

The API key of AISearch

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "DashVectorApiKey": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::DashVector::ApiKey"
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  DashVectorApiKey:
    Type: String
    AssociationProperty: ALIYUN::DashVector::ApiKey

Domain resources

AssociationProperty value	Description	Corresponding AssociationPropertyMetadata
ALIYUN::Domain::DomainName	Query the information about a 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "DomainName": { "Type": "String", "AssociationProperty": "ALIYUN::Domain::DomainName " } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: DomainName: Type: String AssociationProperty: 'ALIYUN::Domain::DomainName'`

EAS resources

AssociationProperty values

Description

Corresponding 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: the subscription billing method.
- PayAsYouGo: the pay-as-you-go billing method.

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "EASInstanceType": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::EAS::Instance::InstanceType",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "SubscriptionType": "PayAsYouGo"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-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:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "EASResourceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::EAS::Resource::ResourceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  EASResourceId:
    Type: String
    AssociationProperty: ALIYUN::EAS::Resource::ResourceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ECD resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ECD::Bundle::DesktopType

Queries the details of desktop types.

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

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "DesktopType": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECD::Bundle::DesktopType",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  DesktopType:
    Type: String
    AssociationProperty: ALIYUN::ECD::Bundle::DesktopType
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ECI resources

AssociationProperty value	Description	Corresponding 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 has expired. Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ECIContainerGroupId": { "Type": "String", "AssociationProperty": "ALIYUN::ECI::ContainerGroup::ContainerGroupId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}", "Status": "Running" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ECIContainerGroupId: Type: String AssociationProperty: ALIYUN::ECI::ContainerGroup::ContainerGroupId AssociationPropertyMetadata: RegionId: ${RegionId} Status: Running`

ECS resources

EHPC resources

AssociationProperty value	Description	Corresponding 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ClusterId":{ "AssociationProperty":"ALIYUN::EHPC::Cluster::ClusterId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" }, "Type":"String" } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ClusterId: AssociationProperty: ALIYUN::EHPC::Cluster::ClusterId AssociationPropertyMetadata: RegionId: ${RegionId} Type: String` Description In the example for ClusterId, AssociationProperty is set to ALIYUN::EHPC::Cluster::ClusterId. This way, you can query the ID of the 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "FileSystemId":{ "AssociationProperty":"ALIYUN::EHPC::FileSystem::FileSystemId", "Type":"String", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId FileSystemId: AssociationProperty: ALIYUN::EHPC::FileSystem::FileSystemId Type: String AssociationPropertyMetadata: RegionId: ${RegionId}` 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 NAS file system. VpcId: the ID of the virtual private cloud (VPC). VSwitchId: the ID of the vSwitch. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "MountTargetDomain":{ "AssociationProperty":"ALIYUN::EHPC::FileSystem::MountTargetDomain", "Type":"String", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId MountTargetDomain: AssociationProperty: ALIYUN::EHPC::FileSystem::MountTargetDomain Type: String AssociationPropertyMetadata: RegionId: ${RegionId}` 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.

ESS resources

AssociationProperty value	Description	Corresponding AssociationPropertyMetadata
ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId	The ID of the Auto Scaling scaling group.	RegionId: the region ID. By default, the region ID of the stack is used. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "AutoScalingGroupId": { "Type": "String", "AssociationProperty": "ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId AutoScalingGroupId: Type: String AssociationProperty: ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId AssociationPropertyMetadata: RegionId: ${RegionId}` Description In the example for AutoScalingGroupId, AssociationProperty is set to ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId. This allows you to query the ID of the Auto Scaling scaling group.
ALIYUN::ESS::ECIScalingConfiguration::ContainerName	The configurations of the elastic container instance type scaling group.	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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ESSECIScalingConfigurationContainerName": { "Type": "String", "AssociationProperty": "ALIYUN::ESS::ECIScalingConfiguration::ContainerName", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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: { "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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 Auto Scaling scaling configuration.	RegionId: the region ID. By default, the region ID of the stack is used. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ScalingConfigurationId": { "Type": "String", "AssociationProperty": "ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ScalingConfigurationId: Type: String AssociationProperty: ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId AssociationPropertyMetadata: RegionId: ${RegionId}` Description In the example for ScalingConfigurationId, AssociationProperty is set to ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId. This allows you to query the ID of the scaling configuration in Auto Scaling.

Elasticsearch resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::Elasticsearch::Instance::InstanceType

The specifications of the Elasticsearch instance.

Example:

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "Elasticsearch": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Elasticsearch::Instance::InstanceType"
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  Elasticsearch:
    Type: String
    AssociationProperty: ALIYUN::Elasticsearch::Instance::InstanceType

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 resources

AssociationProperty values	Description	Corresponding AssociationPropertyMetadata
ALIYUN::Emr::ECSCluster::ClusterId	Queries 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: data lake OLAP: online analytical processing (OLAP) cluster DATAFLOW: data stream DATASERVING: DataService Studio CUSTOM: custom hybrid cluster HADOOP: Hadoop cluster in the original data lake scenario ClusterStates: an array of cluster states. Valid values: STARTING: The cluster is being started. START_FAILED: The cluster fails to be started. BOOTSTRAPPING: The bootstrap action is being performed on 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 fails to be terminated. PaymentTypes: the billing methods. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ClusterId": { "Type": "String", "AssociationProperty": "ALIYUN::Emr::ECSCluster::ClusterId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}", "PaymentTypes": [ "PayAsYouGo" ] } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ClusterId: Type: String AssociationProperty: ALIYUN::Emr::ECSCluster::ClusterId AssociationPropertyMetadata: RegionId: ${RegionId} PaymentTypes: - PayAsYouGo`

FC3 resources

AssociationProperty value

Description

Corresponding 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:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "FC3FunctionName": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::FC3::Function::FunctionName",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  FC3FunctionName:
    Type: String
    AssociationProperty: ALIYUN::FC3::Function::FunctionName
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

FC resources

AssociationProperty value

Description

Corresponding 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:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "FCFunctionName": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::FC::Function::FunctionName",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-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:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "FCServiceName": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::FC::Service::ServiceName",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  FCServiceName:
    Type: String
    AssociationProperty: ALIYUN::FC::Service::ServiceName
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

Flow resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::Flow::Connection::ConnectionId

The service connections in Apsara 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 is of the string data type. You can obtain this value from Apsara Devops endpoints. For example,
```
https://devops.aliyun.com/organization/[OrganizationId]
```
sericeConnectionType: the type of the service connection.

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-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 organizations 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 organizations whose permission levels are higher than or equal to the lowest permission level.

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-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 resources

AssociationProperty value

Description

Corresponding 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:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "HologresInstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Hologres::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "cmsInstanceType": "standard"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  HologresInstanceId:
    Type: String
    AssociationProperty: ALIYUN::Hologres::Instance::InstanceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      cmsInstanceType: standard

InfluxDB resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::InfluxDB::Instance::InstanceType

The specifications of the TSDB for 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:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-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}

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

Kafka resources

AssociationProperty value

Description

Corresponding 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:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "InstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Kafka::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  InstanceId:
    Type: String
    AssociationProperty: ALIYUN::Kafka::Instance::InstanceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

Lindorm resources

AssociationProperty value

Description

Corresponding 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:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  LindormInstanceId:
    Type: String
    AssociationProperty: ALIYUN::Lindorm::Instance::InstanceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      SupportEngine: 1
      ServiceType: lindorm

MongoDB resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::MongoDB::Instance::InstanceType

The specifications of the ApsaraDB for MongoDB instance.

Example:

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "InstanceType":{
      "AssociationProperty":"ALIYUN::MongoDB::Instance::InstanceType",
      "Type":"String"
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-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 resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::NAS::FileSystem::FileSystemId

Queries the information about a 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:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-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

Queries 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:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-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 resources

AssociationProperty value

Description

Corresponding 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:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "InstanceId":{
      "AssociationProperty":"ALIYUN::NLB::LoadBalancer::LoadBalancerId",
      "Type":"String",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  InstanceId:
    AssociationProperty: ALIYUN::NLB::LoadBalancer::LoadBalancerId
    Type: String
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

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: the random option that is assigned by the system.

Example:

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::NLB::Zone::ZoneId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::NLB::Zone::ZoneId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

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 resources

AssociationProperty value	Description	Corresponding 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "CommandContent": { "Type": "String", "AssociationProperty": "ALIYUN::OOS::Command::CommandContent", "AssociationPropertyMetadata": { "CommandType": "RunPythonScript" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: CommandContent: Type: String AssociationProperty: ALIYUN::OOS::Command::CommandContent AssociationPropertyMetadata: CommandType: RunPythonScript` Description In the example for CommandContent, AssociationProperty is set to ALIYUN::OOS::Command::CommandContent, and CommandType is specified in AssociationPropertyMetadata. This allows you to 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 value of RegionId is the ID of the region in which you deploy the stack. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "TimerTrigger": { "Type": "String", "AssociationProperty": "ALIYUN::OOS::Component::TimerTrigger", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId TimerTrigger: Type: String AssociationProperty: ALIYUN::OOS::Component::TimerTrigger AssociationPropertyMetadata: RegionId: ${RegionId}` Description In the example for TimerTrigger, AssociationProperty is set to ALIYUN::OOS::Component::TimerTrigger, and RegionId is specified in AssociationPropertyMetadata. This allows you to 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "FileUrl": { "Type": "String", "AssociationProperty": "ALIYUN::OOS::File::FileUrl", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId FileUrl: Type: String AssociationProperty: ALIYUN::OOS::File::FileUrl AssociationPropertyMetadata: RegionId: ${RegionId}` Description In the example for FileUrl, AssociationProperty is set to ALIYUN::OOS::File::FileUrl. This allows you to 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "PackageName": { "Type": "String", "AssociationProperty": "ALIYUN::OOS::Package::PackageName", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId PackageName: Type: String AssociationProperty: ALIYUN::OOS::Package::PackageName AssociationPropertyMetadata: RegionId: ${RegionId}` Description In the example for PackageName, AssociationProperty is set to ALIYUN::OOS::Package::PackageName, and RegionId is specified in AssociationPropertyMetadata. This allows you to 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 value of RegionId is the ID of the region in which you deploy the stack. TemplateName: the template name. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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}` Description In the example for PackageVersion, AssociationProperty is set to ALIYUN::OOS::Package::PackageVersion, and RegionId and TemplateName are specified in AssociationPropertyMetadata. This allows you to 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ParameterValue": { "Type": "String", "AssociationProperty": "ALIYUN::OOS::Parameter::Value", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ParameterValue: Type: String AssociationProperty: ALIYUN::OOS::Parameter::Value AssociationPropertyMetadata: RegionId: ${RegionId}` Description In the example for ParameterValue, AssociationProperty is set to ALIYUN::OOS::Parameter::Value, and RegionId is specified in AssociationPropertyMetadata. This allows you to 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 value of RegionId is the ID of the region in which you deploy the stack. Name: the name of the patch baseline. Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "OOSPatchBaselineName": { "Type": "String", "AssociationProperty": "ALIYUN::OOS::PatchBaseline::PatchBaselineName", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 value of RegionId is the ID of the region in which you deploy the stack. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "SecretParameter": { "Type": "String", "AssociationProperty": "ALIYUN::OOS::SecretParameter::Value", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId SecretParameter: Type: String AssociationProperty: ALIYUN::OOS::SecretParameter::Value AssociationPropertyMetadata: RegionId: ${RegionId}` Description In the example for SecretParameter, AssociationProperty is set to ALIYUN::OOS::SecretParameter::Value, and RegionId is specified in AssociationPropertyMetadata. This allows you to query the OOS encryption parameter in the specified region.
ALIYUN::OOS::Template::TemplateName	The OOS template.	RegionId: the region ID. By default, the value of RegionId is the ID of the region in which you deploy the stack. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "TemplateName": { "Type": "String", "AssociationProperty": "ALIYUN::OOS::Template::TemplateName", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId TemplateName: Type: String AssociationProperty: ALIYUN::OOS::Template::TemplateName AssociationPropertyMetadata: RegionId: ${RegionId}` Description In the example for TemplateName, AssociationProperty is set to ALIYUN::OOS::Template::TemplateName, and RegionId is specified in AssociationPropertyMetadata. This allows you to 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 value of RegionId is the ID of the region in which you deploy the stack. TemplateName: the template name. Example: Sample code JSON format: { "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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}` Description In the example for TemplateVersion, AssociationProperty is set to ALIYUN::OOS::Template::TemplateVersion, and RegionId and TemplateName are specified in AssociationPropertyMetadata. This allows you to query the version of the OOS template in the specified region.

OSS resources

AssociationProperty value	Description	Corresponding 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. Examples: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "BucketName": { "Type": "String", "AssociationProperty": "ALIYUN::OSS::Bucket::BucketName", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 allows you to 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. Examples: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "BucketObject": { "Type": "String", "AssociationProperty": "ALIYUN::NLB::Zone::ZoneId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 allows you to 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 name of the bucket. ValueType: the type of the address to be returned. Default value: OSS Url. This value indicates that a complete address is returned, for example: `oss://beijing-test-delete/test.xml`. If you set this parameter to any other value, only the object name is returned, for example: `test.xml`. Examples: Sample code JSON format: { "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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 allows you to 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 name of the bucket. 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. Examples: Sample code JSON format: { "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociatiFormatVersion: 'OOS-2019-06-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 the example for BucketName, AssociationProperty is set to ALIYUN::OSS::Bucket::BucketName, and RegionId and BucketName are specified in AssociationPropertyMetadata. This allows you to query the OSS object in the specified region. In UploadFilesToUserBucket, AssociationProperty is set to UploadFilesToUserBucket, and BucketName is specified in AssociationPropertyMetadata. This allows you to upload objects to the specified bucket.

PolarDB resources

AssociationProperty value

Description

Corresponding 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:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "DBClusterId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::POLARDB::DBCluster::DBClusterId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-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

Queries available resources in a PolarDB cluster.

RegionId: the region ID. By default, the region ID of the stack is used.
ZoneId: the zone ID of the ECS instance.
DBType: the type of the database engine. Valid values:
- MySQL
- PostgreSQL
- Oracle
DBVersion: the version of the database engine.
- Valid values for the MySQL database engine:
  - 5.6
  - 5.7
  - 8.0
- Valid values for the PostgreSQL database engine:
  - 11
  - 14
- Valid values for the Oracle database engine:
  - 11
  - 14
PayType: the billing method.
- Postpaid (default): pay-as-you-go
- Prepaid: subscription

Example:

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-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 resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::RAM::Role

RAM role.

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

Example:

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "Role": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::RAM::Role",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-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

RAM user.

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

Example:

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "User": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::RAM::User",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-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.

RDS resources

AssociationProperty value	Description	Corresponding AssociationPropertyMetadata
ALIYUN::RDS::Engine::EngineId	The database engine type of ApsaraDB RDS.	Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "Engine": { "Type": "String", "AssociationProperty": "ALIYUN::RDS::Engine::EngineId" } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: Engine: Type: String AssociationProperty: ALIYUN::RDS::Engine::EngineId` Description In the example for Engine, AssociationProperty is set to ALIYUN::RDS::Engine::EngineId. This allows you to 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "Engine": { "Type": "String", "AssociationProperty": "ALIYUN::RDS::Engine::EngineId" }, "EngineVersion": { "Type": "String", "AssociationProperty": "ALIYUN::RDS::Engine::EngineVersion", "AssociationPropertyMetadata": { "Engine": "${Engine}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: Engine: Type: String AssociationProperty: ALIYUN::RDS::Engine::EngineId EngineVersion: Type: String AssociationProperty: ALIYUN::RDS::Engine::EngineVersion AssociationPropertyMetadata: Engine: ${Engine}` Description In the example for EngineVersion, AssociationProperty is set to ALIYUN::RDS::Engine::EngineVersion, and Engine is specified in AssociationPropertyMetadata. This allows you to query the version of the ApsaraDB RDS database.
ALIYUN::RDS::Instance::AccountPassword	The password of the ApsaraDB RDS database account.	Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "AccountPassword": { "Type": "String", "AssociationProperty": "ALIYUN::RDS::Instance::AccountPassword" } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: AccountPassword: Type: String AssociationProperty: ALIYUN::RDS::Instance::AccountPassword` Description In the example for AccountPassword, AssociationProperty is set to ALIYUN::RDS::Instance::AccountPassword. This allows you to 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: `{ "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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}` Description In the example for RdsId, AssociationProperty is set to ALIYUN::RDS::Instance::InstanceId, and RegionId and ZoneId are specified in AssociationPropertyMetadata. This allows you to query the list of existing ApsaraDB RDS instances in the specified zone of the available 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 type. EngineVersion: the version of the database engine. DBInstanceClass: the type of the instance. OrderType: the order type. DBInstanceStorageType: the storage type of the instance. DispenseMode: the allocation mode. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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` Description In the example for InstanceType, AssociationProperty is set to ALIYUN::RDS::Instance::InstanceType, and RegionId, Engine, and ZoneId are specified in AssociationPropertyMetadata. This allows you to query the specifications of the ApsaraDB RDS instance of the specified database type in the specified zone.

Redis resources

AssociationProperty value	Description	Corresponding AssociationPropertyMetadata
ALIYUN::Redis::Instance::InstanceId	The ID of the Redis instance.	RegionId: the region ID. By default, the region ID of the stack is used. InstanceType: the category of the instance. ChargeType: the billing method. EditionType: the edition of the instance. InstanceClass: the type of the instance. NetworkType: the network type. InstanceStatus: the status of the instance. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "InstanceId": { "Type": "String", "AssociationProperty": "ALIYUN::Redis::Instance::InstanceId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId InstanceId: Type: String AssociationProperty: ALIYUN::Redis::Instance::InstanceId AssociationPropertyMetadata: RegionId: ${RegionId}` 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 Redis instance in the specified region.
ALIYUN::Redis::Instance::InstanceType	The specifications of the Redis 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 type. ProductType: the service type. OrderType: the order type. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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}` Description In the example for Redis, AssociationProperty is set to ALIYUN::Redis::Instance::InstanceType. This way, you can query the specifications of the Redis instance.

ResourceManager resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ResourceManager::Account

The resource account.

Example:

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "ResourceAccount": {
      "AssociationProperty": "ALIYUN::ResourceManager::Account",
      "Type": "Json",
      "Description": {
        "zh-cn": "Select resource account",
        "en": "ResourceAccount"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  ResourceAccount:
    AssociationProperty: ALIYUN::ResourceManager::Account
    Type: Json
    Description:
      zh-cn: Select resource account
      en: ResourceAccount

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

ALIYUN::ResourceManager::Folder

The resource directory.

Example:

Sample code

JSON format:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "ResourceFolder": {
      "AssociationProperty": "ALIYUN::ResourceManager::Folder",
      "Type": "Json",
      "Description": {
        "zh-cn": "Select resource directory",
        "en": "ResourceFolder"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  ResourceFolder:
    AssociationProperty: ALIYUN::ResourceManager::Folder
    Type: Json
    Description:
      zh-cn: Select resource directory
      en: ResourceFolder

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 resources

AssociationProperty value	Description	Corresponding AssociationPropertyMetadata
ALIYUN::SLB::ACL::ACLId	The access control list (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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "SlbACLId":{ "AssociationProperty":"ALIYUN::SLB::ACL::ACLId", "Type":"String", "AssociationPropertyMetadata": { "RegionId": "${RegionId}", "AddressIPVersion":"${AddressIPVersion}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId SlbACLId: AssociationProperty: ALIYUN::SLB::ACL::ACLId Type: String AssociationPropertyMetadata: RegionId: ${RegionId} AddressIPVersion: ${AddressIPVersion}` Description In the example for SlbACLId, AssociationProperty is set to ALIYUN::SLB::ACL::ACLId, and RegionId is specified in AssociationPropertyMetadata. This allows you to 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 of the ECS instance. InstanceChargeType: the billing method of the instance. SpotStrategy: the bidding policy for the pay-as-you-go instance. Example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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}` Description In the example for InstanceType, AssociationProperty is set to ALIYUN::SLB::Instance::InstanceType, and RegionId and ZoneId are specified in AssociationPropertyMetadata. This allows you to 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 virtual private cloud (VPC) ID. VSwitchId: the vSwitch ID. NetworkType: the network type of the NAT gateway. InstanceChargeType: the billing 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "SlbInstanceId":{ "AssociationProperty":"ALIYUN::SLB::LoadBalancer::LoadBalancerId", "Type":"String", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId SlbInstanceId: AssociationProperty: ALIYUN::SLB::LoadBalancer::LoadBalancerId Type: String AssociationPropertyMetadata: RegionId: ${RegionId}` Description In the example for SlbInstanceId, AssociationProperty is set to ALIYUN::SLB::LoadBalancer::LoadBalancerId, and RegionId is specified in AssociationPropertyMetadata. This allows you to 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "SLBZoneId": { "Type": "String", "AssociationProperty": "ALIYUN::SLB::LoadBalancer::ZoneId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId SLBZoneId: Type: String AssociationProperty: ALIYUN::SLB::LoadBalancer::ZoneId AssociationPropertyMetadata: RegionId: ${RegionId}`

ServiceCatalog resources

AssociationProperty value	Description	Corresponding 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. The following sample code provides an example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "PortfolioId": { "Type": "String", "AssociationProperty": "ALIYUN::ServiceCatalog::LaunchOption::PortfolioId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 product version ID.	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. The following sample code provides an example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ProductVersionId": { "Type": "String", "AssociationProperty": "ALIYUN::ServiceCatalog::ProductVersion::ProductVersionId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::Tag::TagKey

Queries the tag key information.

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:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "TagKey": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Tag::TagKey",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML format:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  TagKey:
    Type: String
    AssociationProperty: ALIYUN::Tag::TagKey
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ALIYUN::Tag::TagValue

Queries the tag values of a specified 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:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-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 resources

AssociationProperty value	Description	Corresponding AssociationPropertyMetadata
ALIYUN::User::Account::AccountIds	The account IDs.	See the following example. Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "AccountIds": { "Type": "String", "AssociationProperty": "ALIYUN::User::Account::AccountIds" } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: AccountIds: Type: String AssociationProperty: ALIYUN::User::Account::AccountIds` 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "MasterAccountId": { "Type": "String", "AssociationProperty": "ALIYUN::User::AccountId" } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: MasterAccountId: Type: String AssociationProperty: ALIYUN::User::AccountId`
ALIYUN::User::UserId	The ID of the current Alibaba Cloud user.	Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "CurrentAccountId": { "Type": "String", "AssociationProperty": "ALIYUN::User::UserId" } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: CurrentAccountId: Type: String AssociationProperty: ALIYUN::User::UserId`

VPC resources

AssociationProperty value	Description	Corresponding 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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "Eip": { "Type": "String", "AssociationProperty": "ALIYUN::VPC::EIP::AllocationId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 virtual private cloud (VPC) ID. InstanceChargeType: the billing method of the instance. NatType: the type of the NAT gateway. NetworkType: the network type of the NAT gateway. The following sample code provides an example: Sample code JSON format: { "FormatVersion": "OOS-2019-06-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: FormatVersion: 'OOS-2019-06-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.	The following sample code provides an example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "CIDR": { "Type": "String", "AssociationProperty": "ALIYUN::VPC::VPC::CidrBlock" } } }` YAML format: `FormatVersion: 'OOS-2019-06-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 virtual private cloud (VPC) ID. VpcCidrBlock: the CIDR block of the VPC. The following sample code provides an example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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 virtual private cloud (VPC) ID. InstanceType: the type of the instance. The following sample code provides an example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-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: `FormatVersion: 'OOS-2019-06-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 active vSwitch in the specified region and zone.
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. The following sample code provides an example: Sample code JSON format: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "RouteTableId": { "Type": "String", "AssociationProperty": "ALIYUN::VPC::VirtualBorderRouter::RouteTableId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-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: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "ZoneId": { "Type": "String", "AssociationProperty": "ALIYUN::VPC::Zone::ZoneId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML format: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ZoneId: Type: String AssociationProperty: ALIYUN::VPC::Zone::ZoneId AssociationPropertyMetadata: RegionId: ${RegionId}`

Operations

Example 1: AssociationProperty example

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

JSON format:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-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

Parameter description:

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 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 example

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 static field cn-hangzhou. VpcId and ZoneId are set to the variables ${VpcId} and ${EcsZone}, which will be dynamically refreshed based on the values selected for ALIYUN::ECS::VPC::VPCId and ZoneId. This establishes the association between the vSwitch and the VPC and zone.

Note

For parameters configured with AllowedValues such as EcsZone, you can add AutoChangeType in AssociationPropertyMetadata and set its value to false. This displays the configuration information of AllowedValues parameters as a dropdown list on the CloudOps Orchestration Service console page.

JSON format:

{
  "FormatVersion": "OOS-2019-06-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:

FormatVersion: 'OOS-2019-06-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}