AssociationProperty and AssociationPropertyMetadata - CloudOps Orchestration Service

In your template's parameter settings, specify AssociationProperty to retrieve resources from the selected region and AssociationPropertyMetadata to add filter conditions. This lets you dynamically select parameter values in the console instead of looking them up across multiple consoles.

Parameters

Values for AssociationPropertyMetadata:

Specify a value for a parameter. For example, for "RegionId": "cn-hangzhou", OOS uses the cn-hangzhou region.
Specify a variable for a parameter in the format ${ParameterKey}. For example, for "VpcId": "${VpcId}", OOS dynamically retrieves the VpcId parameter's value from the current template.
Note
- To treat an expression like ${ParameterKey} as a literal string, add an exclamation mark (!) inside the braces. For example, ${!Literal} evaluates to the literal string ${Literal}.
- If you want to use a parameter variable in a Terraform template, add an additional $ before the $ character. For example, if you specify "VpcId": "$${VpcId}", OOS dynamically retrieves the value of VpcId from the Terraform template.

The AssociationPropertyMetadata varies depending on the resource specified in AssociationProperty.

Custom resource

AssociationProperty value

Description

AssociationPropertyMetadata

ALIYUN::Resource::Data::API

Queries data from the OpenAPI of an Alibaba Cloud product based on specified parameters.

APIAction: Specifies the cloud product and the API operation to call.
OptionsGetter: Specifies the path to the item list in the API response. For example, data.items.
ValueGetter: Specifies the field in each item to use as the parameter's value. For example, classId.
LabelGetter: Specifies the field in each item to use as the display label in the console. For example, name.
PageFilterKeys: Specifies the request parameters used for pagination.
- PageSize: Specifies the API parameter for the page size.
- PageNumber: Specifies the API parameter for the page number.
- TotalCount: Specifies the response field that contains the total count of items.

The following is an example:

Sample code

JSON example:

{
  "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 example:

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

This example configures the PolicyClasses parameter by setting its AssociationProperty to ALIYUN::Resource::Data::API. The AssociationPropertyMetadata then calls the ListPolicyClasses operation of Cloud-native API Gateway (APIG). This enables OOS to query for the policy template ID (classId) and display the policy template name in the console.

Basic resources

Value	Description	AssociationPropertyMetadata
Auto	Operation Orchestration Service (OOS) automatically generates fields such as `AssociationProperty` and `AssociationPropertyMetadata` based on the original Terraform data structure. Note This property applies only to JSON-type parameters in Terraform templates.	`Overwrite`: Supplements or overwrites the definitions of nested parameters. This parameter is optional and is a dictionary data type. It consists of the following components: Key The path to the nested parameter. The path must follow these rules: To represent elements in a list or set, add ``. To represent an item in an object, add the name of the item. Paths use a `.` as a separator. You can omit the `` at the beginning and in the middle. You cannot omit one or more `` at the end. Example: // The path for name is name. // The path for address is address. variable "user_information" { type = object({ name = string address = string }) } // The path for an element in region_ids is . variable "region_ids" { type = list(string) } // The path for internal is .internal, which can be shortened to internal. // The path for external is .external, which can be shortened to external. // The path for protocol is .protocol, which can be shortened to protocol. variable "docker_ports" { type = list(object({ internal = number external = number protocol = string })) } // The path for b is .b, which can be shortened to b. // The path for an element in b is .b., which can be shortened to b.. // The path for c is .c, which can be shortened to c. // The path for d is .c..d, which can be shortened to c.d. // The path for an element in d is .c..d., which can be shortened to c.d.. // The path for e is .e, which can be shortened to e. // The path for an element in e is .e., which can be shortened to e.. // The path for an element in e is .e.., which can be shortened to e... The two trailing asterisks cannot be omitted. // The path for f is .f, which can be shortened to f. // The path for g is .f...g, which can be shortened to f.g. // The path for an element in g is .f...g., which can be shortened to 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 A supplement to the parameter definition. For more information, see Overview.
AutoCompleteInput	Automatically generates a random string.	`CharacterClasses` `Class`: The character type. Valid values: `lowercase` `uppercase` `number` `specialCharacter` `Min`: The minimum number of characters of the specified class. `SpecialCharacters`: The allowed special characters. This parameter applies only when `Class` is set to `specialCharacter`. `Start`: Specifies whether the string can start with a special character. This parameter applies only when `Class` is set to `specialCharacter`. `End`: Specifies whether the string can end with a special character. This parameter applies only when `Class` is set to `specialCharacter`. `Prefix`: The prefix of the string. `Suffix`: The suffix of the string. `Length`: The length of the string. Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "ManagedKubernetesClusterName": { "Type": "String", "Label": { "en": "Managed Kubernetes Cluster Name", "zh-cn": "ACK managed cluster Name" }, "AssociationProperty": "AutoCompleteInput", "AssociationPropertyMetadata": { "Length": 5, "Prefix": "cluster-for-mse-", "Suffix": "-by-OOS", "CharacterClasses": [ { "Class": "lowercase", "min": 1 } ] } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: ManagedKubernetesClusterName: Type: String Label: en: Managed Kubernetes Cluster Name zh-cn: ACK managed cluster Name 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	Used for code input.	None
CommaDelimitedList	An array of comma-separated values.	None
Cron	A cron expression, which is a formatted string that specifies the execution time for a scheduled task.	None
DateTime	A date and time value.	`GMTZone`: The GMT time zone. `TimeZone`: Specifies the time zone. Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "DateTime": { "Type": "String", "AssociationProperty": "DateTime" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: DateTime: Type: String AssociationProperty: DateTime` Example description In this example, setting the `AssociationProperty` of the `DateTime` parameter to `DateTime` allows you to select a date and time.
FileContent	Reads content from a local file.	`AcceptFileSuffixes`: The allowed file suffixes for uploads. Use commas to separate multiple suffixes.
GMTZone	GMT time zone selection.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "GMTZone": { "Type": "String", "AssociationProperty": "GMTZone" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: GMTZone: Type: String AssociationProperty: GMTZone` Example description In this example, setting the `AssociationProperty` of the `GMTZone` parameter to `GMTZone` allows you to select a GMT time zone.
Json	Used for JSON object input.	None
List[Parameter]	A list of parameters, displayed with indentation. This property applies only to `Json` type parameters.	`Parameter`: The parameter definition. For more information, see Overview. Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionIds": { "Label": { "en": "ECS Region Ids", "zh-cn": "ECS Region List" }, "MaxLength": 100, "MinLength": 1, "Type": "Json", "AssociationProperty": "List[Parameter]", "AssociationPropertyMetadata": { "Parameter": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId", "MinLength": 1, "MaxLength": 64 } } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionIds: Label: en: ECS Region Ids zh-cn: ECS Region List 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 indents the display of multiple ECS region IDs in the console.
List[Parameters]	A list of parameter groups, displayed in a table. This property applies only to `Json` type parameters.	`Parameters`: A required dictionary that represents a set of parameter definitions. Key: The parameter name. Value: The parameter definition. For more information, see Overview. Note To ensure proper table display, use simple data types and avoid nesting. Example: Sample code JSON example: { "FormatVersion": "OOS-2019-06-01", "Parameters": { "RenameECS": { "Label": { "en": "Rename ECS", "zh-cn": "Rename ECS" }, "MaxLength": 100, "MinLength": 1, "Type": "Json", "AssociationProperty": "List[Parameters]", "AssociationPropertyMetadata": { "Parameters": { "InstanceId": { "Type": "String", "Label": { "en": "ECS Instance Id", "zh-cn": "ECS Instance ID" }, "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId", "MinLength": 1, "MaxLength": 64 }, "Name": { "Type": "String", "Label": { "en": "New Name", "zh-cn": "New Name" }, "MinLength": 1 } } } } } } YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: RenameECS: Label: en: Rename ECS zh-cn: Rename ECS MaxLength: 100 MinLength: 1 Type: Json AssociationProperty: List[Parameters] AssociationPropertyMetadata: Parameters: InstanceId: Type: String Label: en: ECS Instance Id zh-cn: ECS Instance ID AssociationProperty: ALIYUN::ECS::Instance::InstanceId MinLength: 1 MaxLength: 64 Name: Type: String Label: en: New Name zh-cn: New Name MinLength: 1` Example description In this example, `AssociationProperty` is set to `List[Parameters]` and `AssociationPropertyMetadata` is set to `Parameters`. This displays a table in the console where each row contains fields for an ECS instance ID and a new name. `ListMetadata`: A dictionary data type used to control the table display. `ShowHeader`: Specifies whether to display the table header. The default value is `true`. `ShowRemove`: Specifies whether to display the Remove button. The default value is `true`. `ShowAddition`: Specifies whether to display the Add button. The default value is `true`. `Order`: A list of strings that specifies the order of columns from left to right. By default, all parameters are displayed in alphabetical order.
OOSServiceRole	Specifies the OOS service role.	`RegionId`: The region ID. Defaults to the stack's region. Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "OosServiceRole": { "Type": "String", "AssociationProperty": "OOSServiceRole", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId OosServiceRole: Type: String AssociationProperty: OOSServiceRole AssociationPropertyMetadata: RegionId: ${RegionId}` Example description In this example, setting the `AssociationProperty` of the `OosServiceRole` parameter to `OOSServiceRole` allows you to select the OOS service role.
Password	Used for password input.	None
RateControl	Specifies the execution rate for OOS.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RateControl": { "Type": "String", "AssociationProperty": "RateControl" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: RateControl: Type: String AssociationProperty: RateControl` Example description In this example, setting the `AssociationProperty` of the `RateControl` parameter to `RateControl` configures the OOS execution rate.
Tags	Used for resource tags.	`RegionId`: The region ID. Defaults to the stack's region. `ResourceType`: The resource type used for grouping and statistics. Default value: `ALIYUN::ECS::INSTANCE`. Example: Sample code JSON example: `{ "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 example: `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 this example, `AssociationProperty` is set to `Tags`, and `RegionId` and `ResourceType` are specified in `AssociationPropertyMetadata`. This allows the user to select or enter custom tags for ECS instances.
Targets	ECS instance objects. You can select instances by instance ID, tag, resource group, and more.	`RegionId`: The region ID. Defaults to the stack's region. Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "Targets": { "Type": "String", "AssociationProperty": "Targets", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId Targets: Type: String AssociationProperty: Targets AssociationPropertyMetadata: RegionId: ${RegionId}` Example description In this example, `AssociationProperty` is set to `Targets` and `RegionId` is specified in `AssociationPropertyMetadata`. This provides a UI to select ECS instances from the specified region.
TextArea	Used for rich text input.	None
TimeTriggerWeekly	Selects a time on a weekly basis.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "TimeTriggerWeekly": { "Type": "String", "AssociationProperty": "TimeTriggerWeekly" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: TimeTriggerWeekly: Type: String AssociationProperty: TimeTriggerWeekly` Example description In this example, setting the `AssociationProperty` of the `TimeTriggerWeekly` parameter to `TimeTriggerWeekly` enables weekly time selection.
TimeZone	Time zone selection.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "TimeZone": { "Type": "String", "AssociationProperty": "TimeZone" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: TimeZone: Type: String AssociationProperty: TimeZone` Example description In this example, setting the `AssociationProperty` of the `TimeZone` parameter to `TimeZone` allows you to select the time zone.
None	Displayed with indentation. This property applies only to `Json` type parameters. Note If you specify `AssociationPropertyMetadata` but not `AssociationProperty`, the parameter is displayed with indentation.	`Parameters`: A dictionary data type that represents a set of parameter definitions. Key: The parameter name. Value: The parameter definition. For more information, see Overview. Example: Sample code JSON example: { "FormatVersion": "OOS-2019-06-01", "Parameters": { "RenameECS": { "Label": { "en": "Rename ECS", "zh-cn": "Rename ECS" }, "MaxLength": 100, "MinLength": 1, "Type": "Json", "AssociationPropertyMetadata": { "Parameters": { "InstanceId": { "Type": "String", "Label": { "en": "ECS Instance Id", "zh-cn": "ECS Instance ID" }, "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId", "MinLength": 1, "MaxLength": 64 }, "Name": { "Type": "String", "Label": { "en": "New Name", "zh-cn": "New Name" }, "MinLength": 1 } } } } } } YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: RenameECS: Label: en: Rename ECS zh-cn: Rename ECS MaxLength: 100 MinLength: 1 Type: Json AssociationPropertyMetadata: Parameters: InstanceId: Type: String Label: en: ECS Instance Id zh-cn: ECS Instance ID AssociationProperty: ALIYUN::ECS::Instance::InstanceId MinLength: 1 MaxLength: 64 Name: Type: String Label: en: New Name zh-cn: New Name MinLength: 1` Example description In this example, `AssociationProperty` is not specified, and `AssociationPropertyMetadata` is set to `Parameters`. This indents the group of parameters (such as `ECS instance ID` and `Name`) in the console. `Metadata`: A dictionary data type. For more information, see Metadata. Note You can combine this with `List[Parameter]` to create structures of unlimited nesting depth.

ACR resources

AssociationProperty value	Description	AssociationPropertyMetadata
ALIYUN::ACR::Namespace::Name	Queries container image namespaces.	RegionId: The region ID. Defaults to the region ID of the stack. Status: The namespace status. Valid values: `NORMAL`: Normal. `DELETING`: Being deleted. Sample code JSON example: `{ "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 example: `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	Queries image repositories in ACR Personal Edition.	RegionId: The region ID. Defaults to the region ID of the stack. Sample code JSON example: `{ "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 example: `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	Queries container image tags.	RegionId: The region ID. Defaults to the region ID of the stack. RepoName: The repository name. RepoNamespace: The namespace name. Sample code JSON example: `{ "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 example: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ACRTag: Type: String AssociationProperty: ALIYUN::ACR::Repo::Tag AssociationPropertyMetadata: RegionId: ${RegionId}`

APIG resource

Value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::APIG::Gateway::GatewayId

Retrieves information about a cloud-native gateway.

RegionId: The region ID. Defaults to the region of the stack.
Keyword: A keyword for an exact, case-insensitive search.

Example:

Sample code

JSON example:

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

YAML example:

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

Description

This example sets AssociationProperty to ALIYUN::APIG::Gateway::GatewayId to retrieve the ID of a cloud-native gateway.

Obtain the cloud-native gateway ID.

ALB resources

Value	Description	AssociationPropertyMetadata
ALIYUN::ALB::ACL::ACLId	An ALB access control list (ACL).	`RegionId`: The region ID. By default, the region of the stack is used. Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "RegionId" }, "AlbACLId":{ "AssociationProperty":"ALIYUN::ALB::ACL::ACLId", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" }, "Type":"String" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: RegionId AlbACLId: AssociationProperty: ALIYUN::ALB::ACL::ACLId AssociationPropertyMetadata: RegionId: ${RegionId} Type: String` Description This example sets the `AssociationProperty` of the `AlbACLId` parameter to `ALIYUN::ALB::ACL::ACLId` to retrieve an ALB access control list ID.
ALIYUN::ALB::Instance::InstanceId	The ID of an ALB instance.	`RegionId`: The region ID. By default, the region of the stack is used. `VpcId`: The VPC ID. `AddressType`: The network type. `ZoneId`: The zone ID. `PayType`: The billing method for the load balancer instance. Sample code JSON example: `{ "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 example: `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 This example sets the `AssociationProperty` of the `AlbInstanceId` parameter to `ALIYUN::ALB::Instance::InstanceId` to retrieve an ALB instance ID.
ALIYUN::ALB::LoadBalancer::LoadBalancerId	The ID of an ALB instance.	`RegionId`: The region ID. By default, the region of the stack is used. `VpcId`: The VPC ID. `AddressType`: The network type. `ZoneId`: The zone ID. `PayType`: The billing method for the load balancer instance. Sample code JSON example: `{ "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 example: `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 This example sets the `AssociationProperty` of the `AlbLoadBalancerId` parameter to `ALIYUN::ALB::LoadBalancer::LoadBalancerId` to retrieve an ALB instance ID.

Bailian

Value

Description

AssociationPropertyMetadata

ALIYUN::Bailian::ApiKey::ApiKeyInfo

Retrieves information about an Alibaba Cloud Model Studio API key.

Examples

JSON example:

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

YAML example:

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

BSS resources

AssociationProperty value

Description

AssociationPropertyMetadata

ALIYUN::BSS::PricingModule::ModuleCode

Queries the pricing module information for a specific Alibaba Cloud product.

RegionId: The region ID. Defaults to the stack's region.
ProductCode: The product code.
ProductType: The product type.

SubscriptionType: The billing method. Valid values:
- Subscription: subscription
- PayAsYouGo: pay-as-you-go

Sample code

JSON example:

{
  "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 example:

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	AssociationPropertyMetadata
ALIYUN::CAS::Certificate::CertificateId	The certificate ID for an SLB instance.	RegionId: The ID of the region where the certificate is located. Defaults to the region of the stack. Example: Sample code JSON example: `{ "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 example: `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 this example, the AssociationProperty of the Certificate parameter is set to ALIYUN::CAS::Certificate::CertificateId, and RegionId is specified in AssociationPropertyMetadata. This configuration lets you retrieve a certificate ID for an SLB instance in the specified region.

CEN resources

Value

Description

AssociationPropertyMetadata

ALIYUN::CEN::Instance::CenId

Lists the Cloud Enterprise Network (CEN) instances within the specified resource group.

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

Sample code

JSON example:

{
  "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 example:

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

Lists the transit router instances within the specified CEN instance.

RegionId: The ID of the region. Defaults to the region of the stack.
CenId: The ID of the CEN instance.

Sample code

JSON example:

{
  "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 example:

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

Value	Description	AssociationPropertyMetadata
ALIYUN::CMS::Alarm::MetricSelector	Available CloudMonitor metrics.	Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "CMSMetricSelector": { "Type": "String", "AssociationProperty": "ALIYUN::CMS::Alarm::MetricSelector" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: CMSMetricSelector: Type: String AssociationProperty: ALIYUN::CMS::Alarm::MetricSelector`
ALIYUN::CMS::Alarm::Rule	A threshold-triggered alert rule.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "Rule": { "AssociationProperty": "ALIYUN::CMS::Alarm::Rule", "Type": "String", "Description": { "zh-cn": "选择阈值报警规则", "en": "AlarmRule" } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: Rule: AssociationProperty: ALIYUN::CMS::Alarm::Rule Type: String Description: zh-cn: 选择阈值报警规则 en: AlarmRule` Example description In this example, the `AssociationProperty` for the `Rule` parameter is set to `ALIYUN::CMS::Alarm::Rule`. This lets you select a threshold-triggered alert rule.
ALIYUN::CMS::Alarm::SilenceTime	The silence time for an alert.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "SilenceTime": { "AssociationProperty": "ALIYUN::CMS::Alarm::SilenceTime", "Type": "String", "Description": { "zh-cn": "报警沉默周期", "en": "SilenceTime" } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: SilenceTime: AssociationProperty: ALIYUN::CMS::Alarm::SilenceTime Type: String Description: zh-cn: 报警沉默周期 en: SilenceTime` Example description In this example, the `AssociationProperty` for the `SilenceTime` parameter is set to `ALIYUN::CMS::Alarm::SilenceTime`. This lets you specify the silence time for an alert.
ALIYUN::CMS::Alarm::TriggerResources	Resources that trigger an alert.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "TriggerResources": { "AssociationProperty": "ALIYUN::CMS::Alarm::TriggerResources", "Type": "String", "Description": { "zh-cn": "选择报警资源触发器", "en": "TriggerResources" } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: TriggerResources: AssociationProperty: ALIYUN::CMS::Alarm::TriggerResources Type: String Description: zh-cn: 选择报警资源触发器 en: TriggerResources` Example description In this example, the `AssociationProperty` for the `TriggerResources` parameter is set to `ALIYUN::CMS::Alarm::TriggerResources`. This lets you select the resources that trigger an alert.
ALIYUN::CMS::Event::EventFilterRule	An event-triggered alert rule.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "EventRule": { "AssociationProperty": "ALIYUN::CMS::Event::EventFilterRule", "Type": "String", "Description": { "zh-cn": "选择事件报警规则", "en": "EventRule" } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: EventRule: AssociationProperty: ALIYUN::CMS::Event::EventFilterRule Type: String Description: zh-cn: 选择事件报警规则 en: EventRule` Example description In this example, the `AssociationProperty` for the `EventRule` parameter is set to `ALIYUN::CMS::Event::EventFilterRule`. This lets you select an event-triggered alert rule.
ALIYUN::CMS::Event::EventLevel	The level of an event-triggered alert.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "EventLevel": { "AssociationProperty": "ALIYUN::CMS::Event::EventLevel", "Type": "String", "Description": { "zh-cn": "选择事件报警级别", "en": "EventLevel" } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: EventLevel: AssociationProperty: ALIYUN::CMS::Event::EventLevel Type: String Description: zh-cn: 选择事件报警级别 en: EventLevel` Example description In this example, the `AssociationProperty` for the `EventLevel` parameter is set to `ALIYUN::CMS::Event::EventLevel`. This lets you specify the level for an event-triggered alert.
ALIYUN::CMS::Event::EventName	The name of an event-triggered alert.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "EventName": { "AssociationProperty": "ALIYUN::CMS::Event::EventName", "Type": "String", "Description": { "zh-cn": "选择事件报警名称", "en": "EventName" } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: EventName: AssociationProperty: ALIYUN::CMS::Event::EventName Type: String Description: zh-cn: 选择事件报警名称 en: EventName` Example description In this example, the `AssociationProperty` for the `EventName` parameter is set to `ALIYUN::CMS::Event::EventName`. This lets you specify the name for an event-triggered alert.
ALIYUN::CMS::Product::ProductType	The cloud service for the event-triggered alert rule.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "ProductType": { "AssociationProperty": "ALIYUN::CMS::Product::ProductType", "Type": "String", "Description": { "zh-cn": "选择事件报警名称", "en": "ProductType" } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: ProductType: AssociationProperty: ALIYUN::CMS::Product::ProductType Type: String Description: zh-cn: 选择事件报警名称 en: ProductType` Example description In this example, the `AssociationProperty` for the `ProductType` parameter is set to `ALIYUN::CMS::Product::ProductType`. This lets you select the cloud service for the event-triggered alert rule.

CR resources

AssociationProperty value	Description	AssociationPropertyMetadata
ALIYUN::CR::Instance::InstanceId	Queries Container Registry Enterprise Edition instances.	`RegionId`: The ID of the region. Defaults to the stack's region. `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 example: `{ "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 example: `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	Queries Container Registry Enterprise Edition namespaces.	`RegionId`: The ID of the region. Defaults to the stack's region. `NamespaceStatus`: The status of the namespace. Valid values: `NORMAL`: Normal. `DELETING`: Deleting. `InstanceId`: The ID of the instance. Sample code JSON example: `{ "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 example: `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	Queries Container Registry Enterprise Edition repositories.	`RegionId`: The ID of the region. Defaults to the stack's region. `RepoStatus`: The status of the repository. Valid values: `NORMAL`: Normal. `DELETING`: Deleting. `DELETED`: Deleted. `ALL`: All repository statuses. `InstanceId`: The ID of the instance. Sample code JSON example: `{ "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 example: `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	Queries the tags of a Container Registry Enterprise Edition repository.	`RegionId`: The ID of the region. Defaults to the stack's region. `RepoId`: The ID of the repository. `InstanceId`: The ID of the instance. Sample code JSON example: `{ "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 example: `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	AssociationPropertyMetadata
ALIYUN::CS::Cluster::ClusterId	The ID of an ACK cluster.	`RegionId`: The ID of the region. By default, the region of the stack is used. `ClusterState`: The status of the cluster. Valid values: `running`: The cluster is running. `initial`: The cluster is initializing. `unavailable`: The cluster is unavailable. `all`: Any state. Example: Sample code JSON example: `{ "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 example: `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 this example, setting the `AssociationProperty` of the `ClusterId` parameter to `ALIYUN::CS::Cluster::ClusterId` retrieves the ID of an ACK cluster.
ALIYUN::CS::Cluster::ClusterNodePool	A node pool in an ACK cluster.	`RegionId`: The ID of the region. By default, the region of the stack is used. `ClusterId`: The ID of the ACK cluster. Example: Sample code JSON example: `{ "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 example: `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 this example, setting the `AssociationProperty` of the `ClusterNodePool` parameter to `ALIYUN::CS::Cluster::ClusterNodePool` retrieves a node pool from an ACK cluster.
ALIYUN::CS::Cluster::KubernetesVersion	The Kubernetes versions that are available.	`ClusterType`: The type of cluster. Valid values: `Kubernetes`: An ACK dedicated cluster. `ManagedKubernetes`: An ACK managed cluster. This includes ACK Pro, ACK Basic, ACK Serverless Pro, ACK Serverless Basic, ACK Edge Pro, and ACK Edge Basic clusters. `ExternalKubernetes`: A registered cluster. `Profile`: The cluster profile. Valid values: `Default`: A standard (non-edge) cluster. `Edge`: An edge cluster. `Serverless`: An ASK cluster. `Runtime`: The container runtime. Valid values: `docker`: Docker runtime. `containerd`: containerd runtime. `Sandboxed-Container.runv`: A sandboxed container runtime. `KubernetesVersionPrefix`: The prefix of the Kubernetes version. `AutoSelectLastest`: Specifies whether to automatically select the latest available version. Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "CSManagedKubernetesClusterServiceCidr": { "Type": "String", "AssociationProperty": "ALIYUN::CS::Cluster::KubernetesVersion", "AssociationPropertyMetadata": { "AutoSelectLastest": true } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: CSManagedKubernetesClusterServiceCidr: Type: String AssociationProperty: ALIYUN::CS::Cluster::KubernetesVersion AssociationPropertyMetadata: AutoSelectLastest: true`
ALIYUN::CS::ManagedKubernetesCluster::ServiceCidr	The service CIDR block for an ACK managed cluster.	`RegionId`: The ID of the region. By default, the region of the stack is used. `ClusterType`: The type of cluster. `VpcId`: The ID of the VPC. `NodeCidrMask`: The maximum number of IP addresses that can be assigned to a node. `ContainerCidr`: The container CIDR block. Sample code JSON example: { "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 example: `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}`

Compute Nest resources

Value	Description	AssociationPropertyMetadata
ALIYUN::ComputeNest::Artifact::ArtifactId	The ID of a Compute Nest artifact.	`RegionId`: The region ID. If omitted, the region ID of the stack is used. `ArtifactType`: The artifact type. Example code JSON example: `{ "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 example: `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 version of a Compute Nest artifact.	`ArtifactId`: The artifact ID. Example code JSON example: { "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 example: `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 a Compute Nest service.	`RegionId`: The region ID. If omitted, the region ID of the stack is used. `InUsed`: Indicates whether the service is in use. `IsVendor`: Indicates whether the service is from a service provider. Example: Example code JSON example: `{ "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 example: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ServiceId: AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId Type: String AssociationPropertyMetadata: RegionId: ${RegionId}` Example description In this example, the `AssociationProperty` property of the `ServiceId` parameter is set to `ALIYUN::ComputeNest::Service::ServiceId` to retrieve the service ID.
ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId	The ID of a Compute Nest service instance.	`RegionId`: The region ID. If omitted, the region ID of the stack is used. `ServiceType`: The service type. `DeployType`: The deployment type. Status: The status of the service. `ServiceId`: The service ID. `Version`: The service version. `IsVendor`: Indicates whether the service is from a service provider. Example: Example code JSON example: `{ "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 example: `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}` Example description In this example, the `AssociationProperty` property of the `ServiceInstanceId` parameter is set to `ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId` to retrieve the service instance ID.
ALIYUN::ComputeNestSupplier::Service::ServiceVersion	The version of a Compute Nest service.	`RegionId`: The region ID. If omitted, the region ID of the stack is used. `ServiceId`: The service ID. Example: Example code JSON example: `{ "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 example: `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}` Example description In this example, the `AssociationProperty` property of the `ServiceVersion` parameter is set to `ALIYUN::ComputeNestSupplier::Service::ServiceVersion` to retrieve the service version.

ComputeNestSupplier resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ComputeNestSupplier::Service::ServiceVersion

The Compute Nest service version.

RegionId: The region ID. Defaults to the stack's region.
ServiceId: The service ID.

Example:

Sample code

JSON example:

{
  "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 example:

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

This example sets the AssociationProperty for the ServiceVersion parameter to ALIYUN::ComputeNestSupplier::Service::ServiceVersion to retrieve available service versions for the specified service.

DNS resources

Value

Description

AssociationPropertyMetadata

ALIYUN::DNS::Domain::ValidateDomain

Checks the availability of a domain name for Alibaba Cloud DNS.

RegionId: Defaults to the stack's region.
DomainType: The type of the domain name.

Sample code

JSON example:

{
  "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 example:

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

AssociationPropertyMetadata

ALIYUN::DashVector::ApiKey

The API key for the DashVector vector search service.

Sample code

JSON example:

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

YAML example:

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

Domain resource

AssociationProperty value	Description	AssociationPropertyMetadata
ALIYUN::Domain::DomainName	Queries information about a domain name.	`ShowDomainPrefixInput`: Specifies whether to allow a domain name prefix. `MaxLength`: Maximum length of the domain name. `CheckICP`: Specifies whether to check the ICP filing status. Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "DomainName": { "Type": "String", "AssociationProperty": "ALIYUN::Domain::DomainName" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: DomainName: Type: String AssociationProperty: 'ALIYUN::Domain::DomainName'`

EAS resources

AssociationProperty value

Description

AssociationPropertyMetadata

ALIYUN::EAS::Instance::InstanceType

Available instance types for an Elastic Algorithm Service (EAS) instance.

RegionId: The ID of the region. Defaults to the region of the stack.
SubscriptionType: The billing method. Valid values:
- Subscription: subscription.
- PayAsYouGo: pay-as-you-go.

Sample code

JSON example:

{
  "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 example:

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

Lists EAS resource groups.

RegionId: The ID of the region. Defaults to the region of the stack.

Sample code

JSON example:

{
  "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 example:

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 available desktop types.

RegionId: The ID of the region. Defaults to the region where the stack is located.

Sample code

JSON example:

{
  "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 example:

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

Value	Description	Associated metadata
ALIYUN::ECI::ContainerGroup::ContainerGroupId	Queries ECI container groups.	`RegionId`: The ID of the region. Defaults to the stack's region. `VSwitchId`: The instance's vSwitch ID. `ZoneId`: The instance's zone ID. `SecurityGroupId`: The instance's security group ID. `ComputeCategory`: The computing power type. `Status`: The status of the container group. Valid values: `Pending`: The container group is starting. `Running`: The container group is running. `Succeeded`: The container group ran successfully. `Failed`: The container group failed to run. `Scheduling`: The container group is being scheduled. `ScheduleFailed`: The container group failed to be scheduled. `Restarting`: The container group is restarting. `Updating`: The container group is being updated. `Terminating`: The container group is being terminated. `Expired`: The container group has expired. Examples JSON example: `{ "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 example: `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	Description	AssociationPropertyMetadata
ALIYUN::EHPC::Cluster::ClusterId	The ID of the EHPC cluster.	`RegionId`: The region ID. Defaults to the region of the stack. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `ClusterId` parameter is set to `ALIYUN::EHPC::Cluster::ClusterId`. This lets you select an EHPC cluster.
ALIYUN::EHPC::FileSystem::FileSystemId	The ID of the file system.	`RegionId`: The region ID. Defaults to the region of the stack. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `FileSystemId` parameter is set to `ALIYUN::EHPC::FileSystem::FileSystemId`. This lets you select an EHPC file system.
ALIYUN::EHPC::FileSystem::MountTargetDomain	The mount target.	`RegionId`: The region ID. Defaults to the region of the stack. `VolumeId`: The NAS file system ID. `VpcId`: The VPC ID. `VSwitchId`: The vSwitch ID. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `MountTargetDomain` parameter is set to `ALIYUN::EHPC::FileSystem::MountTargetDomain`. This lets you select an EHPC mount target.

ESS resources

Value	Description	AssociationPropertyMetadata
ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId	The ID of an Auto Scaling group.	RegionId: The region ID. Defaults to the region where the stack resides. Example: Sample code JSON example: `{ "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 example: `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 Setting the `AssociationProperty` of the `AutoScalingGroupId` parameter to `ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId` retrieves the ID of an Auto Scaling group.
ALIYUN::ESS::ECIScalingConfiguration::ContainerName	The name of a container in an ECI scaling configuration.	RegionId: The region ID. Defaults to the region where the stack resides. ScalingGroupId: The scaling group ID. ScalingConfigurationId: The scaling configuration ID. Sample code JSON example: `{ "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 example: `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 an ECI scaling configuration.	RegionId: The region ID. Defaults to the region where the stack resides. ScalingGroupId: The scaling group ID. AutoSelectFirst: If set to true, automatically selects the first configuration. Sample code JSON example: { "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 example: `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 a scaling configuration.	RegionId: The region ID. Defaults to the region where the stack resides. Example: Sample code JSON example: `{ "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 example: `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 Setting the `AssociationProperty` of the `ScalingConfigurationId` parameter to `ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId` retrieves the ID of a scaling configuration.

Elasticsearch resources

Value

Description

AssociationPropertyMetadata

ALIYUN::Elasticsearch::Instance::InstanceType

The Elasticsearch instance type.

Example:

Sample code

JSON example:

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

YAML example:

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

Description

Setting the AssociationProperty of the Elasticsearch parameter to ALIYUN::Elasticsearch::Instance::InstanceType retrieves available Elasticsearch instance types.

EMR resources

AssociationProperty value	Description	AssociationPropertyMetadata
ALIYUN::Emr::ECSCluster::ClusterId	Queries E-MapReduce (EMR) clusters.	`RegionId`: The region ID. Defaults to the stack's region. `ClusterTypes`: A list of cluster types. Valid values: `DATALAKE`: New data lake. `OLAP`: Online analytical processing (OLAP). `DATAFLOW`: Real-time data flow. `DATASERVING`: Data serving. `CUSTOM`: Custom hybrid cluster. `HADOOP`: Legacy data lake. `ClusterStates`: A list of cluster states. Valid values: `STARTING`: The cluster is starting. `START_FAILED`: The cluster failed to start. `BOOTSTRAPPING`: The cluster is performing bootstrap actions. `RUNNING`: The cluster is running. `TERMINATING`: The cluster is terminating. `TERMINATED`: The cluster has terminated. `TERMINATED_WITH_ERRORS`: The cluster terminated with errors. `TERMINATE_FAILED`: The cluster failed to terminate. `PaymentTypes`: The billing method. Valid values: `Subscription`: The subscription billing method. `PayAsYouGo`: The pay-as-you-go billing method. Sample code JSON example: `{ "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 example: `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

Value

Description

AssociationPropertyMetadata parameters

ALIYUN::FC3::Function::FunctionName

Lists Function Compute functions.

RegionId: The region ID. Defaults to the region of the stack.
Prefix: The function name prefix.

Sample code

JSON example:

{
  "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 example:

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

AssociationPropertyMetadata

ALIYUN::FC::Function::FunctionName

Queries functions in legacy Function Compute.

RegionId: The region ID. Defaults to the stack's region.
Prefix: The function name prefix.
ServiceName: The name of the service containing the function.
Qualifier: The service version or alias.
StartKey: The starting position for the query. Results are returned in alphabetical order, beginning with and including this key.

Sample code

JSON example:

{
  "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 example:

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

Queries services in legacy Function Compute.

RegionId: The region ID. Defaults to the stack's region.
Prefix: The service name prefix.
StartKey: The starting position for the query. Results are returned in alphabetical order, beginning with and including this key.

Sample code

JSON example:

{
  "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 example:

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

Value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::Flow::Connection::ConnectionId

Gets a list of service connections in Alibaba Cloud DevOps.

RegionId: The region ID. Defaults to the region of the stack.
organizationId: The organization ID. Get this ID from your Alibaba Cloud DevOps organization URL. For example,
```
https://devops.aliyun.com/organization/[OrganizationId]
```
sericeConnectionType: The service connection type.

Sample code

JSON example:

{
  "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 example:

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

Gets a list of organizations for the current user.

RegionId: The region ID. Defaults to the region of the stack.
accessLevel: The access level.
minAccessLevel: The minimum access level. Gets organizations where the user's access level is greater than or equal to this value.

Sample code

JSON example:

{
  "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 example:

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

Association property

Description

Association property metadata

ALIYUN::Hologres::Instance::InstanceId

Retrieves Hologres instance IDs.

RegionId: The region ID. Defaults to the stack's region.
cmsInstanceType: The CloudMonitor instance type. Valid values:
- standard
- follower
- mc-acceleration
- warehouse
- high-memory

Examples

JSON example:

{
  "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 example:

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 instance type for TSDB for InfluxDB®.

RegionId: The region ID. Defaults to the region where the stack is deployed.
ZoneId: The zone ID.

Example:

Sample code

JSON example:

{
  "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 example:

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

This example sets the AssociationProperty for the InfluxDB parameter to ALIYUN::InfluxDB::Instance::InstanceType. This lets you retrieve the available instance types for TSDB for InfluxDB®.

Kafka

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::Kafka::Instance::InstanceId

Lists the ApsaraMQ for Kafka instances in a specified region.

RegionId: The region ID. Defaults to the stack's region.
OrderId: The order ID.

Sample code

JSON example:

{
  "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 example:

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

Value

Description

AssociationPropertyMetadata

ALIYUN::Lindorm::Instance::InstanceId

Lists Lindorm instances.

RegionId: The region to query for instances. Defaults to the stack's region.

SupportEngine: Filters the instances by data engine. Valid values:
- 1: LindormSearch
- 2: LindormTSDB
- 4: LindormTable
- 8: LindormDFS
ServiceType: Filters the instances by service type. Valid values:
- lindorm: An instance deployed in a single zone.
- lindorm_multizone: An instance deployed across multiple zones.
- serverless_lindorm: A Lindorm Serverless instance.
- lindorm_standalone: A single-node Lindorm instance.
- lts: A Lindorm Tunnel Service (LTS) instance.

Examples

JSON example:

{
  "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 example:

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

Value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::MongoDB::Instance::InstanceType

Available instance types for an ApsaraDB for MongoDB instance.

Example:

Sample code

JSON example:

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

YAML example:

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

Example description

This example sets the AssociationProperty for the InstanceType parameter to ALIYUN::MongoDB::Instance::InstanceType to retrieve the available instance types for an ApsaraDB for MongoDB instance.

NAS resources

Value

Description

AssociationPropertyMetadata

ALIYUN::NAS::FileSystem::FileSystemId

Retrieves a list of file systems.

RegionId: The ID of the region. Defaults to the stack's region.

FileSystemType: The type of the file system. Valid values:
- all (default): All types.
- standard: general-purpose NAS.
- extreme: extreme NAS.
- cpfs: Cloud Parallel File Storage (CPFS).

VpcId: The ID of the VPC.

Sample code

JSON example:

{
  "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 example:

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

Retrieves a list of mount target domains.

RegionId: The ID of the region. Defaults to the stack's region.
FileSystemId: The ID of the file system.

Sample code

JSON example:

{
  "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 example:

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

Value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::NLB::LoadBalancer::LoadBalancerId

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

RegionId: The ID of the region. By default, it uses the stack's region.
VpcIds: A list of VPC IDs.
AddressType: The network type.
ZoneId: The ID of the zone.

Example:

Sample code

JSON example:

{
  "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 example:

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

This example sets the AssociationProperty of the InstanceId parameter to ALIYUN::NLB::LoadBalancer::LoadBalancerId to retrieve an NLB instance ID.

ALIYUN::NLB::Zone::ZoneId

The available zones for Network Load Balancer (NLB).

RegionId: The ID of the region. By default, it uses the stack's region.
ShowRandom: Specifies whether to display the random assignment option.

Example:

Sample code

JSON example:

{
  "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 example:

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

This example sets the AssociationProperty for the ZoneId parameter to ALIYUN::NLB::Zone::ZoneId and specifies the RegionId in AssociationPropertyMetadata to retrieve the available NLB zones in the specified region.

OOS

AssociationProperty value	Description	AssociationPropertyMetadata
ALIYUN::OOS::Command::CommandContent	An Operation Orchestration Service (OOS) execution script.	CommandType: The command type. Valid values: RunBatScript RunPowerShellScript RunShellScript RunPythonScript RunPerlScript Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "CommandContent": { "Type": "String", "AssociationProperty": "ALIYUN::OOS::Command::CommandContent", "AssociationPropertyMetadata": { "CommandType": "RunPythonScript" } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: CommandContent: Type: String AssociationProperty: ALIYUN::OOS::Command::CommandContent AssociationPropertyMetadata: CommandType: RunPythonScript` Description In this example, the `AssociationProperty` for the `CommandContent` parameter is set to `ALIYUN::OOS::Command::CommandContent`, and `CommandType` is specified in `AssociationPropertyMetadata`. This lets you run an OOS execution script.
ALIYUN::OOS::Component::TimerTrigger	An OOS time trigger.	RegionId: The region ID. Defaults to the stack's region. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `TimerTrigger` parameter is set to `ALIYUN::OOS::Component::TimerTrigger`, and `RegionId` is specified in `AssociationPropertyMetadata`. This lets you configure an OOS time trigger.
ALIYUN::OOS::File::FileUrl	The URL for uploading a file.	RegionId: The region ID. Defaults to the stack's region. FileType: The source type of the file. Valid values: `local`, `https`, `github`, and `oss`. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `FileUrl` parameter is set to `ALIYUN::OOS::File::FileUrl`, which lets you upload a file to Object Storage Service (OSS).
ALIYUN::OOS::Package::PackageName	The name of an OOS software package.	RegionId: The region ID. Defaults to the stack's region. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `PackageName` parameter is set to `ALIYUN::OOS::Package::PackageName`, and `RegionId` is specified in `AssociationPropertyMetadata`. This lets you retrieve information about an OOS software package in the specified region.
ALIYUN::OOS::Package::PackageVersion	The version of an OOS software package.	RegionId: The region ID. Defaults to the stack's region. TemplateName: The template name. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `PackageVersion` parameter is set to `ALIYUN::OOS::Package::PackageVersion`, and `RegionId` and `TemplateName` are specified in `AssociationPropertyMetadata`. This lets you retrieve version information about an OOS software package in the specified region.
ALIYUN::OOS::Parameter::Value	An OOS common parameter.	RegionId: The region ID. Defaults to the stack's region. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `ParameterValue` parameter is set to `ALIYUN::OOS::Parameter::Value`, and `RegionId` is specified in `AssociationPropertyMetadata`. This lets you retrieve information about an OOS common parameter in the specified region.
ALIYUN::OOS::PatchBaseline::PatchBaselineName	An OOS patch baseline.	RegionId: The region ID. Defaults to the stack's region. Name: The name of the patch baseline. Sample code JSON example: `{ "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 example: `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	An OOS secret parameter.	RegionId: The region ID. Defaults to the stack's region. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `SecretParameter` parameter is set to `ALIYUN::OOS::SecretParameter::Value`, and `RegionId` is specified in `AssociationPropertyMetadata`. This lets you retrieve information about an OOS secret parameter in the specified region.
ALIYUN::OOS::Template::TemplateName	An OOS template.	RegionId: The region ID. Defaults to the stack's region. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `TemplateName` parameter is set to `ALIYUN::OOS::Template::TemplateName`, and `RegionId` is specified in `AssociationPropertyMetadata`. This lets you retrieve information about an OOS template in the specified region.
ALIYUN::OOS::Template::TemplateVersion	The version of an OOS template.	RegionId: The region ID. Defaults to the stack's region. TemplateName: The template name. The following is an example: Sample code JSON example: { "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 example: `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}` Example description In this example, the `AssociationProperty` of the `TemplateVersion` parameter is set to `ALIYUN::OOS::Template::TemplateVersion`. The `AssociationPropertyMetadata` is set to `RegionId` and `TemplateName`. These settings retrieve the OOS template version information for the current region.

OSS resources

Value	Description	AssociationPropertyMetadata
ALIYUN::OSS::Bucket::BucketName	The name of an OSS bucket.	`RegionId`: The region ID. Defaults to the stack's region. Example: Sample code JSON example: `{ "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 example: `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 this example, `AssociationProperty` for the `BucketName` parameter is set to `ALIYUN::OSS::Bucket::BucketName`, and `RegionId` is specified in `AssociationPropertyMetadata`. This retrieves OSS buckets from the specified region.
ALIYUN::OSS::Bucket::Object	An OSS object.	`RegionId`: The region ID. Defaults to the stack's region. `ObjectType`: The object's storage class. `ValueType`: The value type of the object. Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "RegionId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::RegionId" }, "BucketObject": { "Type": "String", "AssociationProperty": "ALIYUN::OSS::Bucket::Object", "AssociationPropertyMetadata": { "RegionId": "${RegionId}" } } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId BucketObject: Type: String AssociationProperty: ALIYUN::OSS::Bucket::Object AssociationPropertyMetadata: RegionId: ${RegionId}` Example description In this example, `AssociationProperty` for the `BucketObject` parameter is set to `ALIYUN::OSS::Bucket::Object`, and `RegionId` is specified in `AssociationPropertyMetadata`. This retrieves OSS objects from the specified region.
ALIYUN::OSS::Object::ObjectName	The name of an OSS object.	`RegionId`: The region ID. Defaults to the stack's region. `BucketName`: The name of the bucket. `ValueType`: The format of the returned address. Defaults to `OSS Url`, which returns the full address. 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`. Example: Sample code JSON example: { "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": "ObjectName" } } } } YAML example: `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: ObjectName` Example description In this example, `AssociationProperty` for the `ObjectName` parameter is set to `ALIYUN::OSS::Object::ObjectName`, and `RegionId` and `BucketName` are specified in `AssociationPropertyMetadata`. This retrieves OSS objects from the specified bucket.
UploadFilesToUserBucket	An OSS file upload component.	`Mode`: The display mode of the component. Valid values: `normal` `dragger` (default) `RegionId`: The bucket's region. Defaults to the current environment's region. Ensure this region matches the region of the specified bucket. `BucketName`: The name of the bucket. `Multiple`: Whether to allow uploading multiple objects at once. Valid value: `true` `Directory`: Whether to allow uploading folders. Valid value: `true` `ValueType`: The format of the returned value. Defaults to `OSS Url`. `ObjectNamePrefix`: Specifies a prefix for the names of the uploaded objects. This prefix functions as a path. `AddSuffix`: Whether to append a timestamp suffix to uploaded object names. Valid value: `true` `SuffixFormat`: The format of the timestamp suffix. Example: `YYYY-MM-DD`. Example: Sample code JSON example: { "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 example: `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` Example description In this example, the `AssociationProperty` for the `BucketName` parameter is set to `ALIYUN::OSS::Bucket::BucketName` to select an OSS bucket. For the `UploadFilesToUserBucket` parameter, `AssociationProperty` is set to `UploadFilesToUserBucket` and `BucketName` is specified in `AssociationPropertyMetadata` to upload objects to the selected bucket.

PolarDB resources

Value

Description

Association property metadata

ALIYUN::PolarDB::DBCluster::DBClusterId

The ID of a PolarDB cluster.

RegionId: The ID of the region. The default is the stack's region.

Example:

Sample code

JSON example:

{
  "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 example:

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 this example, the AssociationProperty for the DBClusterId parameter is set to ALIYUN::POLARDB::DBCluster::DBClusterId, and RegionId is specified in AssociationPropertyMetadata. This configuration retrieves the IDs of PolarDB clusters from the specified region.

ALIYUN::PolarDB::DBCluster::DBNodeClass

The available node classes for a PolarDB cluster.

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

Example:

Sample code

JSON example:

{
  "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 example:

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

Value

Description

AssociationPropertyMetadata

ALIYUN::RAM::Role

A RAM role.

RegionId: The region ID (defaults to the stack's region).

Example:

Sample code

JSON example:

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

YAML example:

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

Description

In this example, the AssociationProperty for the Role parameter is set to ALIYUN::RAM::Role, and RegionId is specified in AssociationPropertyMetadata. This lets you retrieve RAM roles in the specified region.

ALIYUN::RAM::User

A RAM user.

RegionId: The region ID (defaults to the stack's region).

Example:

Sample code

JSON example:

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

YAML example:

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

Description

In this example, the AssociationProperty for the User parameter is set to ALIYUN::RAM::User, and RegionId is specified in AssociationPropertyMetadata. This lets you retrieve RAM users in the specified region.

RDS resources

AssociationProperty	Description	AssociationPropertyMetadata
ALIYUN::RDS::Engine::EngineId	The database engine for an ApsaraDB RDS instance.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "Engine": { "Type": "String", "AssociationProperty": "ALIYUN::RDS::Engine::EngineId" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: Engine: Type: String AssociationProperty: ALIYUN::RDS::Engine::EngineId` Description In this example, the `AssociationProperty` for the `Engine` parameter is set to `ALIYUN::RDS::Engine::EngineId`. This retrieves the available database engines for ApsaraDB RDS.
ALIYUN::RDS::Engine::EngineVersion	The database engine version for an ApsaraDB RDS instance.	`Engine`: The database engine. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `EngineVersion` parameter is set to `ALIYUN::RDS::Engine::EngineVersion`, and `Engine` is specified in `AssociationPropertyMetadata`. This retrieves the available versions for the specified ApsaraDB RDS database engine.
ALIYUN::RDS::Instance::AccountPassword	The password for an ApsaraDB RDS database account.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "AccountPassword": { "Type": "String", "AssociationProperty": "ALIYUN::RDS::Instance::AccountPassword" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: AccountPassword: Type: String AssociationProperty: ALIYUN::RDS::Instance::AccountPassword` Description In this example, setting the `AssociationProperty` of the `AccountPassword` parameter to `ALIYUN::RDS::Instance::AccountPassword` provides a password input component.
ALIYUN::RDS::Instance::InstanceId	The ID of an ApsaraDB RDS instance.	`RegionId`: The region ID. By default, the region of the stack is used. `ZoneId`: The zone ID. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `RdsId` parameter is set to `ALIYUN::RDS::Instance::InstanceId`, and `RegionId` and `ZoneId` are specified in `AssociationPropertyMetadata`. This retrieves a list of existing ApsaraDB RDS instances in the specified zone and region.
ALIYUN::RDS::Instance::InstanceType	The ApsaraDB RDS instance type.	`RegionId`: The region ID. By default, the region of the stack is used. `ZoneId`: The zone ID. `InstanceChargeType`: The billing method for the instance. `Category`: The instance series. `Engine`: The database engine. `EngineVersion`: The database engine version. `DBInstanceClass`: The instance type. `OrderType`: The order type. `DBInstanceStorageType`: The instance storage type. `DispenseMode`: The allocation mode. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `InstanceType` parameter is set to `ALIYUN::RDS::Instance::InstanceType`, and `RegionId`, `Engine`, and `ZoneId` are specified in `AssociationPropertyMetadata`. This retrieves the available ApsaraDB RDS instance types for the specified database engine in the selected zone.

Redis

AssociationProperty value	Description	AssociationPropertyMetadata
ALIYUN::Redis::Instance::InstanceId	The Redis instance ID.	`RegionId`: The region ID. Defaults to the stack's region. `InstanceType`: The instance type. `ChargeType`: The charge type. `EditionType`: The instance edition. `InstanceClass`: The instance class. `NetworkType`: The network type. `InstanceStatus`: The instance status. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `InstanceId` parameter is set to `ALIYUN::Redis::Instance::InstanceId`, and `RegionId` is specified in `AssociationPropertyMetadata`. This allows you to retrieve the Redis instance IDs in the specified region.
ALIYUN::Redis::Instance::InstanceType	The Redis instance types.	`RegionId`: The region ID. Defaults to the stack's region. `ZoneId`: The zone ID. `InstanceChargeType`: The instance charge type. `Engine`: The database type. `ProductType`: The service type. `OrderType`: The order type. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `Redis` parameter is set to `ALIYUN::Redis::Instance::InstanceType`. This allows you to retrieve available Redis instance types.

ResourceManager resources

Value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ResourceManager::Account

A resource account.

Example:

Sample code

JSON example:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "ResourceAccount": {
      "AssociationProperty": "ALIYUN::ResourceManager::Account",
      "Type": "Json",
      "Description": {
        "zh-cn": "选择资源账号",
        "en": "ResourceAccount"
      }
    }
  }
}

YAML example:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  ResourceAccount:
    AssociationProperty: ALIYUN::ResourceManager::Account
    Type: Json
    Description:
      zh-cn: 选择资源账号
      en: ResourceAccount

Example description

In the example, the AssociationProperty for the ResourceAccount parameter is set to ALIYUN::ResourceManager::Account. This lets you retrieve accounts from the resource directory.

ALIYUN::ResourceManager::Folder

A resource folder.

Example:

Sample code

JSON example:

{
  "FormatVersion": "OOS-2019-06-01",
  "Parameters": {
    "ResourceFolder": {
      "AssociationProperty": "ALIYUN::ResourceManager::Folder",
      "Type": "Json",
      "Description": {
        "zh-cn": "选择资源目录",
        "en": "ResourceFolder"
      }
    }
  }
}

YAML example:

FormatVersion: 'OOS-2019-06-01'
Parameters:
  ResourceFolder:
    AssociationProperty: ALIYUN::ResourceManager::Folder
    Type: Json
    Description:
      zh-cn: 选择资源目录
      en: ResourceFolder

Example description

In the example, the AssociationProperty for the ResourceFolder parameter is set to ALIYUN::ResourceManager::Folder. This lets you retrieve folders from the current account's resource directory.

SLB

AssociationProperty value	Description	AssociationPropertyMetadata
ALIYUN::SLB::ACL::ACLId	The ID of an SLB access control list (ACL).	RegionId: The region ID. Defaults to the region of the stack. AddressIPVersion: The IP address type. Example: Sample code JSON example: `{ "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 example: `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 this example, the AssociationProperty for the SlbACLId parameter is set to ALIYUN::SLB::ACL::ACLId and RegionId is specified in AssociationPropertyMetadata. This lets you select an SLB access control list (ACL) from the specified region.
ALIYUN::SLB::Instance::InstanceType	The SLB instance type.	RegionId: The region ID. Defaults to the region of the stack. ZoneId: The zone ID. InstanceChargeType: The instance charge type. SpotStrategy: The spot strategy for a pay-as-you-go instance. Example: Sample code JSON example: `{ "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 example: `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 this example, the AssociationProperty for the InstanceType parameter is set to ALIYUN::SLB::Instance::InstanceType, and RegionId and ZoneId are specified in AssociationPropertyMetadata. This lets you select from the available SLB instance types in the specified zone.
ALIYUN::SLB::LoadBalancer::LoadBalancerId	The SLB instance ID.	RegionId: The region ID. Defaults to the region of the stack. VpcId: The VPC ID. VSwitchId: The vSwitch ID. NetworkType: The network type of the SLB instance. InstanceChargeType: The instance charge type. AddressType: The address type of the SLB instance. MasterZoneId: The ID of the primary zone for the SLB instance. SlaveZoneId: The ID of the secondary zone for the SLB instance. PayType: The charge type of the SLB instance. Example: Sample code JSON example: `{ "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 example: `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 this example, the AssociationProperty for the SlbInstanceId parameter is set to ALIYUN::SLB::LoadBalancer::LoadBalancerId and RegionId is specified in AssociationPropertyMetadata. This lets you select an SLB instance from the specified region.
ALIYUN::SLB::LoadBalancer::ZoneId	The available zones for an SLB instance.	RegionId: The region ID. Defaults to the region of the stack. MasterZoneId: The ID of the primary zone. ZoneType: The zone type. Master: The primary zone (default). Slave: The secondary zone. Sample code JSON example: `{ "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 example: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId SLBZoneId: Type: String AssociationProperty: ALIYUN::SLB::LoadBalancer::ZoneId AssociationPropertyMetadata: RegionId: ${RegionId}`

Service catalog

AssociationProperty	Description	AssociationPropertyMetadata
ALIYUN::ServiceCatalog::LaunchOption::PortfolioId	The ID of a Service Catalog portfolio.	RegionId: The region ID. Defaults to the stack's region. ProductId: The product ID. Example: Sample code JSON example: `{ "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 example: `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 this example, the AssociationProperty for the PortfolioId parameter is set to ALIYUN::ServiceCatalog::LaunchOption::PortfolioId, and RegionId is specified in AssociationPropertyMetadata. This lets you select the ID of a Service Catalog portfolio from the specified region.
ALIYUN::ServiceCatalog::ProductVersion::ProductVersionId	The product version ID.	RegionId: The region ID. Defaults to the stack's region. ProductId: The product ID. Active: Indicates if the product version is active. Example: Sample code JSON example: `{ "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 example: `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 this example, the AssociationProperty for the ProductVersionId parameter is set to ALIYUN::ServiceCatalog::ProductVersion::ProductVersionId, and RegionId is specified in AssociationPropertyMetadata. This lets you select a Service Catalog product version ID from the specified region.

Tagging resources

Association property

Description

Association property metadata

ALIYUN::Tag::TagKey

Queries available tag keys.

RegionId: The region ID. Defaults to the stack's region.
ResourceType: The resource type.
ShowSystem: Whether to filter system tags.

Sample code

JSON example:

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

YAML example:

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

Retrieves the tag values for a specified tag key.

RegionId: The region ID. Defaults to the stack's region.
ResourceType: The resource type.
Key: The tag key.

Sample code

JSON example:

{
  "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 example:

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	AssociationPropertyMetadata
ALIYUN::User::Account::AccountIds	User account IDs.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "AccountIds": { "Type": "String", "AssociationProperty": "ALIYUN::User::Account::AccountIds" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: AccountIds: Type: String AssociationProperty: ALIYUN::User::Account::AccountIds` Description In this example, the `AssociationProperty` of the `AccountIds` parameter is set to `ALIYUN::User::Account::AccountIds` to retrieve the account IDs.
ALIYUN::User::AccountId	Gets the Alibaba Cloud main account ID.	Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "MasterAccountId": { "Type": "String", "AssociationProperty": "ALIYUN::User::AccountId" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: MasterAccountId: Type: String AssociationProperty: ALIYUN::User::AccountId`
ALIYUN::User::UserId	Gets the current Alibaba Cloud user ID.	Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "CurrentAccountId": { "Type": "String", "AssociationProperty": "ALIYUN::User::UserId" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: CurrentAccountId: Type: String AssociationProperty: ALIYUN::User::UserId`

VPC

Value	Description	AssociationPropertyMetadata
ALIYUN::VPC::EIP::AllocationId	Lists available EIPs.	`RegionId`: The region ID. Defaults to the stack's region. Sample code JSON example: `{ "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 example: `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 a NAT gateway.	`RegionId`: The region ID. Defaults to the stack's region. `ZoneId`: The zone ID. `VpcId`: The VPC ID. `InstanceChargeType`: The instance charge type. `NatType`: The NAT gateway type. `NetworkType`: The NAT gateway network type. Example: Sample code JSON example: { "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 example: 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 this example, the `AssociationProperty` for the `NatGateway` parameter is set to `ALIYUN::VPC::NatGateway::NatGatewayId`. The `AssociationPropertyMetadata` properties—`RegionId`, `ZoneId`, `VpcId`, `InstanceChargeType`, `NatType`, and `NetworkType`—are used to retrieve the IDs of matching NAT gateways.
ALIYUN::VPC::VPC::CidrBlock	The CIDR block for a new VPC.	Example: Sample code JSON example: `{ "FormatVersion": "OOS-2019-06-01", "Parameters": { "CIDR": { "Type": "String", "AssociationProperty": "ALIYUN::VPC::VPC::CidrBlock" } } }` YAML example: `FormatVersion: 'OOS-2019-06-01' Parameters: CIDR: Type: String AssociationProperty: ALIYUN::VPC::VPC::CidrBlock` Example description In this example, the `AssociationProperty` for the `CIDR` parameter is set to `ALIYUN::VPC::VPC::CidrBlock`. This provides recommended CIDR blocks for a new VPC.
ALIYUN::VPC::vSwitch::CidrBlock	Suggests CIDR blocks for a new vSwitch.	`RegionId`: The region ID. Defaults to the stack's region. `VpcId`: The VPC ID. `VpcCidrBlock`: The VPC CIDR block. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `CIDR` parameter is set to `ALIYUN::VPC::VSwitch::CidrBlock`, and `RegionId` and `VpcId` are specified in `AssociationPropertyMetadata`. This provides recommended CIDR blocks for a new vSwitch.
ALIYUN::VPC::vSwitch::VSwitchId	Retrieves the ID of a vSwitch.	`RegionId`: The region ID. Defaults to the stack's region. `ZoneId`: The zone ID. `VpcId`: The VPC ID. `InstanceType`: The instance type. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `VSwitchId` parameter is set to `ALIYUN::VPC::VSwitch::VSwitchId`, and `RegionId` and `ZoneId` are specified in `AssociationPropertyMetadata`. This retrieves the ID of an available vSwitch in the selected region and zone.
ALIYUN::VPC::VirtualBorderRouter::RouteTableId	The ID of a VBR.	`RegionId`: The region ID. Defaults to the stack's region. Example: Sample code JSON example: `{ "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 example: `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 this example, the `AssociationProperty` for the `RouteTableId` parameter is set to `ALIYUN::VPC::VirtualBorderRouter::RouteTableId`, and `RegionId` is specified in `AssociationPropertyMetadata`. This retrieves the ID of a VBR instance in the specified region.
ALIYUN::VPC::Zone::ZoneId	Lists available zones for a VPC.	`RegionId`: The region ID. Defaults to the stack's region. Sample code JSON example: `{ "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 example: `FormatVersion: 'OOS-2019-06-01' Parameters: RegionId: Type: String AssociationProperty: ALIYUN::ECS::RegionId ZoneId: Type: String AssociationProperty: ALIYUN::VPC::Zone::ZoneId AssociationPropertyMetadata: RegionId: ${RegionId}`

Examples

Example 1: AssociationProperty example

Set the AssociationProperty parameter to ALIYUN::ECS::Image::ImageId to retrieve all available image IDs in the selected region.

JSON example:

{
  "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 example:

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

Parameters:

UserName: A string of 6 to 12 characters. Valid values:
- anonymous (default value)
- user-one
- user-two
PassWord: A string of 1 to 41 characters that can contain uppercase letters, lowercase letters, and digits. This parameter has no default value.

If NoEcho is set to true, the system does not return the parameter value when you query the stack.
ImageId: The ID of the image.

If AssociationProperty is set to ALIYUN::ECS::Image::ImageId, the ROS console verifies that the specified image ID is available when you create a stack. The console also provides a drop-down list of other available image IDs in the selected region.

Example 2: AssociationPropertyMetadata

Specify AssociationProperty with AssociationPropertyMetadata (including RegionId, VpcId, and ZoneId) to retrieve a vSwitch from a specific VPC and zone. The RegionId is set to the static value China (Hangzhou). The VpcId and ZoneId values are dynamically set from the ${VpcId} and ${EcsZone} parameters, filtering the available vSwitch options based on the selected VPC and zone.

Note

For a parameter with AllowedValues configured, such as EcsZone, you can add AutoChangeType to its AssociationPropertyMetadata and set the value to false. This renders the parameter as a dropdown list in the CloudOps Orchestration Service console.

JSON example:

{
  "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 example:

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}