How to use DATASOURCE::EBS::DiskReplicaPairs to query information about replication pairs - Resource Orchestration Service

DATASOURCE::EBS::DiskReplicaPairs is used to query the information about replication pairs.

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

ResourceGroupId

String

Yes

The ID of the resource group to which the replication pair belongs.

None.

RefreshOptions

String

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

DiskReplicaPairs: details of the replication pairs.
ReplicaPairIds: the IDs of the replication pairs.

Property	Type	Description	Constraint
ReplicaPairIds	List	The IDs of the replication pairs.	None.
DiskReplicaPairs	List	Details of the replication pairs.	None.
Description	String	The description of the replication pair.	None.
Tags	Map	Details of the custom tags.	None.
ReplicaPairId	String	The ID of the replication pair.	None.
ResourceGroupId	String	The ID of the resource group.	None.
Bandwidth	Number	The bandwidth that is used during asynchronous replication.	Unit: Kbit/s.
RPO	Number	The recovery point objective (RPO) of the replication pair.	Unit: seconds.

Examples

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ResourceGroupId:
    Description: The ID of the resource group.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      ResourceGroupId:
        Ref: ResourceGroupId
    Type: DATASOURCE::EBS::DiskReplicaPairs
Outputs:
  DiskReplicaPairs:
    Description: The list of disk replica pairs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DiskReplicaPairs
  ReplicaPairIds:
    Description: The list of replica pair IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ReplicaPairIds

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ResourceGroupId": {
      "Type": "String",
      "Description": "The ID of the resource group."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::EBS::DiskReplicaPairs",
      "Properties": {
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        }
      }
    }
  },
  "Outputs": {
    "DiskReplicaPairs": {
      "Description": "The list of disk replica pairs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskReplicaPairs"
        ]
      }
    },
    "ReplicaPairIds": {
      "Description": "The list of replica pair IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReplicaPairIds"
        ]
      }
    }
  }
}