1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. ebs
  5. DiskReplicaPair
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.ebs.DiskReplicaPair

Explore with Pulumi AI

Provides a Elastic Block Storage(EBS) Disk Replica Pair resource.

For information about Elastic Block Storage(EBS) Disk Replica Pair and how to use it, see What is Disk Replica Pair.

NOTE: Available since v1.196.0.

Create DiskReplicaPair Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DiskReplicaPair(name: string, args: DiskReplicaPairArgs, opts?: CustomResourceOptions);
@overload
def DiskReplicaPair(resource_name: str,
                    args: DiskReplicaPairArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def DiskReplicaPair(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    disk_id: Optional[str] = None,
                    source_zone_id: Optional[str] = None,
                    destination_disk_id: Optional[str] = None,
                    destination_region_id: Optional[str] = None,
                    destination_zone_id: Optional[str] = None,
                    pair_name: Optional[str] = None,
                    disk_replica_pair_name: Optional[str] = None,
                    one_shot: Optional[bool] = None,
                    bandwidth: Optional[int] = None,
                    payment_type: Optional[str] = None,
                    period: Optional[int] = None,
                    period_unit: Optional[str] = None,
                    resource_group_id: Optional[str] = None,
                    reverse_replicate: Optional[bool] = None,
                    rpo: Optional[int] = None,
                    description: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
func NewDiskReplicaPair(ctx *Context, name string, args DiskReplicaPairArgs, opts ...ResourceOption) (*DiskReplicaPair, error)
public DiskReplicaPair(string name, DiskReplicaPairArgs args, CustomResourceOptions? opts = null)
public DiskReplicaPair(String name, DiskReplicaPairArgs args)
public DiskReplicaPair(String name, DiskReplicaPairArgs args, CustomResourceOptions options)
type: alicloud:ebs:DiskReplicaPair
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DiskReplicaPairArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DiskReplicaPairArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DiskReplicaPairArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DiskReplicaPairArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DiskReplicaPairArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var diskReplicaPairResource = new AliCloud.Ebs.DiskReplicaPair("diskReplicaPairResource", new()
{
    DiskId = "string",
    SourceZoneId = "string",
    DestinationDiskId = "string",
    DestinationRegionId = "string",
    DestinationZoneId = "string",
    DiskReplicaPairName = "string",
    OneShot = false,
    Bandwidth = 0,
    PaymentType = "string",
    Period = 0,
    PeriodUnit = "string",
    ResourceGroupId = "string",
    ReverseReplicate = false,
    Rpo = 0,
    Description = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := ebs.NewDiskReplicaPair(ctx, "diskReplicaPairResource", &ebs.DiskReplicaPairArgs{
	DiskId:              pulumi.String("string"),
	SourceZoneId:        pulumi.String("string"),
	DestinationDiskId:   pulumi.String("string"),
	DestinationRegionId: pulumi.String("string"),
	DestinationZoneId:   pulumi.String("string"),
	DiskReplicaPairName: pulumi.String("string"),
	OneShot:             pulumi.Bool(false),
	Bandwidth:           pulumi.Int(0),
	PaymentType:         pulumi.String("string"),
	Period:              pulumi.Int(0),
	PeriodUnit:          pulumi.String("string"),
	ResourceGroupId:     pulumi.String("string"),
	ReverseReplicate:    pulumi.Bool(false),
	Rpo:                 pulumi.Int(0),
	Description:         pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var diskReplicaPairResource = new DiskReplicaPair("diskReplicaPairResource", DiskReplicaPairArgs.builder()
    .diskId("string")
    .sourceZoneId("string")
    .destinationDiskId("string")
    .destinationRegionId("string")
    .destinationZoneId("string")
    .diskReplicaPairName("string")
    .oneShot(false)
    .bandwidth(0)
    .paymentType("string")
    .period(0)
    .periodUnit("string")
    .resourceGroupId("string")
    .reverseReplicate(false)
    .rpo(0)
    .description("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
disk_replica_pair_resource = alicloud.ebs.DiskReplicaPair("diskReplicaPairResource",
    disk_id="string",
    source_zone_id="string",
    destination_disk_id="string",
    destination_region_id="string",
    destination_zone_id="string",
    disk_replica_pair_name="string",
    one_shot=False,
    bandwidth=0,
    payment_type="string",
    period=0,
    period_unit="string",
    resource_group_id="string",
    reverse_replicate=False,
    rpo=0,
    description="string",
    tags={
        "string": "string",
    })
Copy
const diskReplicaPairResource = new alicloud.ebs.DiskReplicaPair("diskReplicaPairResource", {
    diskId: "string",
    sourceZoneId: "string",
    destinationDiskId: "string",
    destinationRegionId: "string",
    destinationZoneId: "string",
    diskReplicaPairName: "string",
    oneShot: false,
    bandwidth: 0,
    paymentType: "string",
    period: 0,
    periodUnit: "string",
    resourceGroupId: "string",
    reverseReplicate: false,
    rpo: 0,
    description: "string",
    tags: {
        string: "string",
    },
});
Copy
type: alicloud:ebs:DiskReplicaPair
properties:
    bandwidth: 0
    description: string
    destinationDiskId: string
    destinationRegionId: string
    destinationZoneId: string
    diskId: string
    diskReplicaPairName: string
    oneShot: false
    paymentType: string
    period: 0
    periodUnit: string
    resourceGroupId: string
    reverseReplicate: false
    rpo: 0
    sourceZoneId: string
    tags:
        string: string
Copy

DiskReplicaPair Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DiskReplicaPair resource accepts the following input properties:

DestinationDiskId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the standby disk.
DestinationRegionId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the region to which the disaster recovery site belongs.
DestinationZoneId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the zone to which the disaster recovery site belongs.
DiskId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the primary disk.
SourceZoneId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the zone to which the production site belongs.
Bandwidth Changes to this property will trigger replacement. int

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

Description string
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
DiskReplicaPairName string
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
OneShot bool

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

PairName string
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

PaymentType Changes to this property will trigger replacement. string
The payment type of the resource
Period int
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
PeriodUnit string

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

ResourceGroupId string
The ID of the resource group
ReverseReplicate bool
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
Rpo Changes to this property will trigger replacement. int
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
Tags Dictionary<string, string>

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

DestinationDiskId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the standby disk.
DestinationRegionId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the region to which the disaster recovery site belongs.
DestinationZoneId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the zone to which the disaster recovery site belongs.
DiskId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the primary disk.
SourceZoneId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the zone to which the production site belongs.
Bandwidth Changes to this property will trigger replacement. int

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

Description string
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
DiskReplicaPairName string
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
OneShot bool

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

PairName string
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

PaymentType Changes to this property will trigger replacement. string
The payment type of the resource
Period int
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
PeriodUnit string

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

ResourceGroupId string
The ID of the resource group
ReverseReplicate bool
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
Rpo Changes to this property will trigger replacement. int
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
Tags map[string]string

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

destinationDiskId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the standby disk.
destinationRegionId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the region to which the disaster recovery site belongs.
destinationZoneId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the zone to which the disaster recovery site belongs.
diskId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the primary disk.
sourceZoneId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the zone to which the production site belongs.
bandwidth Changes to this property will trigger replacement. Integer

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

description String
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
diskReplicaPairName String
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
oneShot Boolean

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

pairName String
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

paymentType Changes to this property will trigger replacement. String
The payment type of the resource
period Integer
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
periodUnit String

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

resourceGroupId String
The ID of the resource group
reverseReplicate Boolean
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
rpo Changes to this property will trigger replacement. Integer
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
tags Map<String,String>

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

destinationDiskId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the standby disk.
destinationRegionId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the region to which the disaster recovery site belongs.
destinationZoneId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the zone to which the disaster recovery site belongs.
diskId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the primary disk.
sourceZoneId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the zone to which the production site belongs.
bandwidth Changes to this property will trigger replacement. number

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

description string
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
diskReplicaPairName string
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
oneShot boolean

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

pairName string
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

paymentType Changes to this property will trigger replacement. string
The payment type of the resource
period number
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
periodUnit string

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

resourceGroupId string
The ID of the resource group
reverseReplicate boolean
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
rpo Changes to this property will trigger replacement. number
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
tags {[key: string]: string}

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

destination_disk_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the standby disk.
destination_region_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the region to which the disaster recovery site belongs.
destination_zone_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the zone to which the disaster recovery site belongs.
disk_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the primary disk.
source_zone_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the zone to which the production site belongs.
bandwidth Changes to this property will trigger replacement. int

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

description str
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
disk_replica_pair_name str
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
one_shot bool

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

pair_name str
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

payment_type Changes to this property will trigger replacement. str
The payment type of the resource
period int
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
period_unit str

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

resource_group_id str
The ID of the resource group
reverse_replicate bool
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
rpo Changes to this property will trigger replacement. int
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
tags Mapping[str, str]

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

destinationDiskId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the standby disk.
destinationRegionId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the region to which the disaster recovery site belongs.
destinationZoneId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the zone to which the disaster recovery site belongs.
diskId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the primary disk.
sourceZoneId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the zone to which the production site belongs.
bandwidth Changes to this property will trigger replacement. Number

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

description String
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
diskReplicaPairName String
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
oneShot Boolean

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

pairName String
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

paymentType Changes to this property will trigger replacement. String
The payment type of the resource
period Number
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
periodUnit String

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

resourceGroupId String
The ID of the resource group
reverseReplicate Boolean
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
rpo Changes to this property will trigger replacement. Number
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
tags Map<String>

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

Outputs

All input properties are implicitly available as output properties. Additionally, the DiskReplicaPair resource produces the following output properties:

CreateTime int
The creation time of the resource
Id string
The provider-assigned unique ID for this managed resource.
RegionId string
The region ID of the resource
Status string
The status of the resource
CreateTime int
The creation time of the resource
Id string
The provider-assigned unique ID for this managed resource.
RegionId string
The region ID of the resource
Status string
The status of the resource
createTime Integer
The creation time of the resource
id String
The provider-assigned unique ID for this managed resource.
regionId String
The region ID of the resource
status String
The status of the resource
createTime number
The creation time of the resource
id string
The provider-assigned unique ID for this managed resource.
regionId string
The region ID of the resource
status string
The status of the resource
create_time int
The creation time of the resource
id str
The provider-assigned unique ID for this managed resource.
region_id str
The region ID of the resource
status str
The status of the resource
createTime Number
The creation time of the resource
id String
The provider-assigned unique ID for this managed resource.
regionId String
The region ID of the resource
status String
The status of the resource

Look up Existing DiskReplicaPair Resource

Get an existing DiskReplicaPair resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DiskReplicaPairState, opts?: CustomResourceOptions): DiskReplicaPair
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bandwidth: Optional[int] = None,
        create_time: Optional[int] = None,
        description: Optional[str] = None,
        destination_disk_id: Optional[str] = None,
        destination_region_id: Optional[str] = None,
        destination_zone_id: Optional[str] = None,
        disk_id: Optional[str] = None,
        disk_replica_pair_name: Optional[str] = None,
        one_shot: Optional[bool] = None,
        pair_name: Optional[str] = None,
        payment_type: Optional[str] = None,
        period: Optional[int] = None,
        period_unit: Optional[str] = None,
        region_id: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        reverse_replicate: Optional[bool] = None,
        rpo: Optional[int] = None,
        source_zone_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> DiskReplicaPair
func GetDiskReplicaPair(ctx *Context, name string, id IDInput, state *DiskReplicaPairState, opts ...ResourceOption) (*DiskReplicaPair, error)
public static DiskReplicaPair Get(string name, Input<string> id, DiskReplicaPairState? state, CustomResourceOptions? opts = null)
public static DiskReplicaPair get(String name, Output<String> id, DiskReplicaPairState state, CustomResourceOptions options)
resources:  _:    type: alicloud:ebs:DiskReplicaPair    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Bandwidth Changes to this property will trigger replacement. int

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

CreateTime int
The creation time of the resource
Description string
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
DestinationDiskId Changes to this property will trigger replacement. string
The ID of the standby disk.
DestinationRegionId Changes to this property will trigger replacement. string
The ID of the region to which the disaster recovery site belongs.
DestinationZoneId Changes to this property will trigger replacement. string
The ID of the zone to which the disaster recovery site belongs.
DiskId Changes to this property will trigger replacement. string
The ID of the primary disk.
DiskReplicaPairName string
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
OneShot bool

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

PairName string
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

PaymentType Changes to this property will trigger replacement. string
The payment type of the resource
Period int
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
PeriodUnit string

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

RegionId string
The region ID of the resource
ResourceGroupId string
The ID of the resource group
ReverseReplicate bool
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
Rpo Changes to this property will trigger replacement. int
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
SourceZoneId Changes to this property will trigger replacement. string
The ID of the zone to which the production site belongs.
Status string
The status of the resource
Tags Dictionary<string, string>

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

Bandwidth Changes to this property will trigger replacement. int

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

CreateTime int
The creation time of the resource
Description string
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
DestinationDiskId Changes to this property will trigger replacement. string
The ID of the standby disk.
DestinationRegionId Changes to this property will trigger replacement. string
The ID of the region to which the disaster recovery site belongs.
DestinationZoneId Changes to this property will trigger replacement. string
The ID of the zone to which the disaster recovery site belongs.
DiskId Changes to this property will trigger replacement. string
The ID of the primary disk.
DiskReplicaPairName string
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
OneShot bool

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

PairName string
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

PaymentType Changes to this property will trigger replacement. string
The payment type of the resource
Period int
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
PeriodUnit string

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

RegionId string
The region ID of the resource
ResourceGroupId string
The ID of the resource group
ReverseReplicate bool
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
Rpo Changes to this property will trigger replacement. int
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
SourceZoneId Changes to this property will trigger replacement. string
The ID of the zone to which the production site belongs.
Status string
The status of the resource
Tags map[string]string

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

bandwidth Changes to this property will trigger replacement. Integer

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

createTime Integer
The creation time of the resource
description String
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
destinationDiskId Changes to this property will trigger replacement. String
The ID of the standby disk.
destinationRegionId Changes to this property will trigger replacement. String
The ID of the region to which the disaster recovery site belongs.
destinationZoneId Changes to this property will trigger replacement. String
The ID of the zone to which the disaster recovery site belongs.
diskId Changes to this property will trigger replacement. String
The ID of the primary disk.
diskReplicaPairName String
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
oneShot Boolean

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

pairName String
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

paymentType Changes to this property will trigger replacement. String
The payment type of the resource
period Integer
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
periodUnit String

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

regionId String
The region ID of the resource
resourceGroupId String
The ID of the resource group
reverseReplicate Boolean
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
rpo Changes to this property will trigger replacement. Integer
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
sourceZoneId Changes to this property will trigger replacement. String
The ID of the zone to which the production site belongs.
status String
The status of the resource
tags Map<String,String>

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

bandwidth Changes to this property will trigger replacement. number

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

createTime number
The creation time of the resource
description string
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
destinationDiskId Changes to this property will trigger replacement. string
The ID of the standby disk.
destinationRegionId Changes to this property will trigger replacement. string
The ID of the region to which the disaster recovery site belongs.
destinationZoneId Changes to this property will trigger replacement. string
The ID of the zone to which the disaster recovery site belongs.
diskId Changes to this property will trigger replacement. string
The ID of the primary disk.
diskReplicaPairName string
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
oneShot boolean

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

pairName string
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

paymentType Changes to this property will trigger replacement. string
The payment type of the resource
period number
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
periodUnit string

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

regionId string
The region ID of the resource
resourceGroupId string
The ID of the resource group
reverseReplicate boolean
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
rpo Changes to this property will trigger replacement. number
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
sourceZoneId Changes to this property will trigger replacement. string
The ID of the zone to which the production site belongs.
status string
The status of the resource
tags {[key: string]: string}

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

bandwidth Changes to this property will trigger replacement. int

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

create_time int
The creation time of the resource
description str
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
destination_disk_id Changes to this property will trigger replacement. str
The ID of the standby disk.
destination_region_id Changes to this property will trigger replacement. str
The ID of the region to which the disaster recovery site belongs.
destination_zone_id Changes to this property will trigger replacement. str
The ID of the zone to which the disaster recovery site belongs.
disk_id Changes to this property will trigger replacement. str
The ID of the primary disk.
disk_replica_pair_name str
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
one_shot bool

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

pair_name str
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

payment_type Changes to this property will trigger replacement. str
The payment type of the resource
period int
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
period_unit str

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

region_id str
The region ID of the resource
resource_group_id str
The ID of the resource group
reverse_replicate bool
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
rpo Changes to this property will trigger replacement. int
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
source_zone_id Changes to this property will trigger replacement. str
The ID of the zone to which the production site belongs.
status str
The status of the resource
tags Mapping[str, str]

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

bandwidth Changes to this property will trigger replacement. Number

The bandwidth for asynchronous data replication between cloud disks. The unit is Kbps. Value range:

  • 10240 Kbps: equal to 10 Mbps.
  • 20480 Kbps: equal to 20 Mbps.
  • 51200 Kbps: equal to 50 Mbps.
  • 102400 Kbps: equal to 100 Mbps.

Default value: 10240. This parameter cannot be specified when the ChargeType value is PayAsYouGo The system value is 0, which indicates that the disk is dynamically allocated according to data write changes during asynchronous replication.

createTime Number
The creation time of the resource
description String
The description of the asynchronous replication relationship. 2 to 256 English or Chinese characters in length and cannot start with' http:// 'or' https.
destinationDiskId Changes to this property will trigger replacement. String
The ID of the standby disk.
destinationRegionId Changes to this property will trigger replacement. String
The ID of the region to which the disaster recovery site belongs.
destinationZoneId Changes to this property will trigger replacement. String
The ID of the zone to which the disaster recovery site belongs.
diskId Changes to this property will trigger replacement. String
The ID of the primary disk.
diskReplicaPairName String
The name of the asynchronous replication relationship. The length must be 2 to 128 characters in length and must start with a letter or Chinese name. It cannot start with http:// or https. It can contain Chinese, English, numbers, half-width colons (:), underscores (_), half-width periods (.), or dashes (-).
oneShot Boolean

Whether to synchronize immediately. Value range:

  • true: Start data synchronization immediately.
  • false: Data Synchronization starts after the RPO time period.

Default value: false.

pairName String
. Field 'pair_name' has been deprecated from provider version 1.245.0. New field 'disk_replica_pair_name' instead.

Deprecated: Field 'pair_name' has been deprecated since provider version 1.245.0. New field 'disk_replica_pair_name' instead.

paymentType Changes to this property will trigger replacement. String
The payment type of the resource
period Number
The purchase duration of the asynchronous replication relationship. This parameter is required when 'ChargeType = PrePay. The duration unit is specified by'periodunit', and the value range is:

  • When 'PeriodUnit = Week', the value range of this parameter is 1, 2, 3, and 4.
  • When 'PeriodUnit = Month', the value range of this parameter is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.
periodUnit String

The unit of the purchase time of the asynchronous replication relationship. Value range:

  • Week: Week.
  • Month: Month.

Default value: Month.

regionId String
The region ID of the resource
resourceGroupId String
The ID of the resource group
reverseReplicate Boolean
Specifies whether to enable the reverse replication sub-feature. Valid values: true and false. Default value: true.
rpo Changes to this property will trigger replacement. Number
The RPO value set by the consistency group in seconds. Currently only 900 seconds are supported.
sourceZoneId Changes to this property will trigger replacement. String
The ID of the zone to which the production site belongs.
status String
The status of the resource
tags Map<String>

The tag of the resource

The following arguments will be discarded. Please use new fields as soon as possible:

Import

Elastic Block Storage(EBS) Disk Replica Pair can be imported using the id, e.g.

$ pulumi import alicloud:ebs/diskReplicaPair:DiskReplicaPair example <id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.