DATASOURCE::EBS::DiskReplicaGroups - Resource Orchestration Service

DATASOURCE::EBS::DiskReplicaGroups is used to query the information about one or more replication pair-consistent groups.

Syntax

{
  "Type": "DATASOURCE::EBS::DiskReplicaGroups",
  "Properties": {
    "Site": String,
    "ResourceGroupId": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Site

String

Yes

The type of the site from which you want to query the information about the replication pairs and the replication pair-consistent group.

This property is used in scenarios in which replication pairs are used across zones.

If the Site property is not specified, information such as the state of replication pairs at the primary site is returned.
If the Site property is specified, information such as the state of replication pairs at the site specified by the Site property is returned.
Valid values:
- production: primary site
- backup: secondary site

ResourceGroupId

String

Yes

The ID of the resource group.

None.

Return values

Fn::GetAtt

ReplicaGroupIds: the IDs of the replication pair-consistent groups.
DiskReplicaGroups: details of the replication pair-consistent groups.

Property	Type	Description	Constraint
ReplicaGroupIds	List	The IDs of the replication pair-consistent groups.	None.
DiskReplicaGroups	List	Details of the replication pair-consistent groups.	None.
Status	String	The state of the replication pair-consistent group.	Valid values: invalid: The replication pair-consistent group is invalid. This state indicates that abnormal replication pairs exist in the replication pair-consistent group. creating: The replication pair-consistent group is being created. created: The replication pair-consistent group is created. create_failed: The replication pair-consistent group failed to be created. manual_syncing: Data is being manually synchronized between the disks in the replication pair-consistent group. If data is being manually synchronized between the disks in a replication pair-consistent group for the first time, the replication pair-consistent group enters this state. syncing: Data is being synchronized between the disks in the replication pair-consistent group. If data is being asynchronously replicated from the primary disk to the secondary disk not for the first time, the replication pair-consistent group enters this state. normal: The replication pair-consistent group works as expected. If data is asynchronously replicated from the primary disk to the secondary disk within the current replication cycle, the replication pair-consistent group enters this state. stopping: The replication pair-consistent group is being stopped. stopped: The replication pair-consistent group is stopped. stop_failed: The replication pair-consistent group failed to be stopped. failovering: A failover is being performed in the replication pair-consistent group. failovered: A failover is performed in the replication pair-consistent group. failover_failed: A failover failed to be performed in the replication pair-consistent group. reprotecting: A reverse replication is being performed in the replication pair-consistent group. reprotect_failed: A reverse replication failed to be performed in the replication pair-consistent group. deleting: The replication pair-consistent group is being deleted. delete_failed: The replication pair-consistent group failed to be deleted. deleted: The replication pair-consistent group is deleted.
SourceZoneId	String	The ID of the zone in which the primary site is deployed.	None.
PrimaryRegion	String	The initial source region (primary region) of the replication pair-consistent group.	None.
Description	String	The description of the replication pair-consistent group.	None.
Tags	Map	The tags of the replication pair-consistent group.	None.
ReplicaGroupId	String	The ID of the replication pair-consistent group.	None.
StandbyRegion	String	The initial destination region (secondary region) of the replication pair-consistent group.	None.
PairIds	String	The IDs of the replication pairs that belong to the replication pair-consistent group.	None.
LastRecoverPoint	String	The time when data was last asynchronously replicated from the primary disk to the secondary disk in the replication pair-consistent group.	The value of this property is a timestamp. Unit: seconds.
Site	String	The type of the site from which the information about the replication pairs and the replication pair-consistent groups is queried.	Valid values: production: primary site backup: secondary site
DestinationRegionId	String	The ID of the region in which the secondary site is deployed.	None.
ResourceGroupId	String	The ID of the resource group.	None.
DiskReplicaGroupName	String	The name of the replication pair-consistent group.	None.
StandbyZone	String	The initial destination zone (secondary zone) of the replication pair-consistent group.	None.
SourceRegionId	String	The ID of the region in which the primary site is deployed.	None.
DestinationZoneId	String	The ID of the zone in which the secondary site is deployed.	None.
PrimaryZone	String	The initial source zone (primary zone) of the replication pair-consistent group.	None.
RPO	Number	The recovery point objective (RPO) of the replication pair-consistent group.	Unit: seconds.
PairNumber	Number	The number of replication pairs that belong to the replication pair-consistent group.	None.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
Resources:
  ExtensionDataSource:
    Properties:
      Site: production
    Type: DATASOURCE::EBS::DiskReplicaGroups
Outputs:
  DiskReplicaGroups:
    Description: The list of disk replica groups.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DiskReplicaGroups
  ReplicaGroupIds:
    Description: The list of replica group IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ReplicaGroupIds

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::EBS::DiskReplicaGroups",
      "Properties": {
        "Site": "production"
      }
    }
  },
  "Outputs": {
    "ReplicaGroupIds": {
      "Description": "The list of replica group IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReplicaGroupIds"
        ]
      }
    },
    "DiskReplicaGroups": {
      "Description": "The list of disk replica groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskReplicaGroups"
        ]
      }
    }
  }
}