Resource Orchestration Service:basic resources

AssociationProperty Values

Description

Corresponding AssociationPropertyMetadata

Auto

ROS auto-generates fields such as AssociationProperty and AssociationPropertyMetadata from the Terraform data structure.

Overwrite: Supplements or overwrites inner nested parameter definitions.

This optional dictionary contains:

• Key

  The path to the inner nested parameter. Path rules:

  • Use * to represent an element in a list or set.

  • Use the item's name to represent an item in an object.

  • Use a period (.) to separate paths.

  • You can omit the * character at the beginning and in the middle of a path. You cannot omit one or more * characters at the end of a path.

  Examples:

  // The path for name is name.
  // The path for address is address.
  variable "user_information" {
    type = object({
      name    = string
      address = string
    })
  }
  
  // The path for elements in region_ids is *.
  variable "region_ids" {
    type    = list(string)
  }
  
  // The path for internal is *.internal, which can be abbreviated as internal.
  // The path for external is *.external, which can be abbreviated as external.
  // The path for protocol is *.protocol, which can be abbreviated as protocol.
  variable "docker_ports" {
    type = list(object({
      internal = number
      external = number
      protocol = string
    }))
  }
  
  // The path for b is *.b, which can be abbreviated as b.
  // The path for elements in b is *.b.*, which can be abbreviated as b.*
  // The path for c is *.c, which can be abbreviated as c.
  // The path for d is *.c.*.d, which can be abbreviated as c.d.
  // The path for elements in d is *.c.*.d.*, which can be abbreviated as c.d.*
  // The path for e is *.e, which can be abbreviated as e.
  // The path for elements in e is *.e.*, which can be abbreviated as e.*.
  // The path for elements in e is *.e.*.*, which can be abbreviated as e.*.* (you must keep both * characters).
  // The path for f is *.f, which can be abbreviated as f.
  // The path for g is *.f.*.*.g, which can be abbreviated as f.g.
  // The path for elements in g is *.f.*.*.g.*, which can be abbreviated as f.g.*
  variable "complex_type_demo" {
    type = list(object({
      b = list(string)
      c = list(object({
        d = list(string)
      }))
      e = list(list(string))
      f = list(list(object({
        g = list(string)
      })))
    }))
  }

• Value

  A supplement to the parameter definition. For more information, see Overview.

AutoCompleteInput

Generates a random string.

• CharacterClasses

  • Class: The character type. Valid values:

    • lowercase

    • uppercase

    • number

    • specialCharacter

  • Min: Minimum character count for this type.

  • SpecialCharacters: Specific special characters. Valid only when Class is specialCharacter.

  • Start: Whether the string can start with a special character. Valid only when Class is specialCharacter.

  • End: Whether the string can end with a special character. Valid only when Class is specialCharacter.

• Prefix: The prefix of the string.

• Suffix: The suffix of the string.

• Length: The length of the string.

{
  "ROSTemplateFormatVersion": "2015-09-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-ros",
        "CharacterClasses": [
          {
            "Class": "lowercase",
            "min": 1
          }
        ]
      }
    }
  }
}

ROSTemplateFormatVersion: '2015-09-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-ros'
      CharacterClasses:
        - Class: lowercase
          min: 1

ChargeType

The billing method. Valid values:

• Pay-as-you-go

• Subscription

None

Code

A code input field.

None

CommaDelimitedList

A comma-delimited array.

None

Cron

A formatted cron expression that defines the schedule for a task.

None

DateTime

The date.

• GMTZone: The GMT zone.

• TimeZone: The description of the time zone.

FileContent

Reads content from a local file.

AcceptFileSuffixes: Accepted file types for upload, separated by commas.

GMTZone

A GMT zone selection.

Examples:

• Example code

  JSON example:

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

  YAML example:

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

• Example description

  In this example, the GMT zone is set by specifying GMTZone for the AssociationProperty of the GMTZone parameter.

Json

A JSON object input.

None

List[Parameter]

A parameter list displayed with indentation.

Applies only to JSON parameters.

• Parameter: The parameter definition.

• Mode: The display style.

  • Collapse: The collapse style. This is the default value.

  • Table: The table style.

For more information, see Overview.

Examples:

• Example code

  JSON example:

  {
    "ROSTemplateFormatVersion": "2015-09-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:

  ROSTemplateFormatVersion: '2015-09-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, List[Parameter] is specified for AssociationProperty and Parameter is specified for AssociationPropertyMetadata to arrange multiple ECS region IDs with indentation in the console.

List[Parameters]

A parameter group list displayed in a table.

Applies only to JSON parameters.

• Parameters: Required. A dictionary of parameter definitions.

  • Key: The parameter name.

  • Value: The parameter definition. For more information, see Overview.

    Note

    Use simple parameters for table arrangement. Nesting is not recommended.

  Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-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:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RenameECS:
        Label: Rename ECS
        MaxLength: 100
        MinLength: 1
        Type: Json
        AssociationProperty: List[Parameters]
        AssociationPropertyMetadata:
          Parameters:
            InstanceId:
              Type: String
              Label: ECS instance ID
              AssociationProperty: ALIYUN::ECS::Instance::InstanceId
              MinLength: 1
              MaxLength: 64
            Name:
              Type: String
              Label: New name
              MinLength: 1

  • Example description

    In this example, List[Parameters] is specified for AssociationProperty and Parameters is specified for AssociationPropertyMetadata to arrange multiple ECS instance IDs in a table in the console.

• ListMetadata: Controls table display.

  • ShowHeader: Whether to display the table header. Default: true.

  • ShowRemove: Whether to display the remove button. Default: true.

  • ShowAddition: Whether to display the add button. Default: true.

  • Order: A list of strings specifying column order from left to right. Default: alphabetical.

OOSServiceRole

The OOS server role.

RegionId: Region ID. Default: the stack's region.

Password

A password input field.

None

RateControl

The OOS execution rate.

Examples:

• Example code

  JSON example:

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

  YAML example:

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

• Example description

  In this example, the OOS execution rate is configured by specifying RateControl for the AssociationProperty of the RateControl parameter.

Tags

Tag selection.

• RegionId: Region ID. Default: the stack's region.

• ResourceType: Resource type for group statistics. Default: ALIYUN::ECS::INSTANCE.

Targets

ECS instance selection by instance ID, tags, resource groups, or other methods.

RegionId: Region ID. Default: the stack's region.

TextArea

A rich text input field.

None

TimeTriggerWeekly

Weekly time selection.

Examples:

• Example code

  JSON example:

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

  YAML example:

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

• Example description

  In this example, a time is selected on a weekly basis by specifying TimeTriggerWeekly for the AssociationProperty of the TimeTriggerWeekly parameter.

TimeZone

A time zone selection.

Examples:

• Example code

  JSON example:

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

  YAML example:

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

• Example description

  In this example, the time zone is configured by specifying TimeZone for the AssociationProperty of the TimeZone parameter.

None

Arranges parameters with indentation.

Applies only to JSON parameters.

• Parameters: A dictionary of parameter definitions.

  • Key: The parameter name.

  • Value: The parameter definition. For more information, see Overview.

  Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-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:

    ROSTemplateFormatVersion: '2015-09-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. Only AssociationPropertyMetadata is specified as Parameters to arrange a single ECS instance ID with indentation in the console.

• Metadata: A dictionary. For more information, see Metadata.