DATASOURCE::EBS::DiskReplicaGroup - Resource Orchestration Service

DATASOURCE::EBS::DiskReplicaGroup is used to query the information about a replication pair-consistent group.

Syntax

{
  "Type": "DATASOURCE::EBS::DiskReplicaGroup",
  "Properties": {
    "ReplicaGroupId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ReplicaGroupId

String

Yes

The ID of the replication pair-consistent group.

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

Site: the type of the site from which the information about the replication pair-consistent group is queried. This property is used in scenarios where data is replicated across zones in replication pairs.
Description: the description of the replication pair-consistent group.
PairNumber: the number of replication pairs that belong to the replication pair-consistent group.
DiskReplicaGroupName: the name of the replication group.
StandbyZone: the initial destination zone of the replication pair-consistent group.
ResourceGroupId: the ID of the resource group to which the replication pair-consistent group belongs.
PrimaryRegion: the initial source region of the replication pair-consistent group.
LastRecoverPoint: the timestamp that indicates when the most recent asynchronous replication was complete in the replication pair-consistent group. Unit: seconds.
PairIds: the IDs of the replication pairs that belong to the replication pair-consistent group.
ReplicaGroupId: the ID of the replication pair-consistent group.
RPO: the recovery point objective (RPO) of the replication pair-consistent group. Unit: seconds.
SourceRegionId: the region ID of the primary site.
DestinationRegionId: the region ID of the secondary site.
DestinationZoneId: the zone ID of the secondary site.
PrimaryZone: the initial source zone of the replication pair-consistent group.
SourceZoneId: the zone ID of the primary site.
StandbyRegion: the initial destination region of the replication pair-consistent group.
Tags: the tags of the replication pair-consistent group.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ReplicaGroupId:
    Type: String
    Description:
      en: The ID of the consistent replication group.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::EBS::DiskReplicaGroup
    Properties:
      ReplicaGroupId:
        Ref: ReplicaGroupId
Outputs:
  Site:
    Description: Site information sources for replication pairs and consistent replication groups.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Site
  Description:
    Description: The description of the consistent replication group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  PairNumber:
    Description: The number of replication pairs contained in a consistent replication group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PairNumber
  DiskReplicaGroupName:
    Description: The name of the consistent replication group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DiskReplicaGroupName
  StandbyZone:
    Description: The initial destination zone of the replication group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - StandbyZone
  ResourceGroupId:
    Description: The ID of resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  PrimaryRegion:
    Description: The initial source region of the replication group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - 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:
        - ExtensionDataSource
        - LastRecoverPoint
  PairIds:
    Description: List of replication pair IDs contained in a consistent replication group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PairIds
  ReplicaGroupId:
    Description: The ID of the consistent replication group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReplicaGroupId
  RPO:
    Description: The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RPO
  SourceRegionId:
    Description: The ID of the region to which the production site belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceRegionId
  DestinationRegionId:
    Description: The ID of the region to which the disaster recovery site belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DestinationRegionId
  DestinationZoneId:
    Description: The ID of the zone to which the disaster recovery site belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DestinationZoneId
  PrimaryZone:
    Description: The initial source available area of the replication group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PrimaryZone
  SourceZoneId:
    Description: The ID of the zone to which the production site belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceZoneId
  StandbyRegion:
    Description: The initial destination region of the replication group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - StandbyRegion
  Tags:
    Description: The tags of the replication pair-consistent group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ReplicaGroupId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the consistent replication group."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::EBS::DiskReplicaGroup",
      "Properties": {
        "ReplicaGroupId": {
          "Ref": "ReplicaGroupId"
        }
      }
    }
  },
  "Outputs": {
    "Site": {
      "Description": "Site information sources for replication pairs and consistent replication groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Site"
        ]
      }
    },
    "Description": {
      "Description": "The description of the consistent replication group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "PairNumber": {
      "Description": "The number of replication pairs contained in a consistent replication group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PairNumber"
        ]
      }
    },
    "DiskReplicaGroupName": {
      "Description": "The name of the consistent replication group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskReplicaGroupName"
        ]
      }
    },
    "StandbyZone": {
      "Description": "The initial destination zone of the replication group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StandbyZone"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "PrimaryRegion": {
      "Description": "The initial source region of the replication group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "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": [
          "ExtensionDataSource",
          "LastRecoverPoint"
        ]
      }
    },
    "PairIds": {
      "Description": "List of replication pair IDs contained in a consistent replication group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PairIds"
        ]
      }
    },
    "ReplicaGroupId": {
      "Description": "The ID of the consistent replication group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReplicaGroupId"
        ]
      }
    },
    "RPO": {
      "Description": "The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RPO"
        ]
      }
    },
    "SourceRegionId": {
      "Description": "The ID of the region to which the production site belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceRegionId"
        ]
      }
    },
    "DestinationRegionId": {
      "Description": "The ID of the region to which the disaster recovery site belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DestinationRegionId"
        ]
      }
    },
    "DestinationZoneId": {
      "Description": "The ID of the zone to which the disaster recovery site belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DestinationZoneId"
        ]
      }
    },
    "PrimaryZone": {
      "Description": "The initial source available area of the replication group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PrimaryZone"
        ]
      }
    },
    "SourceZoneId": {
      "Description": "The ID of the zone to which the production site belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceZoneId"
        ]
      }
    },
    "StandbyRegion": {
      "Description": "The initial destination region of the replication group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StandbyRegion"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the replication pair-consistent group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    }
  }
}