ALIYUN::EBS::DiskReplicaPair - Resource Orchestration Service

Syntax

{
  "Type": "ALIYUN::EBS::DiskReplicaPair",
  "Properties": {
    "DiskReplicaPairName": String,
    "Description": String,
    "DestinationDiskId": String,
    "ResourceGroupId": String,
    "Period": Integer,
    "RPO": Integer,
    "DestinationRegionId": String,
    "Bandwidth": Integer,
    "DestinationZoneId": String,
    "PaymentType": String,
    "SourceZoneId": String,
    "Tags": List,
    "PeriodUnit": String,
    "DiskId": String
  }
}

Properties

Property name	Type	Required	Update allowed	Description	Constraints
DiskReplicaPairName	String	No	Yes	The name of the asynchronous replication relationship.	None
Description	String	No	No	The description of the asynchronous replication relationship.	None
DestinationDiskId	String	Yes	No	The ID of the secondary disk.	None
ResourceGroupId	String	No	Yes	The ID of the resource group.	None
Period	Integer	No	No	The subscription duration of the resource.	The unit is month. Valid values are 1, 2, 3, 6, 12, 24, 36, and 60.
RPO	Integer	No	No	The RPO of the replication pair.	Unit: seconds.
DestinationRegionId	String	Yes	No	The region ID of the secondary disk.	None
Bandwidth	Integer	No	No	The bandwidth for asynchronous replication.	Unit: Kbps.
DestinationZoneId	String	Yes	No	The zone ID of the secondary disk.	None
PaymentType	String	No	No	The billing method of the replication pair.	Valid values: PrePay: subscription. PostPay: pay-as-you-go.
SourceZoneId	String	Yes	No	The zone ID of the primary disk.	None
Tags	List	No	Yes	The custom tags.	Up to 20 tags are supported. For more information, see the Tags property.
PeriodUnit	String	No	No	The unit of the subscription duration.	Valid value: Month.
DiskId	String	Yes	No	The ID of the primary disk.	None

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags property

Property name	Type	Required	Update allowed	Description	Constraints
Value	String	No	No	The value of the tag.	The value can be 0 to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.
Key	String	Yes	No	The key of the tag.	The key can be 1 to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.

Return value

Fn::GetAtt

DiskReplicaPairName: The name of the asynchronous replication relationship.
Description: The description of the asynchronous replication relationship.
DestinationDiskId: The ID of the secondary disk.
ResourceGroupId: The ID of the resource group.
CreateTime: The time when the resource was created.
ReplicaPairId: The ID of the asynchronous replication relationship.
RPO: The recovery point objective (RPO) of the asynchronous replication relationship.
DestinationRegionId: The region ID of the secondary disk.
Bandwidth: The bandwidth for asynchronous replication between disks.
DestinationZoneId: The zone ID of the secondary disk.
PaymentType: The billing method of the replication pair.
SourceZoneId: The zone ID of the primary disk.
Tags: The custom tags of the resource.
DiskId: The ID of the primary disk.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DestinationDiskId:
    Type: String
    AssociationProperty: ALIYUN::ECS::Disk::DiskId
    Description: The ID of the standby disk.
Resources:
  ExtensionResource:
    Type: ALIYUN::EBS::DiskReplicaPair
    Properties:
      DiskReplicaPairName: TestReplicaPair
      DestinationDiskId:
        Ref: DestinationDiskId
      RPO: 900
      DestinationRegionId: cn-beijing
      Bandwidth: 10240
      DestinationZoneId: cn-beijing-h
      PaymentType: PostPay
      SourceZoneId:
        Fn::Select:
          - '0'
          - Fn::GetAZs:
              Ref: ALIYUN::Region
      DiskId: d-sa1f82p58p1tdw9g****
Outputs:
  DiskReplicaPairName:
    Description: The name of the asynchronous replication relationship.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DiskReplicaPairName
  Description:
    Description: The description of the asynchronous replication relationship.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Description
  DestinationDiskId:
    Description: The ID of the standby disk.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DestinationDiskId
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceGroupId
  CreateTime:
    Description: The creation time of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  ReplicaPairId:
    Description: The ID of the disk replica pair.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ReplicaPairId
  RPO:
    Description: The RPO of the replication pair, in seconds.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RPO
  DestinationRegionId:
    Description: The ID of the region to which the disaster recovery site belongs.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DestinationRegionId
  Bandwidth:
    Description: The bandwidth for asynchronous data replication between disks.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Bandwidth
  DestinationZoneId:
    Description: The ID of the zone to which the disaster recovery site belongs.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DestinationZoneId
  PaymentType:
    Description: The billing method of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PaymentType
  SourceZoneId:
    Description: The ID of the zone to which the production site belongs.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SourceZoneId
  Tags:
    Description: The tags of the disk replica pair.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Tags
  DiskId:
    Description: The ID of the primary disk.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DiskId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DestinationDiskId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Disk::DiskId",
      "Description": "The ID of the standby disk."
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::EBS::DiskReplicaPair",
      "Properties": {
        "DiskReplicaPairName": "TestReplicaPair",
        "DestinationDiskId": {
          "Ref": "DestinationDiskId"
        },
        "RPO": 900,
        "DestinationRegionId": "cn-beijing",
        "Bandwidth": 10240,
        "DestinationZoneId": "cn-beijing-h",
        "PaymentType": "PostPay",
        "SourceZoneId": {
          "Fn::Select": [
            "0",
            {
              "Fn::GetAZs": {
                "Ref": "ALIYUN::Region"
              }
            }
          ]
        },
        "DiskId": "d-sa1f82p58p1tdw9g****"
      }
    }
  },
  "Outputs": {
    "DiskReplicaPairName": {
      "Description": "The name of the asynchronous replication relationship.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DiskReplicaPairName"
        ]
      }
    },
    "Description": {
      "Description": "The description of the asynchronous replication relationship.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "DestinationDiskId": {
      "Description": "The ID of the standby disk.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DestinationDiskId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceGroupId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "ReplicaPairId": {
      "Description": "The ID of the disk replica pair.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ReplicaPairId"
        ]
      }
    },
    "RPO": {
      "Description": "The RPO of the replication pair, in seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RPO"
        ]
      }
    },
    "DestinationRegionId": {
      "Description": "The ID of the region to which the disaster recovery site belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DestinationRegionId"
        ]
      }
    },
    "Bandwidth": {
      "Description": "The bandwidth for asynchronous data replication between disks.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Bandwidth"
        ]
      }
    },
    "DestinationZoneId": {
      "Description": "The ID of the zone to which the disaster recovery site belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DestinationZoneId"
        ]
      }
    },
    "PaymentType": {
      "Description": "The billing method of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PaymentType"
        ]
      }
    },
    "SourceZoneId": {
      "Description": "The ID of the zone to which the production site belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SourceZoneId"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the disk replica pair.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    },
    "DiskId": {
      "Description": "The ID of the primary disk.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DiskId"
        ]
      }
    }
  }
}