All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::EBS::DiskReplicaPair

Last Updated:Aug 12, 2024

ALIYUN::EBS::DiskReplicaPair is used to create a replication pair.

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

Type

Required

Editable

Description

Constraint

DiskReplicaPairName

String

No

Yes

The name of the replication pair.

None.

Description

String

No

No

The description of the replication pair.

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 instance that you want to create.

Unit: months.

Valid values when you create an instance: 1, 2, 3, 6, 12, 24, 36, and 60.

RPO

Integer

No

No

The recovery point objective (RPO) of the replication pair.

Unit: seconds.

DestinationRegionId

String

Yes

No

The ID of the region in which the secondary disk is deployed.

None.

Bandwidth

Integer

No

No

The bandwidth that is used to asynchronously replicate data from the primary disk to the secondary disk.

Unit: Kbit/s.

DestinationZoneId

String

Yes

No

The ID of the zone in which the secondary disk is deployed.

None.

PaymentType

String

No

No

The billing method of the instance.

Valid values:

  • PrePay: subscription

  • PostPay: pay-as-you-go

SourceZoneId

String

Yes

No

The ID of the zone in which the primary disk is deployed.

None.

Tags

List

No

Yes

The tags of the replication pair.

You can add up to 20 tags.

For more information, see Tags syntax.

PeriodUnit

String

No

No

The unit of the subscription duration.

Set the value to Month.

DiskId

String

Yes

No

The ID of the primary disk.

None.

Tags syntax

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

Tags properties

Property

Type

Required

Editable

Description

Constraint

Value

String

No

No

The value of the tag.

The tag value can be up to 128 characters in length, and cannot contain http:// or https://. The tag value cannot start with aliyun or acs:.

Key

String

Yes

No

The key of the tag.

The tag key must be 1 to 128 characters in length, and cannot contain http:// or https://. The tag key cannot start with aliyun or acs:.

Return values

Fn::GetAtt

  • DiskReplicaPairName: the name of the replication pair.

  • Description: the description of the replication pair.

  • DestinationDiskId: the ID of the secondary disk.

  • ResourceGroupId: the ID of the resource group.

  • CreateTime: the time when the replication pair was created.

  • ReplicaPairId: the ID of the replication pair.

  • RPO: the RPO of the replication pair.

  • DestinationRegionId: the ID of the region in which the secondary disk is deployed.

  • Bandwidth: the bandwidth that is used to asynchronously replicate data from the primary disk to the secondary disk.

  • DestinationZoneId: the ID of the zone in which the secondary disk is deployed.

  • PaymentType: the billing method of the instance.

  • SourceZoneId: the ID of the zone in which the primary zone is deployed.

  • Tags: the tags of the replication pair.

  • 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 value set by the consistency group 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 cloud 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 payment type 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 value set by the consistency group 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 cloud 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 payment type 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"
            ]
          }
        }
      }
    }