Package com.hashicorp.cdktf.providers.google.netapp_volume_replication

Class NetappVolumeReplication.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static NetappVolumeReplication.Builder create​(software.constructs.Construct scope,
                                                     String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of NetappVolumeReplication.Builder.

      • connection

        @Stability(Experimental)
public NetappVolumeReplication.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public NetappVolumeReplication.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public NetappVolumeReplication.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public NetappVolumeReplication.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public NetappVolumeReplication.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public NetappVolumeReplication.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public NetappVolumeReplication.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • location

        @Stability(Stable)
public NetappVolumeReplication.Builder location​(String location)
        Name of region for this resource. The resource needs to be created in the region of the destination volume.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#location NetappVolumeReplication#location}

        Parameters:
        location - Name of region for this resource. The resource needs to be created in the region of the destination volume. This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public NetappVolumeReplication.Builder name​(String name)
        The name of the replication. Needs to be unique per location.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#name NetappVolumeReplication#name}

        Parameters:
        name - The name of the replication. Needs to be unique per location. This parameter is required.
        Returns:
        this

      • replicationSchedule

        @Stability(Stable)
public NetappVolumeReplication.Builder replicationSchedule​(String replicationSchedule)
        Specifies the replication interval. Possible values: ["EVERY_10_MINUTES", "HOURLY", "DAILY"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#replication_schedule NetappVolumeReplication#replication_schedule}

        Parameters:
        replicationSchedule - Specifies the replication interval. Possible values: ["EVERY_10_MINUTES", "HOURLY", "DAILY"]. This parameter is required.
        Returns:
        this

      • volumeName

        @Stability(Stable)
public NetappVolumeReplication.Builder volumeName​(String volumeName)
        The name of the existing source volume.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#volume_name NetappVolumeReplication#volume_name}

        Parameters:
        volumeName - The name of the existing source volume. This parameter is required.
        Returns:
        this

      • deleteDestinationVolume

        @Stability(Stable)
public NetappVolumeReplication.Builder deleteDestinationVolume​(Boolean deleteDestinationVolume)
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#delete_destination_volume NetappVolumeReplication#delete_destination_volume}

        Parameters:
        deleteDestinationVolume - A destination volume is created as part of replication creation. This parameter is required.
        Returns:
        this

      • deleteDestinationVolume

        @Stability(Stable)
public NetappVolumeReplication.Builder deleteDestinationVolume​(com.hashicorp.cdktf.IResolvable deleteDestinationVolume)
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#delete_destination_volume NetappVolumeReplication#delete_destination_volume}

        Parameters:
        deleteDestinationVolume - A destination volume is created as part of replication creation. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public NetappVolumeReplication.Builder description​(String description)
        An description of this resource.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#description NetappVolumeReplication#description}

        Parameters:
        description - An description of this resource. This parameter is required.
        Returns:
        this

      • destinationVolumeParameters

        @Stability(Stable)
public NetappVolumeReplication.Builder destinationVolumeParameters​(NetappVolumeReplicationDestinationVolumeParameters destinationVolumeParameters)
        destination_volume_parameters block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#destination_volume_parameters NetappVolumeReplication#destination_volume_parameters}

        Parameters:
        destinationVolumeParameters - destination_volume_parameters block. This parameter is required.
        Returns:
        this

      • forceStopping

        @Stability(Stable)
public NetappVolumeReplication.Builder forceStopping​(Boolean forceStopping)
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#force_stopping NetappVolumeReplication#force_stopping}

        Parameters:
        forceStopping - Only replications with mirror_state=MIRRORED can be stopped. This parameter is required.
        Returns:
        this

      • forceStopping

        @Stability(Stable)
public NetappVolumeReplication.Builder forceStopping​(com.hashicorp.cdktf.IResolvable forceStopping)
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#force_stopping NetappVolumeReplication#force_stopping}

        Parameters:
        forceStopping - Only replications with mirror_state=MIRRORED can be stopped. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public NetappVolumeReplication.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#id NetappVolumeReplication#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#id NetappVolumeReplication#id}. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public NetappVolumeReplication.Builder labels​(Map<String,​String> labels)
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#labels NetappVolumeReplication#labels}

        Parameters:
        labels - Labels as key value pairs. Example: '{ "owner": "Bob", "department": "finance", "purpose": "testing" }'. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public NetappVolumeReplication.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#project NetappVolumeReplication#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#project NetappVolumeReplication#project}. This parameter is required.
        Returns:
        this

      • replicationEnabled

        @Stability(Stable)
public NetappVolumeReplication.Builder replicationEnabled​(Boolean replicationEnabled)
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#replication_enabled NetappVolumeReplication#replication_enabled}

        Parameters:
        replicationEnabled - Set to false to stop/break the mirror. This parameter is required.
        Returns:
        this

      • replicationEnabled

        @Stability(Stable)
public NetappVolumeReplication.Builder replicationEnabled​(com.hashicorp.cdktf.IResolvable replicationEnabled)
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#replication_enabled NetappVolumeReplication#replication_enabled}

        Parameters:
        replicationEnabled - Set to false to stop/break the mirror. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public NetappVolumeReplication.Builder timeouts​(NetappVolumeReplicationTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#timeouts NetappVolumeReplication#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • waitForMirror

        @Stability(Stable)
public NetappVolumeReplication.Builder waitForMirror​(Boolean waitForMirror)
        Replication resource state is independent of mirror_state.

        With enough data, it can take many hours for mirror_state 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#wait_for_mirror NetappVolumeReplication#wait_for_mirror}

        Parameters:
        waitForMirror - Replication resource state is independent of mirror_state. This parameter is required.
        Returns:
        this

      • waitForMirror

        @Stability(Stable)
public NetappVolumeReplication.Builder waitForMirror​(com.hashicorp.cdktf.IResolvable waitForMirror)
        Replication resource state is independent of mirror_state.

        With enough data, it can take many hours for mirror_state 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume_replication#wait_for_mirror NetappVolumeReplication#wait_for_mirror}

        Parameters:
        waitForMirror - Replication resource state is independent of mirror_state. This parameter is required.
        Returns:
        this