import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Volume replication creates an asynchronous mirror of a volume in a different location. This capability * lets you use the replicated volume for critical application activity in case of a location-wide outage * or disaster. * * A new destination volume is created as part of the replication resource. It's content is updated on a * schedule with content of the source volume. It can be used as a read-only copy while the mirror is * enabled, or as an independent read-write volume while the mirror is stopped. A destination volume will * also contain the snapshots of the source volume. Resuming a mirror will overwrite all changes on the * destination volume with the content of the source volume. While is mirror is enabled, all configuration * changes done to source or destination volumes are automatically done to both. Please note that the * destination volume is not a resource managed by Terraform. * * Reversing the replication direction is not supported through the provider. * * To get more information about VolumeReplication, see: * * * [API documentation](https://cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.volumes.replications) * * How-to Guides * * [Documentation](https://cloud.google.com/netapp/volumes/docs/protect-data/about-volume-replication) * * ## Example Usage * * ### Netapp Volume Replication Create * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = gcp.compute.getNetwork({ * name: "test-network", * }); * const sourcePool = new gcp.netapp.StoragePool("source_pool", { * name: "source-pool", * location: "us-central1", * serviceLevel: "PREMIUM", * capacityGib: "2048", * network: _default.then(_default => _default.id), * }); * const destinationPool = new gcp.netapp.StoragePool("destination_pool", { * name: "destination-pool", * location: "us-west2", * serviceLevel: "PREMIUM", * capacityGib: "2048", * network: _default.then(_default => _default.id), * allowAutoTiering: true, * }); * const sourceVolume = new gcp.netapp.Volume("source_volume", { * location: sourcePool.location, * name: "source-volume", * capacityGib: "100", * shareName: "source-volume", * storagePool: sourcePool.name, * protocols: ["NFSV3"], * deletionPolicy: "FORCE", * }); * const testReplication = new gcp.netapp.VolumeReplication("test_replication", { * location: sourceVolume.location, * volumeName: sourceVolume.name, * name: "test-replication", * replicationSchedule: "EVERY_10_MINUTES", * description: "This is a replication resource", * destinationVolumeParameters: { * storagePool: destinationPool.id, * volumeId: "destination-volume", * shareName: "source-volume", * description: "This is a replicated volume", * tieringPolicy: { * coolingThresholdDays: 20, * tierAction: "ENABLED", * }, * }, * deleteDestinationVolume: true, * waitForMirror: true, * }, { * dependsOn: [sourceVolume], * }); * ``` * * ## Import * * VolumeReplication can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/volumes/{{volume_name}}/replications/{{name}}` * * `{{project}}/{{location}}/{{volume_name}}/{{name}}` * * `{{location}}/{{volume_name}}/{{name}}` * * When using the `pulumi import` command, VolumeReplication can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:netapp/volumeReplication:VolumeReplication default projects/{{project}}/locations/{{location}}/volumes/{{volume_name}}/replications/{{name}} * $ pulumi import gcp:netapp/volumeReplication:VolumeReplication default {{project}}/{{location}}/{{volume_name}}/{{name}} * $ pulumi import gcp:netapp/volumeReplication:VolumeReplication default {{location}}/{{volume_name}}/{{name}} * ``` */ export declare class VolumeReplication extends pulumi.CustomResource { /** * Get an existing VolumeReplication resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: VolumeReplicationState, opts?: pulumi.CustomResourceOptions): VolumeReplication; /** * Returns true if the given object is an instance of VolumeReplication. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is VolumeReplication; /** * Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z". */ readonly createTime: pulumi.Output; /** * 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. */ readonly deleteDestinationVolume: pulumi.Output; /** * 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. */ readonly deletionPolicy: pulumi.Output; /** * An description of this resource. */ readonly description: pulumi.Output; /** * Full resource name of destination volume with format: `projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}` */ readonly destinationVolume: pulumi.Output; /** * Destination volume parameters. * Structure is documented below. */ readonly destinationVolumeParameters: pulumi.Output; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * 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. */ readonly forceStopping: pulumi.Output; /** * Condition of the relationship. Can be one of the following: * - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. * - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer. */ readonly healthy: pulumi.Output; /** * HybridPeeringDetails contains details about the hybrid peering. * Structure is documented below. */ readonly hybridPeeringDetails: pulumi.Output; /** * Hybrid replication type. */ readonly hybridReplicationType: pulumi.Output; /** * Copy pastable snapmirror commands to be executed on onprem cluster by the customer. * Structure is documented below. */ readonly hybridReplicationUserCommands: pulumi.Output; /** * Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }` * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Name of region for this resource. The resource needs to be created in the region of the destination volume. */ readonly location: pulumi.Output; /** * 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. */ readonly mirrorState: pulumi.Output; /** * The name of the replication. Needs to be unique per location. */ readonly name: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * 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. */ readonly replicationEnabled: pulumi.Output; /** * Specifies the replication interval. * Possible values are: `EVERY_10_MINUTES`, `HOURLY`, `DAILY`. */ readonly replicationSchedule: pulumi.Output; /** * 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. */ readonly role: pulumi.Output; /** * Full resource name of source volume with format: `projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}` */ readonly sourceVolume: pulumi.Output; /** * Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState. */ readonly state: pulumi.Output; /** * State details of the replication resource. */ readonly stateDetails: pulumi.Output; /** * Replication transfer statistics. All statistics are updated every 5 minutes. * Structure is documented below. */ readonly transferStats: pulumi.Output; /** * The name of the existing source volume. */ readonly volumeName: pulumi.Output; /** * 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. */ readonly waitForMirror: pulumi.Output; /** * Create a VolumeReplication resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: VolumeReplicationArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering VolumeReplication resources. */ export interface VolumeReplicationState { /** * Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z". */ createTime?: pulumi.Input; /** * 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. */ deleteDestinationVolume?: pulumi.Input; /** * 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. */ deletionPolicy?: pulumi.Input; /** * An description of this resource. */ description?: pulumi.Input; /** * Full resource name of destination volume with format: `projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}` */ destinationVolume?: pulumi.Input; /** * Destination volume parameters. * Structure is documented below. */ destinationVolumeParameters?: pulumi.Input; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * 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. */ forceStopping?: pulumi.Input; /** * Condition of the relationship. Can be one of the following: * - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. * - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer. */ healthy?: pulumi.Input; /** * HybridPeeringDetails contains details about the hybrid peering. * Structure is documented below. */ hybridPeeringDetails?: pulumi.Input[] | undefined>; /** * Hybrid replication type. */ hybridReplicationType?: pulumi.Input; /** * Copy pastable snapmirror commands to be executed on onprem cluster by the customer. * Structure is documented below. */ hybridReplicationUserCommands?: pulumi.Input[] | undefined>; /** * Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }` * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Name of region for this resource. The resource needs to be created in the region of the destination volume. */ location?: pulumi.Input; /** * 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. */ mirrorState?: pulumi.Input; /** * The name of the replication. Needs to be unique per location. */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * 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. */ replicationEnabled?: pulumi.Input; /** * Specifies the replication interval. * Possible values are: `EVERY_10_MINUTES`, `HOURLY`, `DAILY`. */ replicationSchedule?: pulumi.Input; /** * 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. */ role?: pulumi.Input; /** * Full resource name of source volume with format: `projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}` */ sourceVolume?: pulumi.Input; /** * Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState. */ state?: pulumi.Input; /** * State details of the replication resource. */ stateDetails?: pulumi.Input; /** * Replication transfer statistics. All statistics are updated every 5 minutes. * Structure is documented below. */ transferStats?: pulumi.Input[] | undefined>; /** * The name of the existing source volume. */ volumeName?: pulumi.Input; /** * 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. */ waitForMirror?: pulumi.Input; } /** * The set of arguments for constructing a VolumeReplication resource. */ export interface VolumeReplicationArgs { /** * 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. */ deleteDestinationVolume?: pulumi.Input; /** * 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. */ deletionPolicy?: pulumi.Input; /** * An description of this resource. */ description?: pulumi.Input; /** * Destination volume parameters. * Structure is documented below. */ destinationVolumeParameters?: pulumi.Input; /** * 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. */ forceStopping?: pulumi.Input; /** * Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }` * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Name of region for this resource. The resource needs to be created in the region of the destination volume. */ location: pulumi.Input; /** * The name of the replication. Needs to be unique per location. */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * 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. */ replicationEnabled?: pulumi.Input; /** * Specifies the replication interval. * Possible values are: `EVERY_10_MINUTES`, `HOURLY`, `DAILY`. */ replicationSchedule: pulumi.Input; /** * The name of the existing source volume. */ volumeName: pulumi.Input; /** * 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. */ waitForMirror?: pulumi.Input; } //# sourceMappingURL=volumeReplication.d.ts.map