Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. BackupRecoveryUpdateProtectionGroupRunRequest
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.BackupRecoveryUpdateProtectionGroupRunRequest

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.BackupRecoveryUpdateProtectionGroupRunRequest;
import com.pulumi.ibm.BackupRecoveryUpdateProtectionGroupRunRequestArgs;
import com.pulumi.ibm.inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs;
import com.pulumi.ibm.inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigArgs;
import com.pulumi.ibm.inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfigArgs;
import com.pulumi.ibm.inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigArgs;
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) {
        var backupRecoveryUpdateProtectionGroupRunRequestInstance = new BackupRecoveryUpdateProtectionGroupRunRequest("backupRecoveryUpdateProtectionGroupRunRequestInstance", BackupRecoveryUpdateProtectionGroupRunRequestArgs.builder()
            .groupId("123:11:1")
            .updateProtectionGroupRunParams(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs.builder()
                .archivalSnapshotConfig(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigArgs.builder()
                    .newSnapshotConfig(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .updateExistingSnapshotConfig(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .build())
                .localSnapshotConfig(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfigArgs.builder()
                    .dataLock("Compliance")
                    .daysToKeep(1)
                    .deleteSnapshot(true)
                    .enableLegalHold(true)
                    .build())
                .replicationSnapshotConfig(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigArgs.builder()
                    .newSnapshotConfig(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .updateExistingSnapshotConfig(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .build())
                .runId("run_id")
                .build())
            .xIbmTenantId("x_ibm_tenant_id")
            .build());

    }
}

    resources:
  backupRecoveryUpdateProtectionGroupRunRequestInstance:
    type: ibm:BackupRecoveryUpdateProtectionGroupRunRequest
    properties:
      groupId: 123:11:1
      updateProtectionGroupRunParams:
        - archivalSnapshotConfig:
            newSnapshotConfig:
              - archivalTargetType: Tape
                copyOnlyFullySuccessful: true
                id: 1
                retention:
                  dataLockConfig:
                    duration: 1
                    enableWormOnExternalTarget: true
                    mode: Compliance
                    unit: Days
                  duration: 1
                  unit: Days
            updateExistingSnapshotConfig:
              - archivalTargetType: Tape
                dataLock: Compliance
                daysToKeep: 1
                deleteSnapshot: true
                enableLegalHold: true
                id: 1
                name: name
                resync: true
          localSnapshotConfig:
            dataLock: Compliance
            daysToKeep: 1
            deleteSnapshot: true
            enableLegalHold: true
          replicationSnapshotConfig:
            newSnapshotConfig:
              - id: 1
                retention:
                  dataLockConfig:
                    duration: 1
                    enableWormOnExternalTarget: true
                    mode: Compliance
                    unit: Days
                  duration: 1
                  unit: Days
            updateExistingSnapshotConfig:
              - dataLock: Compliance
                daysToKeep: 1
                deleteSnapshot: true
                enableLegalHold: true
                id: 1
                name: name
                resync: true
          runId: run_id
      xIbmTenantId: x_ibm_tenant_id

    Create BackupRecoveryUpdateProtectionGroupRunRequest Resource

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

    Constructor syntax

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

@overload
def BackupRecoveryUpdateProtectionGroupRunRequest(resource_name: str,
                                                  opts: Optional[ResourceOptions] = None,
                                                  group_id: Optional[str] = None,
                                                  update_protection_group_run_params: Optional[Sequence[BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs]] = None,
                                                  x_ibm_tenant_id: Optional[str] = None,
                                                  backup_recovery_update_protection_group_run_request_id: Optional[str] = None)
    func NewBackupRecoveryUpdateProtectionGroupRunRequest(ctx *Context, name string, args BackupRecoveryUpdateProtectionGroupRunRequestArgs, opts ...ResourceOption) (*BackupRecoveryUpdateProtectionGroupRunRequest, error)
    public BackupRecoveryUpdateProtectionGroupRunRequest(string name, BackupRecoveryUpdateProtectionGroupRunRequestArgs args, CustomResourceOptions? opts = null)
    public BackupRecoveryUpdateProtectionGroupRunRequest(String name, BackupRecoveryUpdateProtectionGroupRunRequestArgs args)
public BackupRecoveryUpdateProtectionGroupRunRequest(String name, BackupRecoveryUpdateProtectionGroupRunRequestArgs args, CustomResourceOptions options)

    type: ibm:BackupRecoveryUpdateProtectionGroupRunRequest
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 BackupRecoveryUpdateProtectionGroupRunRequestArgs
    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 BackupRecoveryUpdateProtectionGroupRunRequestArgs
    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 BackupRecoveryUpdateProtectionGroupRunRequestArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupRecoveryUpdateProtectionGroupRunRequestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupRecoveryUpdateProtectionGroupRunRequestArgs
    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 backupRecoveryUpdateProtectionGroupRunRequestResource = new Ibm.BackupRecoveryUpdateProtectionGroupRunRequest("backupRecoveryUpdateProtectionGroupRunRequestResource", new()
{
    GroupId = "string",
    UpdateProtectionGroupRunParams = new[]
    {
        new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs
        {
            RunId = "string",
            ArchivalSnapshotConfig = new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigArgs
            {
                NewSnapshotConfigs = new[]
                {
                    new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigArgs
                    {
                        ArchivalTargetType = "string",
                        Id = 0,
                        CopyOnlyFullySuccessful = false,
                        Retention = new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionArgs
                        {
                            Duration = 0,
                            Unit = "string",
                            DataLockConfig = new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionDataLockConfigArgs
                            {
                                Duration = 0,
                                Mode = "string",
                                Unit = "string",
                                EnableWormOnExternalTarget = false,
                            },
                        },
                    },
                },
                UpdateExistingSnapshotConfigs = new[]
                {
                    new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigUpdateExistingSnapshotConfigArgs
                    {
                        ArchivalTargetType = "string",
                        Id = 0,
                        DataLock = "string",
                        DaysToKeep = 0,
                        DeleteSnapshot = false,
                        EnableLegalHold = false,
                        Name = "string",
                        Resync = false,
                    },
                },
            },
            LocalSnapshotConfig = new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfigArgs
            {
                DataLock = "string",
                DaysToKeep = 0,
                DeleteSnapshot = false,
                EnableLegalHold = false,
            },
            ReplicationSnapshotConfig = new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigArgs
            {
                NewSnapshotConfigs = new[]
                {
                    new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigArgs
                    {
                        Id = 0,
                        Retention = new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionArgs
                        {
                            Duration = 0,
                            Unit = "string",
                            DataLockConfig = new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionDataLockConfigArgs
                            {
                                Duration = 0,
                                Mode = "string",
                                Unit = "string",
                                EnableWormOnExternalTarget = false,
                            },
                        },
                    },
                },
                UpdateExistingSnapshotConfigs = new[]
                {
                    new Ibm.Inputs.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigUpdateExistingSnapshotConfigArgs
                    {
                        Id = 0,
                        DataLock = "string",
                        DaysToKeep = 0,
                        DeleteSnapshot = false,
                        EnableLegalHold = false,
                        Name = "string",
                        Resync = false,
                    },
                },
            },
        },
    },
    XIbmTenantId = "string",
    BackupRecoveryUpdateProtectionGroupRunRequestId = "string",
});

    example, err := ibm.NewBackupRecoveryUpdateProtectionGroupRunRequest(ctx, "backupRecoveryUpdateProtectionGroupRunRequestResource", &ibm.BackupRecoveryUpdateProtectionGroupRunRequestArgs{
	GroupId: pulumi.String("string"),
	UpdateProtectionGroupRunParams: ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArray{
		&ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs{
			RunId: pulumi.String("string"),
			ArchivalSnapshotConfig: &ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigArgs{
				NewSnapshotConfigs: ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigArray{
					&ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigArgs{
						ArchivalTargetType:      pulumi.String("string"),
						Id:                      pulumi.Float64(0),
						CopyOnlyFullySuccessful: pulumi.Bool(false),
						Retention: &ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionArgs{
							Duration: pulumi.Float64(0),
							Unit:     pulumi.String("string"),
							DataLockConfig: &ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionDataLockConfigArgs{
								Duration:                   pulumi.Float64(0),
								Mode:                       pulumi.String("string"),
								Unit:                       pulumi.String("string"),
								EnableWormOnExternalTarget: pulumi.Bool(false),
							},
						},
					},
				},
				UpdateExistingSnapshotConfigs: ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigUpdateExistingSnapshotConfigArray{
					&ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigUpdateExistingSnapshotConfigArgs{
						ArchivalTargetType: pulumi.String("string"),
						Id:                 pulumi.Float64(0),
						DataLock:           pulumi.String("string"),
						DaysToKeep:         pulumi.Float64(0),
						DeleteSnapshot:     pulumi.Bool(false),
						EnableLegalHold:    pulumi.Bool(false),
						Name:               pulumi.String("string"),
						Resync:             pulumi.Bool(false),
					},
				},
			},
			LocalSnapshotConfig: &ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfigArgs{
				DataLock:        pulumi.String("string"),
				DaysToKeep:      pulumi.Float64(0),
				DeleteSnapshot:  pulumi.Bool(false),
				EnableLegalHold: pulumi.Bool(false),
			},
			ReplicationSnapshotConfig: &ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigArgs{
				NewSnapshotConfigs: ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigArray{
					&ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigArgs{
						Id: pulumi.Float64(0),
						Retention: &ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionArgs{
							Duration: pulumi.Float64(0),
							Unit:     pulumi.String("string"),
							DataLockConfig: &ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionDataLockConfigArgs{
								Duration:                   pulumi.Float64(0),
								Mode:                       pulumi.String("string"),
								Unit:                       pulumi.String("string"),
								EnableWormOnExternalTarget: pulumi.Bool(false),
							},
						},
					},
				},
				UpdateExistingSnapshotConfigs: ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigUpdateExistingSnapshotConfigArray{
					&ibm.BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigUpdateExistingSnapshotConfigArgs{
						Id:              pulumi.Float64(0),
						DataLock:        pulumi.String("string"),
						DaysToKeep:      pulumi.Float64(0),
						DeleteSnapshot:  pulumi.Bool(false),
						EnableLegalHold: pulumi.Bool(false),
						Name:            pulumi.String("string"),
						Resync:          pulumi.Bool(false),
					},
				},
			},
		},
	},
	XIbmTenantId: pulumi.String("string"),
	BackupRecoveryUpdateProtectionGroupRunRequestId: pulumi.String("string"),
})

    var backupRecoveryUpdateProtectionGroupRunRequestResource = new BackupRecoveryUpdateProtectionGroupRunRequest("backupRecoveryUpdateProtectionGroupRunRequestResource", BackupRecoveryUpdateProtectionGroupRunRequestArgs.builder()
    .groupId("string")
    .updateProtectionGroupRunParams(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs.builder()
        .runId("string")
        .archivalSnapshotConfig(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigArgs.builder()
            .newSnapshotConfigs(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigArgs.builder()
                .archivalTargetType("string")
                .id(0)
                .copyOnlyFullySuccessful(false)
                .retention(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionArgs.builder()
                    .duration(0)
                    .unit("string")
                    .dataLockConfig(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionDataLockConfigArgs.builder()
                        .duration(0)
                        .mode("string")
                        .unit("string")
                        .enableWormOnExternalTarget(false)
                        .build())
                    .build())
                .build())
            .updateExistingSnapshotConfigs(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigUpdateExistingSnapshotConfigArgs.builder()
                .archivalTargetType("string")
                .id(0)
                .dataLock("string")
                .daysToKeep(0)
                .deleteSnapshot(false)
                .enableLegalHold(false)
                .name("string")
                .resync(false)
                .build())
            .build())
        .localSnapshotConfig(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfigArgs.builder()
            .dataLock("string")
            .daysToKeep(0)
            .deleteSnapshot(false)
            .enableLegalHold(false)
            .build())
        .replicationSnapshotConfig(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigArgs.builder()
            .newSnapshotConfigs(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigArgs.builder()
                .id(0)
                .retention(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionArgs.builder()
                    .duration(0)
                    .unit("string")
                    .dataLockConfig(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionDataLockConfigArgs.builder()
                        .duration(0)
                        .mode("string")
                        .unit("string")
                        .enableWormOnExternalTarget(false)
                        .build())
                    .build())
                .build())
            .updateExistingSnapshotConfigs(BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigUpdateExistingSnapshotConfigArgs.builder()
                .id(0)
                .dataLock("string")
                .daysToKeep(0)
                .deleteSnapshot(false)
                .enableLegalHold(false)
                .name("string")
                .resync(false)
                .build())
            .build())
        .build())
    .xIbmTenantId("string")
    .backupRecoveryUpdateProtectionGroupRunRequestId("string")
    .build());

    backup_recovery_update_protection_group_run_request_resource = ibm.BackupRecoveryUpdateProtectionGroupRunRequest("backupRecoveryUpdateProtectionGroupRunRequestResource",
    group_id="string",
    update_protection_group_run_params=[{
        "run_id": "string",
        "archival_snapshot_config": {
            "new_snapshot_configs": [{
                "archival_target_type": "string",
                "id": 0,
                "copy_only_fully_successful": False,
                "retention": {
                    "duration": 0,
                    "unit": "string",
                    "data_lock_config": {
                        "duration": 0,
                        "mode": "string",
                        "unit": "string",
                        "enable_worm_on_external_target": False,
                    },
                },
            }],
            "update_existing_snapshot_configs": [{
                "archival_target_type": "string",
                "id": 0,
                "data_lock": "string",
                "days_to_keep": 0,
                "delete_snapshot": False,
                "enable_legal_hold": False,
                "name": "string",
                "resync": False,
            }],
        },
        "local_snapshot_config": {
            "data_lock": "string",
            "days_to_keep": 0,
            "delete_snapshot": False,
            "enable_legal_hold": False,
        },
        "replication_snapshot_config": {
            "new_snapshot_configs": [{
                "id": 0,
                "retention": {
                    "duration": 0,
                    "unit": "string",
                    "data_lock_config": {
                        "duration": 0,
                        "mode": "string",
                        "unit": "string",
                        "enable_worm_on_external_target": False,
                    },
                },
            }],
            "update_existing_snapshot_configs": [{
                "id": 0,
                "data_lock": "string",
                "days_to_keep": 0,
                "delete_snapshot": False,
                "enable_legal_hold": False,
                "name": "string",
                "resync": False,
            }],
        },
    }],
    x_ibm_tenant_id="string",
    backup_recovery_update_protection_group_run_request_id="string")

    const backupRecoveryUpdateProtectionGroupRunRequestResource = new ibm.BackupRecoveryUpdateProtectionGroupRunRequest("backupRecoveryUpdateProtectionGroupRunRequestResource", {
    groupId: "string",
    updateProtectionGroupRunParams: [{
        runId: "string",
        archivalSnapshotConfig: {
            newSnapshotConfigs: [{
                archivalTargetType: "string",
                id: 0,
                copyOnlyFullySuccessful: false,
                retention: {
                    duration: 0,
                    unit: "string",
                    dataLockConfig: {
                        duration: 0,
                        mode: "string",
                        unit: "string",
                        enableWormOnExternalTarget: false,
                    },
                },
            }],
            updateExistingSnapshotConfigs: [{
                archivalTargetType: "string",
                id: 0,
                dataLock: "string",
                daysToKeep: 0,
                deleteSnapshot: false,
                enableLegalHold: false,
                name: "string",
                resync: false,
            }],
        },
        localSnapshotConfig: {
            dataLock: "string",
            daysToKeep: 0,
            deleteSnapshot: false,
            enableLegalHold: false,
        },
        replicationSnapshotConfig: {
            newSnapshotConfigs: [{
                id: 0,
                retention: {
                    duration: 0,
                    unit: "string",
                    dataLockConfig: {
                        duration: 0,
                        mode: "string",
                        unit: "string",
                        enableWormOnExternalTarget: false,
                    },
                },
            }],
            updateExistingSnapshotConfigs: [{
                id: 0,
                dataLock: "string",
                daysToKeep: 0,
                deleteSnapshot: false,
                enableLegalHold: false,
                name: "string",
                resync: false,
            }],
        },
    }],
    xIbmTenantId: "string",
    backupRecoveryUpdateProtectionGroupRunRequestId: "string",
});

    type: ibm:BackupRecoveryUpdateProtectionGroupRunRequest
properties:
    backupRecoveryUpdateProtectionGroupRunRequestId: string
    groupId: string
    updateProtectionGroupRunParams:
        - archivalSnapshotConfig:
            newSnapshotConfigs:
                - archivalTargetType: string
                  copyOnlyFullySuccessful: false
                  id: 0
                  retention:
                    dataLockConfig:
                        duration: 0
                        enableWormOnExternalTarget: false
                        mode: string
                        unit: string
                    duration: 0
                    unit: string
            updateExistingSnapshotConfigs:
                - archivalTargetType: string
                  dataLock: string
                  daysToKeep: 0
                  deleteSnapshot: false
                  enableLegalHold: false
                  id: 0
                  name: string
                  resync: false
          localSnapshotConfig:
            dataLock: string
            daysToKeep: 0
            deleteSnapshot: false
            enableLegalHold: false
          replicationSnapshotConfig:
            newSnapshotConfigs:
                - id: 0
                  retention:
                    dataLockConfig:
                        duration: 0
                        enableWormOnExternalTarget: false
                        mode: string
                        unit: string
                    duration: 0
                    unit: string
            updateExistingSnapshotConfigs:
                - dataLock: string
                  daysToKeep: 0
                  deleteSnapshot: false
                  enableLegalHold: false
                  id: 0
                  name: string
                  resync: false
          runId: string
    xIbmTenantId: string

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

    GroupId string
    Specifies the protection group ID
    UpdateProtectionGroupRunParams List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParam>
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    BackupRecoveryUpdateProtectionGroupRunRequestId string
    The unique identifier of the Update Protection Group Run Request Body..
    GroupId string
    Specifies the protection group ID
    UpdateProtectionGroupRunParams []BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    BackupRecoveryUpdateProtectionGroupRunRequestId string
    The unique identifier of the Update Protection Group Run Request Body..
    groupId String
    Specifies the protection group ID
    updateProtectionGroupRunParams List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParam>
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    backupRecoveryUpdateProtectionGroupRunRequestId String
    The unique identifier of the Update Protection Group Run Request Body..
    groupId string
    Specifies the protection group ID
    updateProtectionGroupRunParams BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParam[]
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    xIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    backupRecoveryUpdateProtectionGroupRunRequestId string
    The unique identifier of the Update Protection Group Run Request Body..
    group_id str
    Specifies the protection group ID
    update_protection_group_run_params Sequence[BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs]
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    x_ibm_tenant_id str
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    backup_recovery_update_protection_group_run_request_id str
    The unique identifier of the Update Protection Group Run Request Body..
    groupId String
    Specifies the protection group ID
    updateProtectionGroupRunParams List<Property Map>
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    backupRecoveryUpdateProtectionGroupRunRequestId String
    The unique identifier of the Update Protection Group Run Request Body..

    Outputs

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

    FailedRuns List<BackupRecoveryUpdateProtectionGroupRunRequestFailedRun>
    Specfies the list of connections for the source.
    Id string
    The provider-assigned unique ID for this managed resource.
    RunId string
    The unique ID.
    SuccessfulRunIds string
    Specifies a list of Protection Group ids for which the state should change.
    FailedRuns []BackupRecoveryUpdateProtectionGroupRunRequestFailedRun
    Specfies the list of connections for the source.
    Id string
    The provider-assigned unique ID for this managed resource.
    RunId string
    The unique ID.
    SuccessfulRunIds string
    Specifies a list of Protection Group ids for which the state should change.
    failedRuns List<BackupRecoveryUpdateProtectionGroupRunRequestFailedRun>
    Specfies the list of connections for the source.
    id String
    The provider-assigned unique ID for this managed resource.
    runId String
    The unique ID.
    successfulRunIds String
    Specifies a list of Protection Group ids for which the state should change.
    failedRuns BackupRecoveryUpdateProtectionGroupRunRequestFailedRun[]
    Specfies the list of connections for the source.
    id string
    The provider-assigned unique ID for this managed resource.
    runId string
    The unique ID.
    successfulRunIds string
    Specifies a list of Protection Group ids for which the state should change.
    failed_runs Sequence[BackupRecoveryUpdateProtectionGroupRunRequestFailedRun]
    Specfies the list of connections for the source.
    id str
    The provider-assigned unique ID for this managed resource.
    run_id str
    The unique ID.
    successful_run_ids str
    Specifies a list of Protection Group ids for which the state should change.
    failedRuns List<Property Map>
    Specfies the list of connections for the source.
    id String
    The provider-assigned unique ID for this managed resource.
    runId String
    The unique ID.
    successfulRunIds String
    Specifies a list of Protection Group ids for which the state should change.

    Look up Existing BackupRecoveryUpdateProtectionGroupRunRequest Resource

    Get an existing BackupRecoveryUpdateProtectionGroupRunRequest 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?: BackupRecoveryUpdateProtectionGroupRunRequestState, opts?: CustomResourceOptions): BackupRecoveryUpdateProtectionGroupRunRequest
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_recovery_update_protection_group_run_request_id: Optional[str] = None,
        failed_runs: Optional[Sequence[BackupRecoveryUpdateProtectionGroupRunRequestFailedRunArgs]] = None,
        group_id: Optional[str] = None,
        run_id: Optional[str] = None,
        successful_run_ids: Optional[str] = None,
        update_protection_group_run_params: Optional[Sequence[BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs]] = None,
        x_ibm_tenant_id: Optional[str] = None) -> BackupRecoveryUpdateProtectionGroupRunRequest
    func GetBackupRecoveryUpdateProtectionGroupRunRequest(ctx *Context, name string, id IDInput, state *BackupRecoveryUpdateProtectionGroupRunRequestState, opts ...ResourceOption) (*BackupRecoveryUpdateProtectionGroupRunRequest, error)
    public static BackupRecoveryUpdateProtectionGroupRunRequest Get(string name, Input<string> id, BackupRecoveryUpdateProtectionGroupRunRequestState? state, CustomResourceOptions? opts = null)
    public static BackupRecoveryUpdateProtectionGroupRunRequest get(String name, Output<String> id, BackupRecoveryUpdateProtectionGroupRunRequestState state, CustomResourceOptions options)
    resources:  _:    type: ibm:BackupRecoveryUpdateProtectionGroupRunRequest    get:      id: ${id}
    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:
    BackupRecoveryUpdateProtectionGroupRunRequestId string
    The unique identifier of the Update Protection Group Run Request Body..
    FailedRuns List<BackupRecoveryUpdateProtectionGroupRunRequestFailedRun>
    Specfies the list of connections for the source.
    GroupId string
    Specifies the protection group ID
    RunId string
    The unique ID.
    SuccessfulRunIds string
    Specifies a list of Protection Group ids for which the state should change.
    UpdateProtectionGroupRunParams List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParam>
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    BackupRecoveryUpdateProtectionGroupRunRequestId string
    The unique identifier of the Update Protection Group Run Request Body..
    FailedRuns []BackupRecoveryUpdateProtectionGroupRunRequestFailedRunArgs
    Specfies the list of connections for the source.
    GroupId string
    Specifies the protection group ID
    RunId string
    The unique ID.
    SuccessfulRunIds string
    Specifies a list of Protection Group ids for which the state should change.
    UpdateProtectionGroupRunParams []BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    backupRecoveryUpdateProtectionGroupRunRequestId String
    The unique identifier of the Update Protection Group Run Request Body..
    failedRuns List<BackupRecoveryUpdateProtectionGroupRunRequestFailedRun>
    Specfies the list of connections for the source.
    groupId String
    Specifies the protection group ID
    runId String
    The unique ID.
    successfulRunIds String
    Specifies a list of Protection Group ids for which the state should change.
    updateProtectionGroupRunParams List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParam>
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    backupRecoveryUpdateProtectionGroupRunRequestId string
    The unique identifier of the Update Protection Group Run Request Body..
    failedRuns BackupRecoveryUpdateProtectionGroupRunRequestFailedRun[]
    Specfies the list of connections for the source.
    groupId string
    Specifies the protection group ID
    runId string
    The unique ID.
    successfulRunIds string
    Specifies a list of Protection Group ids for which the state should change.
    updateProtectionGroupRunParams BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParam[]
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    xIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    backup_recovery_update_protection_group_run_request_id str
    The unique identifier of the Update Protection Group Run Request Body..
    failed_runs Sequence[BackupRecoveryUpdateProtectionGroupRunRequestFailedRunArgs]
    Specfies the list of connections for the source.
    group_id str
    Specifies the protection group ID
    run_id str
    The unique ID.
    successful_run_ids str
    Specifies a list of Protection Group ids for which the state should change.
    update_protection_group_run_params Sequence[BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs]
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    x_ibm_tenant_id str
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    backupRecoveryUpdateProtectionGroupRunRequestId String
    The unique identifier of the Update Protection Group Run Request Body..
    failedRuns List<Property Map>
    Specfies the list of connections for the source.
    groupId String
    Specifies the protection group ID
    runId String
    The unique ID.
    successfulRunIds String
    Specifies a list of Protection Group ids for which the state should change.
    updateProtectionGroupRunParams List<Property Map>
    • Constraints: The minimum length is 1 item. Nested schema for update_protection_group_run_params:
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

    Supporting Types

    BackupRecoveryUpdateProtectionGroupRunRequestFailedRun, BackupRecoveryUpdateProtectionGroupRunRequestFailedRunArgs

    ErrorMessage string
    RunId string
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    ErrorMessage string
    RunId string
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    errorMessage String
    runId String
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    errorMessage string
    runId string
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    error_message str
    run_id str
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    errorMessage String
    runId String
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParam, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArgs

    RunId string
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    ArchivalSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfig
    Specifies the params to perform actions on archival snapshots taken by a Protection Group Run. Nested schema for archival_snapshot_config:
    LocalSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfig
    Specifies the params to perform actions on local snapshot taken by a Protection Group Run. Nested schema for local_snapshot_config:
    ReplicationSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfig
    Specifies the params to perform actions on replication snapshots taken by a Protection Group Run. Nested schema for replication_snapshot_config:
    RunId string
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    ArchivalSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfig
    Specifies the params to perform actions on archival snapshots taken by a Protection Group Run. Nested schema for archival_snapshot_config:
    LocalSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfig
    Specifies the params to perform actions on local snapshot taken by a Protection Group Run. Nested schema for local_snapshot_config:
    ReplicationSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfig
    Specifies the params to perform actions on replication snapshots taken by a Protection Group Run. Nested schema for replication_snapshot_config:
    runId String
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    archivalSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfig
    Specifies the params to perform actions on archival snapshots taken by a Protection Group Run. Nested schema for archival_snapshot_config:
    localSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfig
    Specifies the params to perform actions on local snapshot taken by a Protection Group Run. Nested schema for local_snapshot_config:
    replicationSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfig
    Specifies the params to perform actions on replication snapshots taken by a Protection Group Run. Nested schema for replication_snapshot_config:
    runId string
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    archivalSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfig
    Specifies the params to perform actions on archival snapshots taken by a Protection Group Run. Nested schema for archival_snapshot_config:
    localSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfig
    Specifies the params to perform actions on local snapshot taken by a Protection Group Run. Nested schema for local_snapshot_config:
    replicationSnapshotConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfig
    Specifies the params to perform actions on replication snapshots taken by a Protection Group Run. Nested schema for replication_snapshot_config:
    run_id str
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    archival_snapshot_config BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfig
    Specifies the params to perform actions on archival snapshots taken by a Protection Group Run. Nested schema for archival_snapshot_config:
    local_snapshot_config BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfig
    Specifies the params to perform actions on local snapshot taken by a Protection Group Run. Nested schema for local_snapshot_config:
    replication_snapshot_config BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfig
    Specifies the params to perform actions on replication snapshots taken by a Protection Group Run. Nested schema for replication_snapshot_config:
    runId String
    Specifies a unique Protection Group Run id.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    archivalSnapshotConfig Property Map
    Specifies the params to perform actions on archival snapshots taken by a Protection Group Run. Nested schema for archival_snapshot_config:
    localSnapshotConfig Property Map
    Specifies the params to perform actions on local snapshot taken by a Protection Group Run. Nested schema for local_snapshot_config:
    replicationSnapshotConfig Property Map
    Specifies the params to perform actions on replication snapshots taken by a Protection Group Run. Nested schema for replication_snapshot_config:

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfig, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigArgs

    NewSnapshotConfigs List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfig>
    Specifies the new configuration about adding Archival Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    UpdateExistingSnapshotConfigs List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigUpdateExistingSnapshotConfig>
    Specifies the configuration about updating an existing Archival Snapshot Run. Nested schema for update_existing_snapshot_config:
    NewSnapshotConfigs []BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfig
    Specifies the new configuration about adding Archival Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    UpdateExistingSnapshotConfigs []BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigUpdateExistingSnapshotConfig
    Specifies the configuration about updating an existing Archival Snapshot Run. Nested schema for update_existing_snapshot_config:
    newSnapshotConfigs List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfig>
    Specifies the new configuration about adding Archival Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    updateExistingSnapshotConfigs List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigUpdateExistingSnapshotConfig>
    Specifies the configuration about updating an existing Archival Snapshot Run. Nested schema for update_existing_snapshot_config:
    newSnapshotConfigs BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfig[]
    Specifies the new configuration about adding Archival Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    updateExistingSnapshotConfigs BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigUpdateExistingSnapshotConfig[]
    Specifies the configuration about updating an existing Archival Snapshot Run. Nested schema for update_existing_snapshot_config:
    new_snapshot_configs Sequence[BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfig]
    Specifies the new configuration about adding Archival Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    update_existing_snapshot_configs Sequence[BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigUpdateExistingSnapshotConfig]
    Specifies the configuration about updating an existing Archival Snapshot Run. Nested schema for update_existing_snapshot_config:
    newSnapshotConfigs List<Property Map>
    Specifies the new configuration about adding Archival Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    updateExistingSnapshotConfigs List<Property Map>
    Specifies the configuration about updating an existing Archival Snapshot Run. Nested schema for update_existing_snapshot_config:

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfig, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigArgs

    ArchivalTargetType string
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    Id double
    Specifies the Archival target to copy the Snapshots to.
    CopyOnlyFullySuccessful bool
    Specifies if Snapshots are copied from a fully successful Protection Group Run or a partially successful Protection Group Run. If false, Snapshots are copied the Protection Group Run, even if the Run was not fully successful i.e. Snapshots were not captured for all Objects in the Protection Group. If true, Snapshots are copied only when the run is fully successful.
    Retention BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetention
    Specifies the retention of a backup. Nested schema for retention:
    ArchivalTargetType string
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    Id float64
    Specifies the Archival target to copy the Snapshots to.
    CopyOnlyFullySuccessful bool
    Specifies if Snapshots are copied from a fully successful Protection Group Run or a partially successful Protection Group Run. If false, Snapshots are copied the Protection Group Run, even if the Run was not fully successful i.e. Snapshots were not captured for all Objects in the Protection Group. If true, Snapshots are copied only when the run is fully successful.
    Retention BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetention
    Specifies the retention of a backup. Nested schema for retention:
    archivalTargetType String
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    id Double
    Specifies the Archival target to copy the Snapshots to.
    copyOnlyFullySuccessful Boolean
    Specifies if Snapshots are copied from a fully successful Protection Group Run or a partially successful Protection Group Run. If false, Snapshots are copied the Protection Group Run, even if the Run was not fully successful i.e. Snapshots were not captured for all Objects in the Protection Group. If true, Snapshots are copied only when the run is fully successful.
    retention BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetention
    Specifies the retention of a backup. Nested schema for retention:
    archivalTargetType string
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    id number
    Specifies the Archival target to copy the Snapshots to.
    copyOnlyFullySuccessful boolean
    Specifies if Snapshots are copied from a fully successful Protection Group Run or a partially successful Protection Group Run. If false, Snapshots are copied the Protection Group Run, even if the Run was not fully successful i.e. Snapshots were not captured for all Objects in the Protection Group. If true, Snapshots are copied only when the run is fully successful.
    retention BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetention
    Specifies the retention of a backup. Nested schema for retention:
    archival_target_type str
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    id float
    Specifies the Archival target to copy the Snapshots to.
    copy_only_fully_successful bool
    Specifies if Snapshots are copied from a fully successful Protection Group Run or a partially successful Protection Group Run. If false, Snapshots are copied the Protection Group Run, even if the Run was not fully successful i.e. Snapshots were not captured for all Objects in the Protection Group. If true, Snapshots are copied only when the run is fully successful.
    retention BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetention
    Specifies the retention of a backup. Nested schema for retention:
    archivalTargetType String
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    id Number
    Specifies the Archival target to copy the Snapshots to.
    copyOnlyFullySuccessful Boolean
    Specifies if Snapshots are copied from a fully successful Protection Group Run or a partially successful Protection Group Run. If false, Snapshots are copied the Protection Group Run, even if the Run was not fully successful i.e. Snapshots were not captured for all Objects in the Protection Group. If true, Snapshots are copied only when the run is fully successful.
    retention Property Map
    Specifies the retention of a backup. Nested schema for retention:

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetention, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionArgs

    Duration double
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    Unit string
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    DataLockConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionDataLockConfig
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:
    Duration float64
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    Unit string
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    DataLockConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionDataLockConfig
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:
    duration Double
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    unit String
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    dataLockConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionDataLockConfig
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:
    duration number
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    unit string
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    dataLockConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionDataLockConfig
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:
    duration float
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    unit str
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    data_lock_config BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionDataLockConfig
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:
    duration Number
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    unit String
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    dataLockConfig Property Map
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionDataLockConfig, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigNewSnapshotConfigRetentionDataLockConfigArgs

    Duration double
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    Mode string
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    Unit string
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    EnableWormOnExternalTarget bool
    Specifies whether objects in the external target associated with this policy need to be made immutable.
    Duration float64
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    Mode string
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    Unit string
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    EnableWormOnExternalTarget bool
    Specifies whether objects in the external target associated with this policy need to be made immutable.
    duration Double
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    mode String
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    unit String
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    enableWormOnExternalTarget Boolean
    Specifies whether objects in the external target associated with this policy need to be made immutable.
    duration number
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    mode string
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    unit string
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    enableWormOnExternalTarget boolean
    Specifies whether objects in the external target associated with this policy need to be made immutable.
    duration float
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    mode str
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    unit str
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    enable_worm_on_external_target bool
    Specifies whether objects in the external target associated with this policy need to be made immutable.
    duration Number
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    mode String
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    unit String
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    enableWormOnExternalTarget Boolean
    Specifies whether objects in the external target associated with this policy need to be made immutable.

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigUpdateExistingSnapshotConfig, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamArchivalSnapshotConfigUpdateExistingSnapshotConfigArgs

    ArchivalTargetType string
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    Id double
    Specifies the id of the archival target.
    DataLock string
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    DaysToKeep double
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    DeleteSnapshot bool
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    EnableLegalHold bool
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    Name string
    Specifies the name of the archival target.
    Resync bool
    Specifies whether to retry the archival operation in case if earlier attempt failed. If not specified or set to false, archival is not retried.
    ArchivalTargetType string
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    Id float64
    Specifies the id of the archival target.
    DataLock string
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    DaysToKeep float64
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    DeleteSnapshot bool
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    EnableLegalHold bool
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    Name string
    Specifies the name of the archival target.
    Resync bool
    Specifies whether to retry the archival operation in case if earlier attempt failed. If not specified or set to false, archival is not retried.
    archivalTargetType String
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    id Double
    Specifies the id of the archival target.
    dataLock String
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    daysToKeep Double
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    deleteSnapshot Boolean
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enableLegalHold Boolean
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    name String
    Specifies the name of the archival target.
    resync Boolean
    Specifies whether to retry the archival operation in case if earlier attempt failed. If not specified or set to false, archival is not retried.
    archivalTargetType string
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    id number
    Specifies the id of the archival target.
    dataLock string
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    daysToKeep number
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    deleteSnapshot boolean
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enableLegalHold boolean
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    name string
    Specifies the name of the archival target.
    resync boolean
    Specifies whether to retry the archival operation in case if earlier attempt failed. If not specified or set to false, archival is not retried.
    archival_target_type str
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    id float
    Specifies the id of the archival target.
    data_lock str
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    days_to_keep float
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    delete_snapshot bool
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enable_legal_hold bool
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    name str
    Specifies the name of the archival target.
    resync bool
    Specifies whether to retry the archival operation in case if earlier attempt failed. If not specified or set to false, archival is not retried.
    archivalTargetType String
    Specifies the snapshot's archival target type from which recovery has been performed.

    • Constraints: Allowable values are: Tape, Cloud, Nas.
    id Number
    Specifies the id of the archival target.
    dataLock String
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    daysToKeep Number
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    deleteSnapshot Boolean
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enableLegalHold Boolean
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    name String
    Specifies the name of the archival target.
    resync Boolean
    Specifies whether to retry the archival operation in case if earlier attempt failed. If not specified or set to false, archival is not retried.

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfig, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamLocalSnapshotConfigArgs

    DataLock string
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    DaysToKeep double
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    DeleteSnapshot bool
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    EnableLegalHold bool
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    DataLock string
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    DaysToKeep float64
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    DeleteSnapshot bool
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    EnableLegalHold bool
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    dataLock String
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    daysToKeep Double
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    deleteSnapshot Boolean
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enableLegalHold Boolean
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    dataLock string
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    daysToKeep number
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    deleteSnapshot boolean
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enableLegalHold boolean
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    data_lock str
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    days_to_keep float
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    delete_snapshot bool
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enable_legal_hold bool
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    dataLock String
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    daysToKeep Number
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    deleteSnapshot Boolean
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enableLegalHold Boolean
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfig, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigArgs

    NewSnapshotConfigs List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfig>
    Specifies the new configuration about adding Replication Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    UpdateExistingSnapshotConfigs List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigUpdateExistingSnapshotConfig>
    Specifies the configuration about updating an existing Replication Snapshot Run. Nested schema for update_existing_snapshot_config:
    NewSnapshotConfigs []BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfig
    Specifies the new configuration about adding Replication Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    UpdateExistingSnapshotConfigs []BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigUpdateExistingSnapshotConfig
    Specifies the configuration about updating an existing Replication Snapshot Run. Nested schema for update_existing_snapshot_config:
    newSnapshotConfigs List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfig>
    Specifies the new configuration about adding Replication Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    updateExistingSnapshotConfigs List<BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigUpdateExistingSnapshotConfig>
    Specifies the configuration about updating an existing Replication Snapshot Run. Nested schema for update_existing_snapshot_config:
    newSnapshotConfigs BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfig[]
    Specifies the new configuration about adding Replication Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    updateExistingSnapshotConfigs BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigUpdateExistingSnapshotConfig[]
    Specifies the configuration about updating an existing Replication Snapshot Run. Nested schema for update_existing_snapshot_config:
    new_snapshot_configs Sequence[BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfig]
    Specifies the new configuration about adding Replication Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    update_existing_snapshot_configs Sequence[BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigUpdateExistingSnapshotConfig]
    Specifies the configuration about updating an existing Replication Snapshot Run. Nested schema for update_existing_snapshot_config:
    newSnapshotConfigs List<Property Map>
    Specifies the new configuration about adding Replication Snapshot to existing Protection Group Run. Nested schema for new_snapshot_config:
    updateExistingSnapshotConfigs List<Property Map>
    Specifies the configuration about updating an existing Replication Snapshot Run. Nested schema for update_existing_snapshot_config:

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfig, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigArgs

    Id double
    Specifies id of Remote Cluster to copy the Snapshots to.
    Retention BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetention
    Specifies the retention of a backup. Nested schema for retention:
    Id float64
    Specifies id of Remote Cluster to copy the Snapshots to.
    Retention BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetention
    Specifies the retention of a backup. Nested schema for retention:
    id Double
    Specifies id of Remote Cluster to copy the Snapshots to.
    retention BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetention
    Specifies the retention of a backup. Nested schema for retention:
    id number
    Specifies id of Remote Cluster to copy the Snapshots to.
    retention BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetention
    Specifies the retention of a backup. Nested schema for retention:
    id float
    Specifies id of Remote Cluster to copy the Snapshots to.
    retention BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetention
    Specifies the retention of a backup. Nested schema for retention:
    id Number
    Specifies id of Remote Cluster to copy the Snapshots to.
    retention Property Map
    Specifies the retention of a backup. Nested schema for retention:

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetention, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionArgs

    Duration double
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    Unit string
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    DataLockConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionDataLockConfig
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:
    Duration float64
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    Unit string
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    DataLockConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionDataLockConfig
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:
    duration Double
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    unit String
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    dataLockConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionDataLockConfig
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:
    duration number
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    unit string
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    dataLockConfig BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionDataLockConfig
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:
    duration float
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    unit str
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    data_lock_config BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionDataLockConfig
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:
    duration Number
    Specifies the duration for a backup retention. Example. If duration is 7 and unit is Months, the retention of a backup is 7 * 30 = 210 days.

    • Constraints: The minimum value is 1.
    unit String
    Specificies the Retention Unit of a backup measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Years' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    dataLockConfig Property Map
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted. Nested schema for data_lock_config:

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionDataLockConfig, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigNewSnapshotConfigRetentionDataLockConfigArgs

    Duration double
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    Mode string
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    Unit string
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    EnableWormOnExternalTarget bool
    Specifies whether objects in the external target associated with this policy need to be made immutable.
    Duration float64
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    Mode string
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    Unit string
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    EnableWormOnExternalTarget bool
    Specifies whether objects in the external target associated with this policy need to be made immutable.
    duration Double
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    mode String
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    unit String
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    enableWormOnExternalTarget Boolean
    Specifies whether objects in the external target associated with this policy need to be made immutable.
    duration number
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    mode string
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    unit string
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    enableWormOnExternalTarget boolean
    Specifies whether objects in the external target associated with this policy need to be made immutable.
    duration float
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    mode str
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    unit str
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    enable_worm_on_external_target bool
    Specifies whether objects in the external target associated with this policy need to be made immutable.
    duration Number
    Specifies the duration for a dataLock. Example. If duration is 7 and unit is Months, the dataLock is enabled for last 7 * 30 = 210 days of the backup.

    • Constraints: The minimum value is 1.
    mode String
    Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    unit String
    Specificies the Retention Unit of a dataLock measured in days, months or years. If unit is 'Months', then number specified in duration is multiplied to 30. Example: If duration is 4 and unit is 'Months' then number of retention days will be 30 * 4 = 120 days. If unit is 'Years', then number specified in duration is multiplied to 365. If duration is 2 and unit is 'Months' then number of retention days will be 365 * 2 = 730 days.

    • Constraints: Allowable values are: Days, Weeks, Months, Years.
    enableWormOnExternalTarget Boolean
    Specifies whether objects in the external target associated with this policy need to be made immutable.

    BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigUpdateExistingSnapshotConfig, BackupRecoveryUpdateProtectionGroupRunRequestUpdateProtectionGroupRunParamReplicationSnapshotConfigUpdateExistingSnapshotConfigArgs

    Id double
    Specifies the cluster id of the replication cluster.
    DataLock string
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    DaysToKeep double
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    DeleteSnapshot bool
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    EnableLegalHold bool
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    Name string
    Specifies the cluster name of the replication cluster.
    Resync bool
    Specifies whether to retry the replication operation in case if earlier attempt failed. If not specified or set to false, replication is not retried.
    Id float64
    Specifies the cluster id of the replication cluster.
    DataLock string
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    DaysToKeep float64
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    DeleteSnapshot bool
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    EnableLegalHold bool
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    Name string
    Specifies the cluster name of the replication cluster.
    Resync bool
    Specifies whether to retry the replication operation in case if earlier attempt failed. If not specified or set to false, replication is not retried.
    id Double
    Specifies the cluster id of the replication cluster.
    dataLock String
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    daysToKeep Double
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    deleteSnapshot Boolean
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enableLegalHold Boolean
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    name String
    Specifies the cluster name of the replication cluster.
    resync Boolean
    Specifies whether to retry the replication operation in case if earlier attempt failed. If not specified or set to false, replication is not retried.
    id number
    Specifies the cluster id of the replication cluster.
    dataLock string
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    daysToKeep number
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    deleteSnapshot boolean
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enableLegalHold boolean
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    name string
    Specifies the cluster name of the replication cluster.
    resync boolean
    Specifies whether to retry the replication operation in case if earlier attempt failed. If not specified or set to false, replication is not retried.
    id float
    Specifies the cluster id of the replication cluster.
    data_lock str
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    days_to_keep float
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    delete_snapshot bool
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enable_legal_hold bool
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    name str
    Specifies the cluster name of the replication cluster.
    resync bool
    Specifies whether to retry the replication operation in case if earlier attempt failed. If not specified or set to false, replication is not retried.
    id Number
    Specifies the cluster id of the replication cluster.
    dataLock String
    Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

    • Constraints: Allowable values are: Compliance, Administrative.
    daysToKeep Number
    Specifies number of days to retain the snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.
    deleteSnapshot Boolean
    Specifies whether to delete the snapshot. When this is set to true, all other params will be ignored.
    enableLegalHold Boolean
    Specifies whether to retain the snapshot for legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.
    name String
    Specifies the cluster name of the replication cluster.
    resync Boolean
    Specifies whether to retry the replication operation in case if earlier attempt failed. If not specified or set to false, replication is not retried.

    Import

    Not Supported

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

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm