DATASOURCE::EBS::DiskReplicaPair - Resource Orchestration Service

DATASOURCE::EBS::DiskReplicaPair is used to query a replication pair.

Syntax

{
  "Type": "DATASOURCE::EBS::DiskReplicaPair",
  "Properties": {
    "ReplicaPairId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ReplicaPairId

String

Yes

The ID of the replication pair.

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

DiskReplicaPairName: the name of the replication pair.
Description: the description of the replication pair.
DestinationDiskId: the ID of the secondary disk.
ResourceGroupId: the ID of the resource group to which the replication pair belongs.
CreateTime: the timestamp that indicates when the replication pair was created. Unit: seconds.
ReplicaPairId: the ID of the replication pair.
RPO: the recovery point objective (RPO) of the replication pair. Unit: seconds.
DestinationRegionId: the region ID of the secondary disk.
Bandwidth: the bandwidth that is used during asynchronous replication. Unit: Kbit/s.
DestinationZoneId: the zone ID of the secondary disk.
PaymentType: the billing method.
SourceZoneId: the zone ID of the primary disk.
Tags: the tags of the replication pair.
DiskId: the ID of the primary disk.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ReplicaPairId:
    Type: String
    Description:
      en: The ID of the replication pair.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::EBS::DiskReplicaPair
    Properties:
      ReplicaPairId:
        Ref: ReplicaPairId
Outputs:
  DiskReplicaPairName:
    Description: The name of the asynchronous replication relationship.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DiskReplicaPairName
  Description:
    Description: The description of the replication pair.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  DestinationDiskId:
    Description: The ID of the secondary disk.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DestinationDiskId
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  CreateTime:
    Description: 'The time when the replication pair was created. The value of this parameter is a timestamp. Unit: seconds.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  ReplicaPairId:
    Description: The ID of the replication pair.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReplicaPairId
  RPO:
    Description: 'The recovery point objective (RPO) of the replication pair. Unit: seconds.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RPO
  DestinationRegionId:
    Description: The ID of the region to which the disaster recovery site belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DestinationRegionId
  Bandwidth:
    Description: The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Bandwidth
  DestinationZoneId:
    Description: The ID of the zone to which the disaster recovery site belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DestinationZoneId
  PaymentType:
    Description: The payment type of the replication pair.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  SourceZoneId:
    Description: The zone ID of the primary disk.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceZoneId
  Tags:
    Description: The tags of the replication pair.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  DiskId:
    Description: The ID of the primary disk.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DiskId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ReplicaPairId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the replication pair."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::EBS::DiskReplicaPair",
      "Properties": {
        "ReplicaPairId": {
          "Ref": "ReplicaPairId"
        }
      }
    }
  },
  "Outputs": {
    "DiskReplicaPairName": {
      "Description": "The name of the asynchronous replication relationship.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskReplicaPairName"
        ]
      }
    },
    "Description": {
      "Description": "The description of the replication pair.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "DestinationDiskId": {
      "Description": "The ID of the secondary disk.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DestinationDiskId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the replication pair was created. The value of this parameter is a timestamp. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "ReplicaPairId": {
      "Description": "The ID of the replication pair.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReplicaPairId"
        ]
      }
    },
    "RPO": {
      "Description": "The recovery point objective (RPO) of the replication pair. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RPO"
        ]
      }
    },
    "DestinationRegionId": {
      "Description": "The ID of the region to which the disaster recovery site belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DestinationRegionId"
        ]
      }
    },
    "Bandwidth": {
      "Description": "The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Bandwidth"
        ]
      }
    },
    "DestinationZoneId": {
      "Description": "The ID of the zone to which the disaster recovery site belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DestinationZoneId"
        ]
      }
    },
    "PaymentType": {
      "Description": "The payment type of the replication pair.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "SourceZoneId": {
      "Description": "The zone ID of the primary disk.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceZoneId"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the replication pair.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "DiskId": {
      "Description": "The ID of the primary disk.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskId"
        ]
      }
    }
  }
}