All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::PVTZ::SyncEcsHost

Last Updated:Jan 03, 2025

ALIYUN::PVTZ::SyncEcsHost is used to create a hostname synchronization task.

Syntax

{
  "Type": "ALIYUN::PVTZ::SyncEcsHost",
  "Properties": {
    "Regions": List,
    "Status": String,
    "ZoneId": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Regions

List

Yes

Yes

The information about the regions that you want to synchronize.

{'Length': {'Min': 1, 'Max': 500}}

Status

String

Yes

Yes

The status of the hostname synchronization task.

Valid values:

  • ON

  • OFF

ZoneId

String

Yes

No

The zone ID.

None.

Regions syntax

"Regions": [
  {
    "UserId": String,
    "RegionId": String
  }
]

Regions properties

Property

Type

Required

Editable

Description

Constraint

RegionId

String

Yes

Yes

The region ID.

None.

UserId

String

No

Yes

The ID of the user that corresponds to the region.

This property is used in cross-account synchronization scenarios.

Return values

Fn::GetAtt

None.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Status:
    Type: String
    Description:
      en: 'The host synchronizes the task state. Valid values: ON, OFF.'
    AllowedValues:
      - 'ON'
      - 'OFF'
    Required: true
  ZoneId:
    AssociationProperty: ZoneId
    Type: String
    Description:
      en: Zone ID, a unique identifier for the Zone.
    Required: true
  Regions:
    AssociationPropertyMetadata:
      Parameters:
        UserId:
          Type: String
          Description:
            en: Region-owned user ID for cross-account sync scenarios.
          Required: false
        RegionId:
          Type: String
          Description:
            en: Region id.
          Required: true
    AssociationProperty: List[Parameters]
    Type: Json
    Description:
      en: A list of region information to be synchronized.
    Required: true
    MinLength: 1
    MaxLength: 500
Resources:
  SyncEcsHost:
    Type: ALIYUN::PVTZ::SyncEcsHost
    Properties:
      Status:
        Ref: Status
      ZoneId:
        Ref: ZoneId
      Regions:
        Ref: Regions
 
 
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Status": {
      "Type": "String",
      "Description": {
        "en": "The host synchronizes the task state. Valid values: ON, OFF."
      },
      "AllowedValues": [
        "ON",
        "OFF"
      ],
      "Required": true
    },
    "ZoneId": {
      "AssociationProperty": "ZoneId",
      "Type": "String",
      "Description": {
        "en": "Zone ID, a unique identifier for the Zone."
      },
      "Required": true
    },
    "Regions": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "UserId": {
            "Type": "String",
            "Description": {
              "en": "Region-owned user ID for cross-account sync scenarios."
            },
            "Required": false
          },
          "RegionId": {
            "Type": "String",
            "Description": {
              "en": "Region id."
            },
            "Required": true
          }
        }
      },
      "AssociationProperty": "List[Parameters]",
      "Type": "Json",
      "Description": {
        "en": "A list of region information to be synchronized."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 500
    }
  },
  "Resources": {
    "SyncEcsHost": {
      "Type": "ALIYUN::PVTZ::SyncEcsHost",
      "Properties": {
        "Status": {
          "Ref": "Status"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "Regions": {
          "Ref": "Regions"
        }
      }
    }
  }
}