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

ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequest

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

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const backupRecoveryPerformActionOnProtectionGroupRunRequestInstance = new ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequest("backupRecoveryPerformActionOnProtectionGroupRunRequestInstance", {
    action: "Pause",
    cancelParams: [{
        archivalTaskIds: ["archivalTaskId"],
        cloudSpinTaskIds: ["cloudSpinTaskId"],
        localTaskId: "local_task_id",
        objectIds: [1],
        replicationTaskIds: ["replicationTaskId"],
        runId: "run_id",
    }],
    groupId: "123:11:1",
    pauseParams: [{
        runId: "run_id",
    }],
    resumeParams: [{
        runId: "run_id",
    }],
    xIbmTenantId: "x_ibm_tenant_id",
});

    import pulumi
import pulumi_ibm as ibm

backup_recovery_perform_action_on_protection_group_run_request_instance = ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequest("backupRecoveryPerformActionOnProtectionGroupRunRequestInstance",
    action="Pause",
    cancel_params=[{
        "archival_task_ids": ["archivalTaskId"],
        "cloud_spin_task_ids": ["cloudSpinTaskId"],
        "local_task_id": "local_task_id",
        "object_ids": [1],
        "replication_task_ids": ["replicationTaskId"],
        "run_id": "run_id",
    }],
    group_id="123:11:1",
    pause_params=[{
        "run_id": "run_id",
    }],
    resume_params=[{
        "run_id": "run_id",
    }],
    x_ibm_tenant_id="x_ibm_tenant_id")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewBackupRecoveryPerformActionOnProtectionGroupRunRequest(ctx, "backupRecoveryPerformActionOnProtectionGroupRunRequestInstance", &ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs{
			Action: pulumi.String("Pause"),
			CancelParams: ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArray{
				&ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs{
					ArchivalTaskIds: pulumi.StringArray{
						pulumi.String("archivalTaskId"),
					},
					CloudSpinTaskIds: pulumi.StringArray{
						pulumi.String("cloudSpinTaskId"),
					},
					LocalTaskId: pulumi.String("local_task_id"),
					ObjectIds: pulumi.Float64Array{
						pulumi.Float64(1),
					},
					ReplicationTaskIds: pulumi.StringArray{
						pulumi.String("replicationTaskId"),
					},
					RunId: pulumi.String("run_id"),
				},
			},
			GroupId: pulumi.String("123:11:1"),
			PauseParams: ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArray{
				&ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs{
					RunId: pulumi.String("run_id"),
				},
			},
			ResumeParams: ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArray{
				&ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs{
					RunId: pulumi.String("run_id"),
				},
			},
			XIbmTenantId: pulumi.String("x_ibm_tenant_id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var backupRecoveryPerformActionOnProtectionGroupRunRequestInstance = new Ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequest("backupRecoveryPerformActionOnProtectionGroupRunRequestInstance", new()
    {
        Action = "Pause",
        CancelParams = new[]
        {
            new Ibm.Inputs.BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs
            {
                ArchivalTaskIds = new[]
                {
                    "archivalTaskId",
                },
                CloudSpinTaskIds = new[]
                {
                    "cloudSpinTaskId",
                },
                LocalTaskId = "local_task_id",
                ObjectIds = new[]
                {
                    1,
                },
                ReplicationTaskIds = new[]
                {
                    "replicationTaskId",
                },
                RunId = "run_id",
            },
        },
        GroupId = "123:11:1",
        PauseParams = new[]
        {
            new Ibm.Inputs.BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs
            {
                RunId = "run_id",
            },
        },
        ResumeParams = new[]
        {
            new Ibm.Inputs.BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs
            {
                RunId = "run_id",
            },
        },
        XIbmTenantId = "x_ibm_tenant_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequest;
import com.pulumi.ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs;
import com.pulumi.ibm.inputs.BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs;
import com.pulumi.ibm.inputs.BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs;
import com.pulumi.ibm.inputs.BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs;
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 backupRecoveryPerformActionOnProtectionGroupRunRequestInstance = new BackupRecoveryPerformActionOnProtectionGroupRunRequest("backupRecoveryPerformActionOnProtectionGroupRunRequestInstance", BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs.builder()
            .action("Pause")
            .cancelParams(BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs.builder()
                .archivalTaskIds("archivalTaskId")
                .cloudSpinTaskIds("cloudSpinTaskId")
                .localTaskId("local_task_id")
                .objectIds(1)
                .replicationTaskIds("replicationTaskId")
                .runId("run_id")
                .build())
            .groupId("123:11:1")
            .pauseParams(BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs.builder()
                .runId("run_id")
                .build())
            .resumeParams(BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs.builder()
                .runId("run_id")
                .build())
            .xIbmTenantId("x_ibm_tenant_id")
            .build());

    }
}

    resources:
  backupRecoveryPerformActionOnProtectionGroupRunRequestInstance:
    type: ibm:BackupRecoveryPerformActionOnProtectionGroupRunRequest
    properties:
      action: Pause
      cancelParams:
        - archivalTaskIds:
            - archivalTaskId
          cloudSpinTaskIds:
            - cloudSpinTaskId
          localTaskId: local_task_id
          objectIds:
            - 1
          replicationTaskIds:
            - replicationTaskId
          runId: run_id
      groupId: 123:11:1
      pauseParams:
        - runId: run_id
      resumeParams:
        - runId: run_id
      xIbmTenantId: x_ibm_tenant_id

    Create BackupRecoveryPerformActionOnProtectionGroupRunRequest Resource

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

    Constructor syntax

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

@overload
def BackupRecoveryPerformActionOnProtectionGroupRunRequest(resource_name: str,
                                                           opts: Optional[ResourceOptions] = None,
                                                           action: Optional[str] = None,
                                                           group_id: Optional[str] = None,
                                                           x_ibm_tenant_id: Optional[str] = None,
                                                           backup_recovery_perform_action_on_protection_group_run_request_id: Optional[str] = None,
                                                           cancel_params: Optional[Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs]] = None,
                                                           pause_params: Optional[Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs]] = None,
                                                           resume_params: Optional[Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs]] = None)
    func NewBackupRecoveryPerformActionOnProtectionGroupRunRequest(ctx *Context, name string, args BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs, opts ...ResourceOption) (*BackupRecoveryPerformActionOnProtectionGroupRunRequest, error)
    public BackupRecoveryPerformActionOnProtectionGroupRunRequest(string name, BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs args, CustomResourceOptions? opts = null)
    public BackupRecoveryPerformActionOnProtectionGroupRunRequest(String name, BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs args)
public BackupRecoveryPerformActionOnProtectionGroupRunRequest(String name, BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs args, CustomResourceOptions options)

    type: ibm:BackupRecoveryPerformActionOnProtectionGroupRunRequest
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 BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs
    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 BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs
    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 BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs
    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 backupRecoveryPerformActionOnProtectionGroupRunRequestResource = new Ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequest("backupRecoveryPerformActionOnProtectionGroupRunRequestResource", new()
{
    Action = "string",
    GroupId = "string",
    XIbmTenantId = "string",
    BackupRecoveryPerformActionOnProtectionGroupRunRequestId = "string",
    CancelParams = new[]
    {
        new Ibm.Inputs.BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs
        {
            RunId = "string",
            ArchivalTaskIds = new[]
            {
                "string",
            },
            CloudSpinTaskIds = new[]
            {
                "string",
            },
            LocalTaskId = "string",
            ObjectIds = new[]
            {
                0,
            },
            ReplicationTaskIds = new[]
            {
                "string",
            },
        },
    },
    PauseParams = new[]
    {
        new Ibm.Inputs.BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs
        {
            RunId = "string",
        },
    },
    ResumeParams = new[]
    {
        new Ibm.Inputs.BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs
        {
            RunId = "string",
        },
    },
});

    example, err := ibm.NewBackupRecoveryPerformActionOnProtectionGroupRunRequest(ctx, "backupRecoveryPerformActionOnProtectionGroupRunRequestResource", &ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs{
	Action:       pulumi.String("string"),
	GroupId:      pulumi.String("string"),
	XIbmTenantId: pulumi.String("string"),
	BackupRecoveryPerformActionOnProtectionGroupRunRequestId: pulumi.String("string"),
	CancelParams: ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArray{
		&ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs{
			RunId: pulumi.String("string"),
			ArchivalTaskIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			CloudSpinTaskIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			LocalTaskId: pulumi.String("string"),
			ObjectIds: pulumi.Float64Array{
				pulumi.Float64(0),
			},
			ReplicationTaskIds: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	PauseParams: ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArray{
		&ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs{
			RunId: pulumi.String("string"),
		},
	},
	ResumeParams: ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArray{
		&ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs{
			RunId: pulumi.String("string"),
		},
	},
})

    var backupRecoveryPerformActionOnProtectionGroupRunRequestResource = new BackupRecoveryPerformActionOnProtectionGroupRunRequest("backupRecoveryPerformActionOnProtectionGroupRunRequestResource", BackupRecoveryPerformActionOnProtectionGroupRunRequestArgs.builder()
    .action("string")
    .groupId("string")
    .xIbmTenantId("string")
    .backupRecoveryPerformActionOnProtectionGroupRunRequestId("string")
    .cancelParams(BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs.builder()
        .runId("string")
        .archivalTaskIds("string")
        .cloudSpinTaskIds("string")
        .localTaskId("string")
        .objectIds(0)
        .replicationTaskIds("string")
        .build())
    .pauseParams(BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs.builder()
        .runId("string")
        .build())
    .resumeParams(BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs.builder()
        .runId("string")
        .build())
    .build());

    backup_recovery_perform_action_on_protection_group_run_request_resource = ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequest("backupRecoveryPerformActionOnProtectionGroupRunRequestResource",
    action="string",
    group_id="string",
    x_ibm_tenant_id="string",
    backup_recovery_perform_action_on_protection_group_run_request_id="string",
    cancel_params=[{
        "run_id": "string",
        "archival_task_ids": ["string"],
        "cloud_spin_task_ids": ["string"],
        "local_task_id": "string",
        "object_ids": [0],
        "replication_task_ids": ["string"],
    }],
    pause_params=[{
        "run_id": "string",
    }],
    resume_params=[{
        "run_id": "string",
    }])

    const backupRecoveryPerformActionOnProtectionGroupRunRequestResource = new ibm.BackupRecoveryPerformActionOnProtectionGroupRunRequest("backupRecoveryPerformActionOnProtectionGroupRunRequestResource", {
    action: "string",
    groupId: "string",
    xIbmTenantId: "string",
    backupRecoveryPerformActionOnProtectionGroupRunRequestId: "string",
    cancelParams: [{
        runId: "string",
        archivalTaskIds: ["string"],
        cloudSpinTaskIds: ["string"],
        localTaskId: "string",
        objectIds: [0],
        replicationTaskIds: ["string"],
    }],
    pauseParams: [{
        runId: "string",
    }],
    resumeParams: [{
        runId: "string",
    }],
});

    type: ibm:BackupRecoveryPerformActionOnProtectionGroupRunRequest
properties:
    action: string
    backupRecoveryPerformActionOnProtectionGroupRunRequestId: string
    cancelParams:
        - archivalTaskIds:
            - string
          cloudSpinTaskIds:
            - string
          localTaskId: string
          objectIds:
            - 0
          replicationTaskIds:
            - string
          runId: string
    groupId: string
    pauseParams:
        - runId: string
    resumeParams:
        - runId: string
    xIbmTenantId: string

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

    Action string
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    GroupId string
    Specifies the protection group ID
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    BackupRecoveryPerformActionOnProtectionGroupRunRequestId string
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    CancelParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParam>
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    PauseParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParam>
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    ResumeParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParam>
    Specifies the resume action params for a protection run. Nested schema for resume_params:
    Action string
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    GroupId string
    Specifies the protection group ID
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    BackupRecoveryPerformActionOnProtectionGroupRunRequestId string
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    CancelParams []BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    PauseParams []BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    ResumeParams []BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs
    Specifies the resume action params for a protection run. Nested schema for resume_params:
    action String
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    groupId String
    Specifies the protection group ID
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    backupRecoveryPerformActionOnProtectionGroupRunRequestId String
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    cancelParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParam>
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    pauseParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParam>
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    resumeParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParam>
    Specifies the resume action params for a protection run. Nested schema for resume_params:
    action string
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    groupId string
    Specifies the protection group ID
    xIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    backupRecoveryPerformActionOnProtectionGroupRunRequestId string
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    cancelParams BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParam[]
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    pauseParams BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParam[]
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    resumeParams BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParam[]
    Specifies the resume action params for a protection run. Nested schema for resume_params:
    action str
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    group_id str
    Specifies the protection group ID
    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_perform_action_on_protection_group_run_request_id str
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    cancel_params Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs]
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    pause_params Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs]
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    resume_params Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs]
    Specifies the resume action params for a protection run. Nested schema for resume_params:
    action String
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    groupId String
    Specifies the protection group ID
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    backupRecoveryPerformActionOnProtectionGroupRunRequestId String
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    cancelParams List<Property Map>
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    pauseParams List<Property Map>
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    resumeParams List<Property Map>
    Specifies the resume action params for a protection run. Nested schema for resume_params:

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BackupRecoveryPerformActionOnProtectionGroupRunRequest Resource

    Get an existing BackupRecoveryPerformActionOnProtectionGroupRunRequest 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?: BackupRecoveryPerformActionOnProtectionGroupRunRequestState, opts?: CustomResourceOptions): BackupRecoveryPerformActionOnProtectionGroupRunRequest
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        backup_recovery_perform_action_on_protection_group_run_request_id: Optional[str] = None,
        cancel_params: Optional[Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs]] = None,
        group_id: Optional[str] = None,
        pause_params: Optional[Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs]] = None,
        resume_params: Optional[Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs]] = None,
        x_ibm_tenant_id: Optional[str] = None) -> BackupRecoveryPerformActionOnProtectionGroupRunRequest
    func GetBackupRecoveryPerformActionOnProtectionGroupRunRequest(ctx *Context, name string, id IDInput, state *BackupRecoveryPerformActionOnProtectionGroupRunRequestState, opts ...ResourceOption) (*BackupRecoveryPerformActionOnProtectionGroupRunRequest, error)
    public static BackupRecoveryPerformActionOnProtectionGroupRunRequest Get(string name, Input<string> id, BackupRecoveryPerformActionOnProtectionGroupRunRequestState? state, CustomResourceOptions? opts = null)
    public static BackupRecoveryPerformActionOnProtectionGroupRunRequest get(String name, Output<String> id, BackupRecoveryPerformActionOnProtectionGroupRunRequestState state, CustomResourceOptions options)
    resources:  _:    type: ibm:BackupRecoveryPerformActionOnProtectionGroupRunRequest    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:
    Action string
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    BackupRecoveryPerformActionOnProtectionGroupRunRequestId string
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    CancelParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParam>
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    GroupId string
    Specifies the protection group ID
    PauseParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParam>
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    ResumeParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParam>
    Specifies the resume action params for a protection run. Nested schema for resume_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.
    Action string
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    BackupRecoveryPerformActionOnProtectionGroupRunRequestId string
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    CancelParams []BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    GroupId string
    Specifies the protection group ID
    PauseParams []BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    ResumeParams []BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs
    Specifies the resume action params for a protection run. Nested schema for resume_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.
    action String
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    backupRecoveryPerformActionOnProtectionGroupRunRequestId String
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    cancelParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParam>
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    groupId String
    Specifies the protection group ID
    pauseParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParam>
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    resumeParams List<BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParam>
    Specifies the resume action params for a protection run. Nested schema for resume_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.
    action string
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    backupRecoveryPerformActionOnProtectionGroupRunRequestId string
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    cancelParams BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParam[]
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    groupId string
    Specifies the protection group ID
    pauseParams BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParam[]
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    resumeParams BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParam[]
    Specifies the resume action params for a protection run. Nested schema for resume_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.
    action str
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    backup_recovery_perform_action_on_protection_group_run_request_id str
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    cancel_params Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs]
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    group_id str
    Specifies the protection group ID
    pause_params Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs]
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    resume_params Sequence[BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs]
    Specifies the resume action params for a protection run. Nested schema for resume_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.
    action String
    Specifies the type of the action which will be performed on protection runs.

    • Constraints: Allowable values are: Pause, Resume, Cancel.
    backupRecoveryPerformActionOnProtectionGroupRunRequestId String
    The unique identifier of the backup_recovery_perform_action_on_protection_group_run_request.
    cancelParams List<Property Map>
    Specifies the cancel action params for a protection run. Nested schema for cancel_params:
    groupId String
    Specifies the protection group ID
    pauseParams List<Property Map>
    Specifies the pause action params for a protection run. Nested schema for pause_params:
    resumeParams List<Property Map>
    Specifies the resume action params for a protection run. Nested schema for resume_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

    BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParam, BackupRecoveryPerformActionOnProtectionGroupRunRequestCancelParamArgs

    RunId string
    Specifies a unique run id of the Protection Group run.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    ArchivalTaskIds List<string>
    Specifies the task id of the archival run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    CloudSpinTaskIds List<string>
    Specifies the task id of the cloudSpin run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    LocalTaskId string
    Specifies the task id of the local run.

    • Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.
    ObjectIds List<double>
    List of entity ids for which we need to cancel the backup tasks. If this is provided it will not cancel the complete run but will cancel only subset of backup tasks (if backup tasks are cancelled correspoding copy task will also get cancelled). If the backup tasks are completed successfully it will not cancel those backup tasks.
    ReplicationTaskIds List<string>
    Specifies the task id of the replication run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    RunId string
    Specifies a unique run id of the Protection Group run.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    ArchivalTaskIds []string
    Specifies the task id of the archival run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    CloudSpinTaskIds []string
    Specifies the task id of the cloudSpin run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    LocalTaskId string
    Specifies the task id of the local run.

    • Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.
    ObjectIds []float64
    List of entity ids for which we need to cancel the backup tasks. If this is provided it will not cancel the complete run but will cancel only subset of backup tasks (if backup tasks are cancelled correspoding copy task will also get cancelled). If the backup tasks are completed successfully it will not cancel those backup tasks.
    ReplicationTaskIds []string
    Specifies the task id of the replication run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    runId String
    Specifies a unique run id of the Protection Group run.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    archivalTaskIds List<String>
    Specifies the task id of the archival run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    cloudSpinTaskIds List<String>
    Specifies the task id of the cloudSpin run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    localTaskId String
    Specifies the task id of the local run.

    • Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.
    objectIds List<Double>
    List of entity ids for which we need to cancel the backup tasks. If this is provided it will not cancel the complete run but will cancel only subset of backup tasks (if backup tasks are cancelled correspoding copy task will also get cancelled). If the backup tasks are completed successfully it will not cancel those backup tasks.
    replicationTaskIds List<String>
    Specifies the task id of the replication run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    runId string
    Specifies a unique run id of the Protection Group run.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    archivalTaskIds string[]
    Specifies the task id of the archival run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    cloudSpinTaskIds string[]
    Specifies the task id of the cloudSpin run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    localTaskId string
    Specifies the task id of the local run.

    • Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.
    objectIds number[]
    List of entity ids for which we need to cancel the backup tasks. If this is provided it will not cancel the complete run but will cancel only subset of backup tasks (if backup tasks are cancelled correspoding copy task will also get cancelled). If the backup tasks are completed successfully it will not cancel those backup tasks.
    replicationTaskIds string[]
    Specifies the task id of the replication run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    run_id str
    Specifies a unique run id of the Protection Group run.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    archival_task_ids Sequence[str]
    Specifies the task id of the archival run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    cloud_spin_task_ids Sequence[str]
    Specifies the task id of the cloudSpin run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    local_task_id str
    Specifies the task id of the local run.

    • Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.
    object_ids Sequence[float]
    List of entity ids for which we need to cancel the backup tasks. If this is provided it will not cancel the complete run but will cancel only subset of backup tasks (if backup tasks are cancelled correspoding copy task will also get cancelled). If the backup tasks are completed successfully it will not cancel those backup tasks.
    replication_task_ids Sequence[str]
    Specifies the task id of the replication run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    runId String
    Specifies a unique run id of the Protection Group run.

    • Constraints: The value must match regular expression /^\\d+:\\d+$/.
    archivalTaskIds List<String>
    Specifies the task id of the archival run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    cloudSpinTaskIds List<String>
    Specifies the task id of the cloudSpin run.

    • Constraints: The list items must match regular expression /^\\d+:\\d+:\\d+$/.
    localTaskId String
    Specifies the task id of the local run.

    • Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.
    objectIds List<Number>
    List of entity ids for which we need to cancel the backup tasks. If this is provided it will not cancel the complete run but will cancel only subset of backup tasks (if backup tasks are cancelled correspoding copy task will also get cancelled). If the backup tasks are completed successfully it will not cancel those backup tasks.
    replicationTaskIds List<String>
    Specifies the task id of the replication run.

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

    BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParam, BackupRecoveryPerformActionOnProtectionGroupRunRequestPauseParamArgs

    RunId string
    Specifies a unique run id of the Protection Group run.

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

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

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

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

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

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

    BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParam, BackupRecoveryPerformActionOnProtectionGroupRunRequestResumeParamArgs

    RunId string
    Specifies a unique run id of the Protection Group run.

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

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

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

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

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

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

    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