VolumeReplicationState class

Input properties used for looking up and filtering VolumeReplication resources.

Constructors

VolumeReplicationState({Input<String?>? createTime, Input<bool?>? deleteDestinationVolume, Input<String?>? deletionPolicy, Input<String?>? description, Input<String?>? destinationVolume, Input<VolumeReplicationDestinationVolumeParameters?>? destinationVolumeParameters, Input<Map<String, String>?>? effectiveLabels, Input<bool?>? forceStopping, Input<bool?>? healthy, Input<List<VolumeReplicationHybridPeeringDetail>?>? hybridPeeringDetails, Input<String?>? hybridReplicationType, Input<List<VolumeReplicationHybridReplicationUserCommand>?>? hybridReplicationUserCommands, Input<Map<String, String>?>? labels, Input<String?>? location, Input<String?>? mirrorState, Input<String?>? name, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<bool?>? replicationEnabled, Input<String?>? replicationSchedule, Input<String?>? role, Input<String?>? sourceVolume, Input<String?>? state, Input<String?>? stateDetails, Input<List<VolumeReplicationTransferStat>?>? transferStats, Input<String?>? volumeName, Input<bool?>? waitForMirror})
Creates a new VolumeReplicationState. createTime Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z". deleteDestinationVolume A destination volume is created as part of replication creation. The destination volume will not became deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description An description of this resource. destinationVolume Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}} destinationVolumeParameters Destination volume parameters. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. forceStopping Only replications with mirror_state=MIRRORED can be stopped. A replication in mirror_state=TRANSFERRING healthy Condition of the relationship. Can be one of the following: hybridPeeringDetails HybridPeeringDetails contains details about the hybrid peering. hybridReplicationType Hybrid replication type. hybridReplicationUserCommands Copy pastable snapmirror commands to be executed on onprem cluster by the customer. labels Labels as key value pairs. Example: { "owner": "Bob", "department": "finance", "purpose": "testing" } location Name of region for this resource. The resource needs to be created in the region of the destination volume. mirrorState Indicates the state of the mirror between source and destination volumes. Depending on the amount of data name The name of the replication. Needs to be unique per location. project The ID of the project in which the resource belongs. pulumiLabels The combination of labels configured directly on the resource replicationEnabled Set to false to stop/break the mirror. Stopping the mirror makes the destination volume read-write replicationSchedule Specifies the replication interval. role Reverting a replication can swap source and destination volume roles. This field indicates if the location hosts sourceVolume Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}} state Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState. stateDetails State details of the replication resource. transferStats Replication transfer statistics. All statistics are updated every 5 minutes. volumeName The name of the existing source volume. waitForMirror Replication resource state is independent of mirror_state. With enough data, it can take many hours
const
VolumeReplicationState.fromMap(Map<String, dynamic> map)
factory

Properties

createTime → Input<String?>?
Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
final
deleteDestinationVolume → Input<bool?>?
A destination volume is created as part of replication creation. The destination volume will not became under Terraform management unless you import it manually. If you delete the replication, this volume will remain. Setting this parameter to true will delete the current destination volume when destroying the replication. If you reversed the replication direction, this will be your former source volume! For production use, it is recommended to keep this parameter false to avoid accidental volume deletion. Handle with care. Default is false.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
An description of this resource.
final
destinationVolume → Input<String?>?
Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
final
destinationVolumeParameters → Input<VolumeReplicationDestinationVolumeParameters?>?
Destination volume parameters. Structure is documented below.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
forceStopping → Input<bool?>?
Only replications with mirror_state=MIRRORED can be stopped. A replication in mirror_state=TRANSFERRING currently receives an update and stopping the update might be undesirable. Set this parameter to true to stop anyway. All data transferred to the destination will be discarded and content of destination volume will remain at the state of the last successful update. Default is false.
final
hashCode → int
The hash code for this object.
no setterinherited
healthy → Input<bool?>?
Condition of the relationship. Can be one of the following:
final
hybridPeeringDetails → Input<List<VolumeReplicationHybridPeeringDetail>?>?
HybridPeeringDetails contains details about the hybrid peering. Structure is documented below.
final
hybridReplicationType → Input<String?>?
Hybrid replication type.
final
hybridReplicationUserCommands → Input<List<VolumeReplicationHybridReplicationUserCommand>?>?
Copy pastable snapmirror commands to be executed on onprem cluster by the customer. Structure is documented below.
final
labels → Input<Map<String, String>?>?
Labels as key value pairs. Example: { "owner": "Bob", "department": "finance", "purpose": "testing" }
final
location → Input<String?>?
Name of region for this resource. The resource needs to be created in the region of the destination volume.
final
mirrorState → Input<String?>?
Indicates the state of the mirror between source and destination volumes. Depending on the amount of data in your source volume, PREPARING phase can take hours or days. mirrorState = MIRRORED indicates your baseline transfer ended and destination volume became accessible read-only. TRANSFERRING means a MIRRORED volume currently receives an update. Updated every 5 minutes.
final
name → Input<String?>?
The name of the replication. Needs to be unique per location.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
replicationEnabled → Input<bool?>?
Set to false to stop/break the mirror. Stopping the mirror makes the destination volume read-write and act independently from the source volume. Set to true to enable/resume the mirror. WARNING: Resuming a mirror overwrites any changes done to the destination volume with the content of the source volume.
final
replicationSchedule → Input<String?>?
Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
final
role → Input<String?>?
Reverting a replication can swap source and destination volume roles. This field indicates if the location hosts the source or destination volume. For resume and revert and resume operations it is critical to understand which volume is the source volume, since it will overwrite changes done to the destination volume.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceVolume → Input<String?>?
Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
final
state → Input<String?>?
Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
final
stateDetails → Input<String?>?
State details of the replication resource.
final
transferStats → Input<List<VolumeReplicationTransferStat>?>?
Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
final
volumeName → Input<String?>?
The name of the existing source volume.
final
waitForMirror → Input<bool?>?
Replication resource state is independent of mirror_state. With enough data, it can take many hours for mirrorState to reach MIRRORED. If you want Terraform to wait for the mirror to finish on create/stop/resume operations, set this parameter to true. Default is false.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited