1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. netapp
  5. VolumeReplication
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

gcp.netapp.VolumeReplication

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

    Example Usage

    Netapp Volume Replication Create

    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),
    });
    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",
        },
        deleteDestinationVolume: true,
        waitForMirror: true,
    }, {
        dependsOn: [sourceVolume],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    default = gcp.compute.get_network(name="test-network")
    source_pool = gcp.netapp.StoragePool("source_pool",
        name="source-pool",
        location="us-central1",
        service_level="PREMIUM",
        capacity_gib="2048",
        network=default.id)
    destination_pool = gcp.netapp.StoragePool("destination_pool",
        name="destination-pool",
        location="us-west2",
        service_level="PREMIUM",
        capacity_gib="2048",
        network=default.id)
    source_volume = gcp.netapp.Volume("source_volume",
        location=source_pool.location,
        name="source-volume",
        capacity_gib="100",
        share_name="source-volume",
        storage_pool=source_pool.name,
        protocols=["NFSV3"],
        deletion_policy="FORCE")
    test_replication = gcp.netapp.VolumeReplication("test_replication",
        location=source_volume.location,
        volume_name=source_volume.name,
        name="test-replication",
        replication_schedule="EVERY_10_MINUTES",
        description="This is a replication resource",
        destination_volume_parameters={
            "storage_pool": destination_pool.id,
            "volume_id": "destination-volume",
            "share_name": "source-volume",
            "description": "This is a replicated volume",
        },
        delete_destination_volume=True,
        wait_for_mirror=True,
        opts = pulumi.ResourceOptions(depends_on=[source_volume]))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/netapp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_default, err := compute.LookupNetwork(ctx, &compute.LookupNetworkArgs{
    			Name: "test-network",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		sourcePool, err := netapp.NewStoragePool(ctx, "source_pool", &netapp.StoragePoolArgs{
    			Name:         pulumi.String("source-pool"),
    			Location:     pulumi.String("us-central1"),
    			ServiceLevel: pulumi.String("PREMIUM"),
    			CapacityGib:  pulumi.String("2048"),
    			Network:      pulumi.String(_default.Id),
    		})
    		if err != nil {
    			return err
    		}
    		destinationPool, err := netapp.NewStoragePool(ctx, "destination_pool", &netapp.StoragePoolArgs{
    			Name:         pulumi.String("destination-pool"),
    			Location:     pulumi.String("us-west2"),
    			ServiceLevel: pulumi.String("PREMIUM"),
    			CapacityGib:  pulumi.String("2048"),
    			Network:      pulumi.String(_default.Id),
    		})
    		if err != nil {
    			return err
    		}
    		sourceVolume, err := netapp.NewVolume(ctx, "source_volume", &netapp.VolumeArgs{
    			Location:    sourcePool.Location,
    			Name:        pulumi.String("source-volume"),
    			CapacityGib: pulumi.String("100"),
    			ShareName:   pulumi.String("source-volume"),
    			StoragePool: sourcePool.Name,
    			Protocols: pulumi.StringArray{
    				pulumi.String("NFSV3"),
    			},
    			DeletionPolicy: pulumi.String("FORCE"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = netapp.NewVolumeReplication(ctx, "test_replication", &netapp.VolumeReplicationArgs{
    			Location:            sourceVolume.Location,
    			VolumeName:          sourceVolume.Name,
    			Name:                pulumi.String("test-replication"),
    			ReplicationSchedule: pulumi.String("EVERY_10_MINUTES"),
    			Description:         pulumi.String("This is a replication resource"),
    			DestinationVolumeParameters: &netapp.VolumeReplicationDestinationVolumeParametersArgs{
    				StoragePool: destinationPool.ID(),
    				VolumeId:    pulumi.String("destination-volume"),
    				ShareName:   pulumi.String("source-volume"),
    				Description: pulumi.String("This is a replicated volume"),
    			},
    			DeleteDestinationVolume: pulumi.Bool(true),
    			WaitForMirror:           pulumi.Bool(true),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			sourceVolume,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = Gcp.Compute.GetNetwork.Invoke(new()
        {
            Name = "test-network",
        });
    
        var sourcePool = new Gcp.Netapp.StoragePool("source_pool", new()
        {
            Name = "source-pool",
            Location = "us-central1",
            ServiceLevel = "PREMIUM",
            CapacityGib = "2048",
            Network = @default.Apply(@default => @default.Apply(getNetworkResult => getNetworkResult.Id)),
        });
    
        var destinationPool = new Gcp.Netapp.StoragePool("destination_pool", new()
        {
            Name = "destination-pool",
            Location = "us-west2",
            ServiceLevel = "PREMIUM",
            CapacityGib = "2048",
            Network = @default.Apply(@default => @default.Apply(getNetworkResult => getNetworkResult.Id)),
        });
    
        var sourceVolume = new Gcp.Netapp.Volume("source_volume", new()
        {
            Location = sourcePool.Location,
            Name = "source-volume",
            CapacityGib = "100",
            ShareName = "source-volume",
            StoragePool = sourcePool.Name,
            Protocols = new[]
            {
                "NFSV3",
            },
            DeletionPolicy = "FORCE",
        });
    
        var testReplication = new Gcp.Netapp.VolumeReplication("test_replication", new()
        {
            Location = sourceVolume.Location,
            VolumeName = sourceVolume.Name,
            Name = "test-replication",
            ReplicationSchedule = "EVERY_10_MINUTES",
            Description = "This is a replication resource",
            DestinationVolumeParameters = new Gcp.Netapp.Inputs.VolumeReplicationDestinationVolumeParametersArgs
            {
                StoragePool = destinationPool.Id,
                VolumeId = "destination-volume",
                ShareName = "source-volume",
                Description = "This is a replicated volume",
            },
            DeleteDestinationVolume = true,
            WaitForMirror = true,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                sourceVolume,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.compute.ComputeFunctions;
    import com.pulumi.gcp.compute.inputs.GetNetworkArgs;
    import com.pulumi.gcp.netapp.StoragePool;
    import com.pulumi.gcp.netapp.StoragePoolArgs;
    import com.pulumi.gcp.netapp.Volume;
    import com.pulumi.gcp.netapp.VolumeArgs;
    import com.pulumi.gcp.netapp.VolumeReplication;
    import com.pulumi.gcp.netapp.VolumeReplicationArgs;
    import com.pulumi.gcp.netapp.inputs.VolumeReplicationDestinationVolumeParametersArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var default = ComputeFunctions.getNetwork(GetNetworkArgs.builder()
                .name("test-network")
                .build());
    
            var sourcePool = new StoragePool("sourcePool", StoragePoolArgs.builder()
                .name("source-pool")
                .location("us-central1")
                .serviceLevel("PREMIUM")
                .capacityGib(2048)
                .network(default_.id())
                .build());
    
            var destinationPool = new StoragePool("destinationPool", StoragePoolArgs.builder()
                .name("destination-pool")
                .location("us-west2")
                .serviceLevel("PREMIUM")
                .capacityGib(2048)
                .network(default_.id())
                .build());
    
            var sourceVolume = new Volume("sourceVolume", VolumeArgs.builder()
                .location(sourcePool.location())
                .name("source-volume")
                .capacityGib(100)
                .shareName("source-volume")
                .storagePool(sourcePool.name())
                .protocols("NFSV3")
                .deletionPolicy("FORCE")
                .build());
    
            var testReplication = new VolumeReplication("testReplication", VolumeReplicationArgs.builder()
                .location(sourceVolume.location())
                .volumeName(sourceVolume.name())
                .name("test-replication")
                .replicationSchedule("EVERY_10_MINUTES")
                .description("This is a replication resource")
                .destinationVolumeParameters(VolumeReplicationDestinationVolumeParametersArgs.builder()
                    .storagePool(destinationPool.id())
                    .volumeId("destination-volume")
                    .shareName("source-volume")
                    .description("This is a replicated volume")
                    .build())
                .deleteDestinationVolume(true)
                .waitForMirror(true)
                .build(), CustomResourceOptions.builder()
                    .dependsOn(sourceVolume)
                    .build());
    
        }
    }
    
    resources:
      sourcePool:
        type: gcp:netapp:StoragePool
        name: source_pool
        properties:
          name: source-pool
          location: us-central1
          serviceLevel: PREMIUM
          capacityGib: 2048
          network: ${default.id}
      destinationPool:
        type: gcp:netapp:StoragePool
        name: destination_pool
        properties:
          name: destination-pool
          location: us-west2
          serviceLevel: PREMIUM
          capacityGib: 2048
          network: ${default.id}
      sourceVolume:
        type: gcp:netapp:Volume
        name: source_volume
        properties:
          location: ${sourcePool.location}
          name: source-volume
          capacityGib: 100
          shareName: source-volume
          storagePool: ${sourcePool.name}
          protocols:
            - NFSV3
          deletionPolicy: FORCE
      testReplication:
        type: gcp:netapp:VolumeReplication
        name: test_replication
        properties:
          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
          deleteDestinationVolume: true
          waitForMirror: true
        options:
          dependson:
            - ${sourceVolume}
    variables:
      default:
        fn::invoke:
          Function: gcp:compute:getNetwork
          Arguments:
            name: test-network
    

    Create VolumeReplication Resource

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

    Constructor syntax

    new VolumeReplication(name: string, args: VolumeReplicationArgs, opts?: CustomResourceOptions);
    @overload
    def VolumeReplication(resource_name: str,
                          args: VolumeReplicationArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def VolumeReplication(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          location: Optional[str] = None,
                          replication_schedule: Optional[str] = None,
                          volume_name: Optional[str] = None,
                          delete_destination_volume: Optional[bool] = None,
                          description: Optional[str] = None,
                          destination_volume_parameters: Optional[VolumeReplicationDestinationVolumeParametersArgs] = None,
                          force_stopping: Optional[bool] = None,
                          labels: Optional[Mapping[str, str]] = None,
                          name: Optional[str] = None,
                          project: Optional[str] = None,
                          replication_enabled: Optional[bool] = None,
                          wait_for_mirror: Optional[bool] = None)
    func NewVolumeReplication(ctx *Context, name string, args VolumeReplicationArgs, opts ...ResourceOption) (*VolumeReplication, error)
    public VolumeReplication(string name, VolumeReplicationArgs args, CustomResourceOptions? opts = null)
    public VolumeReplication(String name, VolumeReplicationArgs args)
    public VolumeReplication(String name, VolumeReplicationArgs args, CustomResourceOptions options)
    
    type: gcp:netapp:VolumeReplication
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args VolumeReplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VolumeReplicationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VolumeReplicationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeReplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeReplicationArgs
    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 volumeReplicationResource = new Gcp.Netapp.VolumeReplication("volumeReplicationResource", new()
    {
        Location = "string",
        ReplicationSchedule = "string",
        VolumeName = "string",
        DeleteDestinationVolume = false,
        Description = "string",
        DestinationVolumeParameters = new Gcp.Netapp.Inputs.VolumeReplicationDestinationVolumeParametersArgs
        {
            StoragePool = "string",
            Description = "string",
            ShareName = "string",
            VolumeId = "string",
        },
        ForceStopping = false,
        Labels = 
        {
            { "string", "string" },
        },
        Name = "string",
        Project = "string",
        ReplicationEnabled = false,
        WaitForMirror = false,
    });
    
    example, err := netapp.NewVolumeReplication(ctx, "volumeReplicationResource", &netapp.VolumeReplicationArgs{
    	Location:                pulumi.String("string"),
    	ReplicationSchedule:     pulumi.String("string"),
    	VolumeName:              pulumi.String("string"),
    	DeleteDestinationVolume: pulumi.Bool(false),
    	Description:             pulumi.String("string"),
    	DestinationVolumeParameters: &netapp.VolumeReplicationDestinationVolumeParametersArgs{
    		StoragePool: pulumi.String("string"),
    		Description: pulumi.String("string"),
    		ShareName:   pulumi.String("string"),
    		VolumeId:    pulumi.String("string"),
    	},
    	ForceStopping: pulumi.Bool(false),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name:               pulumi.String("string"),
    	Project:            pulumi.String("string"),
    	ReplicationEnabled: pulumi.Bool(false),
    	WaitForMirror:      pulumi.Bool(false),
    })
    
    var volumeReplicationResource = new VolumeReplication("volumeReplicationResource", VolumeReplicationArgs.builder()
        .location("string")
        .replicationSchedule("string")
        .volumeName("string")
        .deleteDestinationVolume(false)
        .description("string")
        .destinationVolumeParameters(VolumeReplicationDestinationVolumeParametersArgs.builder()
            .storagePool("string")
            .description("string")
            .shareName("string")
            .volumeId("string")
            .build())
        .forceStopping(false)
        .labels(Map.of("string", "string"))
        .name("string")
        .project("string")
        .replicationEnabled(false)
        .waitForMirror(false)
        .build());
    
    volume_replication_resource = gcp.netapp.VolumeReplication("volumeReplicationResource",
        location="string",
        replication_schedule="string",
        volume_name="string",
        delete_destination_volume=False,
        description="string",
        destination_volume_parameters={
            "storage_pool": "string",
            "description": "string",
            "share_name": "string",
            "volume_id": "string",
        },
        force_stopping=False,
        labels={
            "string": "string",
        },
        name="string",
        project="string",
        replication_enabled=False,
        wait_for_mirror=False)
    
    const volumeReplicationResource = new gcp.netapp.VolumeReplication("volumeReplicationResource", {
        location: "string",
        replicationSchedule: "string",
        volumeName: "string",
        deleteDestinationVolume: false,
        description: "string",
        destinationVolumeParameters: {
            storagePool: "string",
            description: "string",
            shareName: "string",
            volumeId: "string",
        },
        forceStopping: false,
        labels: {
            string: "string",
        },
        name: "string",
        project: "string",
        replicationEnabled: false,
        waitForMirror: false,
    });
    
    type: gcp:netapp:VolumeReplication
    properties:
        deleteDestinationVolume: false
        description: string
        destinationVolumeParameters:
            description: string
            shareName: string
            storagePool: string
            volumeId: string
        forceStopping: false
        labels:
            string: string
        location: string
        name: string
        project: string
        replicationEnabled: false
        replicationSchedule: string
        volumeName: string
        waitForMirror: false
    

    VolumeReplication 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 VolumeReplication resource accepts the following input properties:

    Location string
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    ReplicationSchedule string
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    VolumeName string
    The name of the existing source volume.
    DeleteDestinationVolume bool
    Description string
    An description of this resource.
    DestinationVolumeParameters VolumeReplicationDestinationVolumeParameters
    Destination volume parameters. Structure is documented below.
    ForceStopping 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.
    Labels Dictionary<string, string>

    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 effective_labels for all of the labels present on the resource.

    Name string
    The name of the replication. Needs to be unique per location.


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ReplicationEnabled 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.
    WaitForMirror bool
    Location string
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    ReplicationSchedule string
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    VolumeName string
    The name of the existing source volume.
    DeleteDestinationVolume bool
    Description string
    An description of this resource.
    DestinationVolumeParameters VolumeReplicationDestinationVolumeParametersArgs
    Destination volume parameters. Structure is documented below.
    ForceStopping 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.
    Labels map[string]string

    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 effective_labels for all of the labels present on the resource.

    Name string
    The name of the replication. Needs to be unique per location.


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ReplicationEnabled 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.
    WaitForMirror bool
    location String
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    replicationSchedule String
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    volumeName String
    The name of the existing source volume.
    deleteDestinationVolume Boolean
    description String
    An description of this resource.
    destinationVolumeParameters VolumeReplicationDestinationVolumeParameters
    Destination volume parameters. Structure is documented below.
    forceStopping Boolean
    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.
    labels Map<String,String>

    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 effective_labels for all of the labels present on the resource.

    name String
    The name of the replication. Needs to be unique per location.


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicationEnabled Boolean
    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.
    waitForMirror Boolean
    location string
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    replicationSchedule string
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    volumeName string
    The name of the existing source volume.
    deleteDestinationVolume boolean
    description string
    An description of this resource.
    destinationVolumeParameters VolumeReplicationDestinationVolumeParameters
    Destination volume parameters. Structure is documented below.
    forceStopping boolean
    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.
    labels {[key: string]: string}

    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 effective_labels for all of the labels present on the resource.

    name string
    The name of the replication. Needs to be unique per location.


    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicationEnabled boolean
    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.
    waitForMirror boolean
    location str
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    replication_schedule str
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    volume_name str
    The name of the existing source volume.
    delete_destination_volume bool
    description str
    An description of this resource.
    destination_volume_parameters VolumeReplicationDestinationVolumeParametersArgs
    Destination volume parameters. Structure is documented below.
    force_stopping 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.
    labels Mapping[str, str]

    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 effective_labels for all of the labels present on the resource.

    name str
    The name of the replication. Needs to be unique per location.


    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replication_enabled 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.
    wait_for_mirror bool
    location String
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    replicationSchedule String
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    volumeName String
    The name of the existing source volume.
    deleteDestinationVolume Boolean
    description String
    An description of this resource.
    destinationVolumeParameters Property Map
    Destination volume parameters. Structure is documented below.
    forceStopping Boolean
    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.
    labels Map<String>

    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 effective_labels for all of the labels present on the resource.

    name String
    The name of the replication. Needs to be unique per location.


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicationEnabled Boolean
    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.
    waitForMirror Boolean

    Outputs

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

    CreateTime string
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    DestinationVolume string
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Healthy bool
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    MirrorState 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.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Role 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.
    SourceVolume string
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    State string
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    StateDetails string
    State details of the replication resource.
    TransferStats List<VolumeReplicationTransferStat>
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
    CreateTime string
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    DestinationVolume string
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    EffectiveLabels 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.
    Healthy bool
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    MirrorState 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.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Role 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.
    SourceVolume string
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    State string
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    StateDetails string
    State details of the replication resource.
    TransferStats []VolumeReplicationTransferStat
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
    createTime String
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    destinationVolume String
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    effectiveLabels 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.
    healthy Boolean
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    mirrorState 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.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    role 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.
    sourceVolume String
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    state String
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    stateDetails String
    State details of the replication resource.
    transferStats List<VolumeReplicationTransferStat>
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
    createTime string
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    destinationVolume string
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    healthy boolean
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    mirrorState 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.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    role 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.
    sourceVolume string
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    state string
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    stateDetails string
    State details of the replication resource.
    transferStats VolumeReplicationTransferStat[]
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
    create_time str
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    destination_volume str
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    healthy bool
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    mirror_state str
    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.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    role str
    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.
    source_volume str
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    state str
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    state_details str
    State details of the replication resource.
    transfer_stats Sequence[VolumeReplicationTransferStat]
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
    createTime String
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    destinationVolume String
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    healthy Boolean
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    mirrorState 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.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    role 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.
    sourceVolume String
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    state String
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    stateDetails String
    State details of the replication resource.
    transferStats List<Property Map>
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.

    Look up Existing VolumeReplication Resource

    Get an existing VolumeReplication 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?: VolumeReplicationState, opts?: CustomResourceOptions): VolumeReplication
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            create_time: Optional[str] = None,
            delete_destination_volume: Optional[bool] = None,
            description: Optional[str] = None,
            destination_volume: Optional[str] = None,
            destination_volume_parameters: Optional[VolumeReplicationDestinationVolumeParametersArgs] = None,
            effective_labels: Optional[Mapping[str, str]] = None,
            force_stopping: Optional[bool] = None,
            healthy: Optional[bool] = None,
            labels: Optional[Mapping[str, str]] = None,
            location: Optional[str] = None,
            mirror_state: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            pulumi_labels: Optional[Mapping[str, str]] = None,
            replication_enabled: Optional[bool] = None,
            replication_schedule: Optional[str] = None,
            role: Optional[str] = None,
            source_volume: Optional[str] = None,
            state: Optional[str] = None,
            state_details: Optional[str] = None,
            transfer_stats: Optional[Sequence[VolumeReplicationTransferStatArgs]] = None,
            volume_name: Optional[str] = None,
            wait_for_mirror: Optional[bool] = None) -> VolumeReplication
    func GetVolumeReplication(ctx *Context, name string, id IDInput, state *VolumeReplicationState, opts ...ResourceOption) (*VolumeReplication, error)
    public static VolumeReplication Get(string name, Input<string> id, VolumeReplicationState? state, CustomResourceOptions? opts = null)
    public static VolumeReplication get(String name, Output<String> id, VolumeReplicationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    CreateTime string
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    DeleteDestinationVolume bool
    Description string
    An description of this resource.
    DestinationVolume string
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    DestinationVolumeParameters VolumeReplicationDestinationVolumeParameters
    Destination volume parameters. Structure is documented below.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    ForceStopping 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.
    Healthy bool
    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.
    Labels Dictionary<string, string>

    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 effective_labels for all of the labels present on the resource.

    Location string
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    MirrorState 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.
    Name string
    The name of the replication. Needs to be unique per location.


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ReplicationEnabled 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.
    ReplicationSchedule string
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    Role 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.
    SourceVolume string
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    State string
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    StateDetails string
    State details of the replication resource.
    TransferStats List<VolumeReplicationTransferStat>
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
    VolumeName string
    The name of the existing source volume.
    WaitForMirror bool
    CreateTime string
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    DeleteDestinationVolume bool
    Description string
    An description of this resource.
    DestinationVolume string
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    DestinationVolumeParameters VolumeReplicationDestinationVolumeParametersArgs
    Destination volume parameters. Structure is documented below.
    EffectiveLabels 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.
    ForceStopping 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.
    Healthy bool
    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.
    Labels map[string]string

    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 effective_labels for all of the labels present on the resource.

    Location string
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    MirrorState 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.
    Name string
    The name of the replication. Needs to be unique per location.


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ReplicationEnabled 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.
    ReplicationSchedule string
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    Role 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.
    SourceVolume string
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    State string
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    StateDetails string
    State details of the replication resource.
    TransferStats []VolumeReplicationTransferStatArgs
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
    VolumeName string
    The name of the existing source volume.
    WaitForMirror bool
    createTime String
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    deleteDestinationVolume Boolean
    description String
    An description of this resource.
    destinationVolume String
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    destinationVolumeParameters VolumeReplicationDestinationVolumeParameters
    Destination volume parameters. Structure is documented below.
    effectiveLabels 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.
    forceStopping Boolean
    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.
    healthy Boolean
    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.
    labels Map<String,String>

    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 effective_labels for all of the labels present on the resource.

    location String
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    mirrorState 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.
    name String
    The name of the replication. Needs to be unique per location.


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    replicationEnabled Boolean
    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.
    replicationSchedule String
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    role 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.
    sourceVolume String
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    state String
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    stateDetails String
    State details of the replication resource.
    transferStats List<VolumeReplicationTransferStat>
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
    volumeName String
    The name of the existing source volume.
    waitForMirror Boolean
    createTime string
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    deleteDestinationVolume boolean
    description string
    An description of this resource.
    destinationVolume string
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    destinationVolumeParameters VolumeReplicationDestinationVolumeParameters
    Destination volume parameters. Structure is documented below.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    forceStopping boolean
    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.
    healthy boolean
    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.
    labels {[key: string]: string}

    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 effective_labels for all of the labels present on the resource.

    location string
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    mirrorState 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.
    name string
    The name of the replication. Needs to be unique per location.


    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    replicationEnabled boolean
    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.
    replicationSchedule string
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    role 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.
    sourceVolume string
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    state string
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    stateDetails string
    State details of the replication resource.
    transferStats VolumeReplicationTransferStat[]
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
    volumeName string
    The name of the existing source volume.
    waitForMirror boolean
    create_time str
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    delete_destination_volume bool
    description str
    An description of this resource.
    destination_volume str
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    destination_volume_parameters VolumeReplicationDestinationVolumeParametersArgs
    Destination volume parameters. Structure is documented below.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    force_stopping 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.
    healthy bool
    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.
    labels Mapping[str, str]

    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 effective_labels for all of the labels present on the resource.

    location str
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    mirror_state str
    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.
    name str
    The name of the replication. Needs to be unique per location.


    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    replication_enabled 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.
    replication_schedule str
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    role str
    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.
    source_volume str
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    state str
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    state_details str
    State details of the replication resource.
    transfer_stats Sequence[VolumeReplicationTransferStatArgs]
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
    volume_name str
    The name of the existing source volume.
    wait_for_mirror bool
    createTime String
    Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    deleteDestinationVolume Boolean
    description String
    An description of this resource.
    destinationVolume String
    Full resource name of destination volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    destinationVolumeParameters Property Map
    Destination volume parameters. Structure is documented below.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    forceStopping Boolean
    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.
    healthy Boolean
    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.
    labels Map<String>

    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 effective_labels for all of the labels present on the resource.

    location String
    Name of region for this resource. The resource needs to be created in the region of the destination volume.
    mirrorState 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.
    name String
    The name of the replication. Needs to be unique per location.


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    replicationEnabled Boolean
    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.
    replicationSchedule String
    Specifies the replication interval. Possible values are: EVERY_10_MINUTES, HOURLY, DAILY.
    role 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.
    sourceVolume String
    Full resource name of source volume with format: projects/{{project}}/locations/{{location}}/volumes/{{volumeId}}
    state String
    Indicates the state of replication resource. State of the mirror itself is indicated in mirrorState.
    stateDetails String
    State details of the replication resource.
    transferStats List<Property Map>
    Replication transfer statistics. All statistics are updated every 5 minutes. Structure is documented below.
    volumeName String
    The name of the existing source volume.
    waitForMirror Boolean

    Supporting Types

    VolumeReplicationDestinationVolumeParameters, VolumeReplicationDestinationVolumeParametersArgs

    StoragePool string
    Name of an existing storage pool for the destination volume with format: projects/{{project}}/locations/{{location}}/storagePools/{{poolId}}
    Description string
    Description for the destination volume.
    ShareName string
    Share name for destination volume. If not specified, name of source volume's share name will be used.
    VolumeId string
    Name for the destination volume to be created. If not specified, the name of the source volume will be used.
    StoragePool string
    Name of an existing storage pool for the destination volume with format: projects/{{project}}/locations/{{location}}/storagePools/{{poolId}}
    Description string
    Description for the destination volume.
    ShareName string
    Share name for destination volume. If not specified, name of source volume's share name will be used.
    VolumeId string
    Name for the destination volume to be created. If not specified, the name of the source volume will be used.
    storagePool String
    Name of an existing storage pool for the destination volume with format: projects/{{project}}/locations/{{location}}/storagePools/{{poolId}}
    description String
    Description for the destination volume.
    shareName String
    Share name for destination volume. If not specified, name of source volume's share name will be used.
    volumeId String
    Name for the destination volume to be created. If not specified, the name of the source volume will be used.
    storagePool string
    Name of an existing storage pool for the destination volume with format: projects/{{project}}/locations/{{location}}/storagePools/{{poolId}}
    description string
    Description for the destination volume.
    shareName string
    Share name for destination volume. If not specified, name of source volume's share name will be used.
    volumeId string
    Name for the destination volume to be created. If not specified, the name of the source volume will be used.
    storage_pool str
    Name of an existing storage pool for the destination volume with format: projects/{{project}}/locations/{{location}}/storagePools/{{poolId}}
    description str
    Description for the destination volume.
    share_name str
    Share name for destination volume. If not specified, name of source volume's share name will be used.
    volume_id str
    Name for the destination volume to be created. If not specified, the name of the source volume will be used.
    storagePool String
    Name of an existing storage pool for the destination volume with format: projects/{{project}}/locations/{{location}}/storagePools/{{poolId}}
    description String
    Description for the destination volume.
    shareName String
    Share name for destination volume. If not specified, name of source volume's share name will be used.
    volumeId String
    Name for the destination volume to be created. If not specified, the name of the source volume will be used.

    VolumeReplicationTransferStat, VolumeReplicationTransferStatArgs

    LagDuration string
    (Output) The elapsed time since the creation of the snapshot on the source volume that was last replicated to the destination volume. Lag time represents the difference in age of the destination volume data in relation to the source volume data.
    LastTransferBytes string
    (Output) Size of last completed transfer in bytes.
    LastTransferDuration string
    (Output) Time taken during last completed transfer.
    LastTransferEndTime string
    (Output) Time when last transfer completed. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    LastTransferError string
    (Output) A message describing the cause of the last transfer failure.
    TotalTransferDuration string
    (Output) Cumulative time taken across all transfers for the replication relationship.
    TransferBytes string
    (Output) Cumulative bytes transferred so far for the replication relationship.
    UpdateTime string
    (Output) Time when progress was updated last. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    LagDuration string
    (Output) The elapsed time since the creation of the snapshot on the source volume that was last replicated to the destination volume. Lag time represents the difference in age of the destination volume data in relation to the source volume data.
    LastTransferBytes string
    (Output) Size of last completed transfer in bytes.
    LastTransferDuration string
    (Output) Time taken during last completed transfer.
    LastTransferEndTime string
    (Output) Time when last transfer completed. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    LastTransferError string
    (Output) A message describing the cause of the last transfer failure.
    TotalTransferDuration string
    (Output) Cumulative time taken across all transfers for the replication relationship.
    TransferBytes string
    (Output) Cumulative bytes transferred so far for the replication relationship.
    UpdateTime string
    (Output) Time when progress was updated last. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    lagDuration String
    (Output) The elapsed time since the creation of the snapshot on the source volume that was last replicated to the destination volume. Lag time represents the difference in age of the destination volume data in relation to the source volume data.
    lastTransferBytes String
    (Output) Size of last completed transfer in bytes.
    lastTransferDuration String
    (Output) Time taken during last completed transfer.
    lastTransferEndTime String
    (Output) Time when last transfer completed. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    lastTransferError String
    (Output) A message describing the cause of the last transfer failure.
    totalTransferDuration String
    (Output) Cumulative time taken across all transfers for the replication relationship.
    transferBytes String
    (Output) Cumulative bytes transferred so far for the replication relationship.
    updateTime String
    (Output) Time when progress was updated last. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    lagDuration string
    (Output) The elapsed time since the creation of the snapshot on the source volume that was last replicated to the destination volume. Lag time represents the difference in age of the destination volume data in relation to the source volume data.
    lastTransferBytes string
    (Output) Size of last completed transfer in bytes.
    lastTransferDuration string
    (Output) Time taken during last completed transfer.
    lastTransferEndTime string
    (Output) Time when last transfer completed. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    lastTransferError string
    (Output) A message describing the cause of the last transfer failure.
    totalTransferDuration string
    (Output) Cumulative time taken across all transfers for the replication relationship.
    transferBytes string
    (Output) Cumulative bytes transferred so far for the replication relationship.
    updateTime string
    (Output) Time when progress was updated last. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    lag_duration str
    (Output) The elapsed time since the creation of the snapshot on the source volume that was last replicated to the destination volume. Lag time represents the difference in age of the destination volume data in relation to the source volume data.
    last_transfer_bytes str
    (Output) Size of last completed transfer in bytes.
    last_transfer_duration str
    (Output) Time taken during last completed transfer.
    last_transfer_end_time str
    (Output) Time when last transfer completed. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    last_transfer_error str
    (Output) A message describing the cause of the last transfer failure.
    total_transfer_duration str
    (Output) Cumulative time taken across all transfers for the replication relationship.
    transfer_bytes str
    (Output) Cumulative bytes transferred so far for the replication relationship.
    update_time str
    (Output) Time when progress was updated last. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    lagDuration String
    (Output) The elapsed time since the creation of the snapshot on the source volume that was last replicated to the destination volume. Lag time represents the difference in age of the destination volume data in relation to the source volume data.
    lastTransferBytes String
    (Output) Size of last completed transfer in bytes.
    lastTransferDuration String
    (Output) Time taken during last completed transfer.
    lastTransferEndTime String
    (Output) Time when last transfer completed. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    lastTransferError String
    (Output) A message describing the cause of the last transfer failure.
    totalTransferDuration String
    (Output) Cumulative time taken across all transfers for the replication relationship.
    transferBytes String
    (Output) Cumulative bytes transferred so far for the replication relationship.
    updateTime String
    (Output) Time when progress was updated last. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".

    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:

    $ 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}}
    

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

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi