All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::EBS::DiskReplicaGroup

Last Updated:Aug 12, 2024

ALIYUN::EBS::DiskReplicaGroup is used to create a replication pair-consistent group.

Syntax

{
  "Type": "ALIYUN::EBS::DiskReplicaGroup",
  "Properties": {
    "RPO": Integer,
    "SourceRegionId": String,
    "Description": String,
    "DiskReplicaGroupName": String,
    "ResourceGroupId": String,
    "DestinationRegionId": String,
    "DestinationZoneId": String,
    "SourceZoneId": String,
    "Tags": List
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

RPO

Integer

No

Yes

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

Unit: seconds.

Set the value to 900.

SourceRegionId

String

Yes

No

The ID of the region in which the primary site resides.

None.

Description

String

No

Yes

The description of the replication pair-consistent group.

The description must be 2 to 256 characters in length. The description cannot start with http:// or https://.

DiskReplicaGroupName

String

No

Yes

The name of the replication pair-consistent group.

The name must be 2 to 128 characters in length, and can contain digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.

ResourceGroupId

String

No

Yes

The ID of the resource group.

None.

DestinationRegionId

String

Yes

No

The ID of the region in which the secondary site resides.

None.

DestinationZoneId

String

Yes

No

The ID of the zone in which the secondary site resides.

None.

SourceZoneId

String

Yes

No

The ID of the zone in which the primary site resides.

None.

Tags

List

No

Yes

The tags of the replication pair-consistent group.

For more information, see Tags properties.

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

  • Site: the type of the site that is configured for the replication pair-consistent group.

  • Description: the description of the replication pair-consistent group.

  • PairNumber: the number of replication pairs in the replication pair-consistent group.

  • DiskReplicaGroupName: the name of the replication pair-consistent group.

  • StandbyZone: the initial destination zone (secondary zone) of the replication pair-consistent group.

  • ResourceGroupId: the ID of the resource group.

  • PrimaryRegion: the initial source region (primary region) of the replication pair-consistent group.

  • LastRecoverPoint: the time when data was last asynchronously replicated from the primary disk to the secondary disk in the replication pair-consistent group.

  • PairIds: the IDs of replication pairs in the replication pair-consistent group.

  • ReplicaGroupId: the ID of the replication pair-consistent group.

  • RPO: the RPO of the replication pair-consistent group.

  • SourceRegionId: the ID of the region in which the primary site resides.

  • DestinationRegionId: the ID of the region in which the secondary site resides.

  • DestinationZoneId: the ID of the zone in which the secondary site resides.

  • PrimaryZone: the initial source zone (primary zone) of the replication pair-consistent group.

  • SourceZoneId: the ID of the zone in which the primary site resides.

  • StandbyRegion: the initial destination region (secondary region) of the replication pair-consistent group.

  • Tags: the tags of the replication pair-consistent group.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      ExtensionResource:
        Type: ALIYUN::EBS::DiskReplicaGroup
        Properties:
          RPO: 900
          SourceRegionId:
            Ref: ALIYUN::Region
          DiskReplicaGroupName: myreplicagrouptest
          DestinationRegionId: cn-beijing
          DestinationZoneId: cn-beijing-h
          SourceZoneId:
            Fn::Select:
              - '0'
              - Fn::GetAZs:
                  Ref: ALIYUN::Region
    Outputs:
      Site:
        Description: 'Site information sources for replication pairs and consistent replication groups. Possible values:'
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - Site
      Description:
        Description: The description of the consistent replication group.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - Description
      PairNumber:
        Description: The number of replication pairs contained in a consistent replication group.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - PairNumber
      DiskReplicaGroupName:
        Description: Consistent replication group name.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - DiskReplicaGroupName
      StandbyZone:
        Description: The initial destination zone of the replication group.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - StandbyZone
      ResourceGroupId:
        Description: resource group ID of enterprise
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ResourceGroupId
      PrimaryRegion:
        Description: The initial source region of the replication group.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - PrimaryRegion
      LastRecoverPoint:
        Description: 'The time when the last asynchronous replication operation of the consistent replication group completed. This parameter provides the return value as a timestamp. Unit: seconds.'
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - LastRecoverPoint
      PairIds:
        Description: List of replication pair IDs contained in a consistent replication group.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - PairIds
      ReplicaGroupId:
        Description: The ID of the consistent replication group.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ReplicaGroupId
      RPO:
        Description: The RPO value set by the consistency group in seconds.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - RPO
      SourceRegionId:
        Description: The ID of the region to which the production site belongs.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - SourceRegionId
      DestinationRegionId:
        Description: The ID of the region to which the disaster recovery site belongs.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - DestinationRegionId
      DestinationZoneId:
        Description: The ID of the zone to which the disaster recovery site belongs.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - DestinationZoneId
      PrimaryZone:
        Description: The initial source available area of the replication group.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - PrimaryZone
      SourceZoneId:
        Description: The ID of the zone to which the production site belongs.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - SourceZoneId
      StandbyRegion:
        Description: The initial destination region of the replication group.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - StandbyRegion
      Tags:
        Description: The tags of the disk replica group.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - Tags
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "ExtensionResource": {
          "Type": "ALIYUN::EBS::DiskReplicaGroup",
          "Properties": {
            "RPO": 900,
            "SourceRegionId": {
              "Ref": "ALIYUN::Region"
            },
            "DiskReplicaGroupName": "myreplicagrouptest",
            "DestinationRegionId": "cn-beijing",
            "DestinationZoneId": "cn-beijing-h",
            "SourceZoneId": {
              "Fn::Select": [
                "0",
                {
                  "Fn::GetAZs": {
                    "Ref": "ALIYUN::Region"
                  }
                }
              ]
            }
          }
        }
      },
      "Outputs": {
        "Site": {
          "Description": "Site information sources for replication pairs and consistent replication groups. Possible values:",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Site"
            ]
          }
        },
        "Description": {
          "Description": "The description of the consistent replication group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Description"
            ]
          }
        },
        "PairNumber": {
          "Description": "The number of replication pairs contained in a consistent replication group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "PairNumber"
            ]
          }
        },
        "DiskReplicaGroupName": {
          "Description": "Consistent replication group name.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "DiskReplicaGroupName"
            ]
          }
        },
        "StandbyZone": {
          "Description": "The initial destination zone of the replication group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "StandbyZone"
            ]
          }
        },
        "ResourceGroupId": {
          "Description": "resource group ID of enterprise",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ResourceGroupId"
            ]
          }
        },
        "PrimaryRegion": {
          "Description": "The initial source region of the replication group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "PrimaryRegion"
            ]
          }
        },
        "LastRecoverPoint": {
          "Description": "The time when the last asynchronous replication operation of the consistent replication group completed. This parameter provides the return value as a timestamp. Unit: seconds.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "LastRecoverPoint"
            ]
          }
        },
        "PairIds": {
          "Description": "List of replication pair IDs contained in a consistent replication group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "PairIds"
            ]
          }
        },
        "ReplicaGroupId": {
          "Description": "The ID of the consistent replication group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ReplicaGroupId"
            ]
          }
        },
        "RPO": {
          "Description": "The RPO value set by the consistency group in seconds.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "RPO"
            ]
          }
        },
        "SourceRegionId": {
          "Description": "The ID of the region to which the production site belongs.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "SourceRegionId"
            ]
          }
        },
        "DestinationRegionId": {
          "Description": "The ID of the region to which the disaster recovery site belongs.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "DestinationRegionId"
            ]
          }
        },
        "DestinationZoneId": {
          "Description": "The ID of the zone to which the disaster recovery site belongs.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "DestinationZoneId"
            ]
          }
        },
        "PrimaryZone": {
          "Description": "The initial source available area of the replication group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "PrimaryZone"
            ]
          }
        },
        "SourceZoneId": {
          "Description": "The ID of the zone to which the production site belongs.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "SourceZoneId"
            ]
          }
        },
        "StandbyRegion": {
          "Description": "The initial destination region of the replication group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "StandbyRegion"
            ]
          }
        },
        "Tags": {
          "Description": "The tags of the disk replica group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Tags"
            ]
          }
        }
      }
    }