How to use DATASOURCE::EBS::DiskReplicaGroups to query information about replication pair-consistent groups - Resource Orchestration Service

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

Syntax

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

Properties

Property	Type	Required	Editable	Description	Constraint
Site	String	No	Yes	The type of the site from which you want to query the information about the replication pairs and the replication pair-consistent groups.	This property is used in scenarios where replication pairs are used across zones. If Site is left empty, information such as the status of replication pairs at the primary site is returned. If Site is specified, information such as the status of replication pairs at the specified site is returned. Valid values: production: primary site backup: secondary site
ResourceGroupId	String	No	Yes	The ID of the resource group.	None.
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): does not refresh data source resources when the stack is updated. Always: refreshes data source resources when the stack is updated.

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 status 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. When data is being manually synchronized for the first time, the replication pair-consistent group is in this state. syncing: Data is being synchronized between the disks in the replication pair-consistent group. After the first time, any time data is being asynchronously replicated from the primary disk to the secondary disk, the replication pair-consistent group is in this state. normal: The replication pair-consistent group works as expected. When data is asynchronously replicated from the primary disk to the secondary disk within the current replication cycle, the replication pair-consistent group is in 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 on the replication pair-consistent group. failovered: A failover is performed on the replication pair-consistent group. failover_failed: A failover failed to be performed on the replication pair-consistent group. reprotecting: A reverse replication is being performed on the replication pair-consistent group. reprotect_failed: A reverse replication failed to be performed on 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 zone ID of the primary site.	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	Details of the custom tags.	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 the most recent asynchronous replication was complete 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 region ID of the secondary site.	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 region ID of the primary site.	None.
DestinationZoneId	String	The zone ID of the secondary site.	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"
        ]
      }
    }
  }
}

Syntax

Properties

Return values

Examples

YAML format

JSON format

`YAML` format

`JSON` format