Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DisasterRecovery
  5. getDrPlan
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.DisasterRecovery.getDrPlan

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Dr Plan resource in Oracle Cloud Infrastructure Disaster Recovery service.

    Get details for the DR plan identified by drPlanId.

    Example Usage

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

const testDrPlan = oci.DisasterRecovery.getDrPlan({
    drPlanId: testDrPlanOciDisasterRecoveryDrPlan.id,
});

    import pulumi
import pulumi_oci as oci

test_dr_plan = oci.DisasterRecovery.get_dr_plan(dr_plan_id=test_dr_plan_oci_disaster_recovery_dr_plan["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/disasterrecovery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := disasterrecovery.GetDrPlan(ctx, &disasterrecovery.GetDrPlanArgs{
			DrPlanId: testDrPlanOciDisasterRecoveryDrPlan.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testDrPlan = Oci.DisasterRecovery.GetDrPlan.Invoke(new()
    {
        DrPlanId = testDrPlanOciDisasterRecoveryDrPlan.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DisasterRecovery.DisasterRecoveryFunctions;
import com.pulumi.oci.DisasterRecovery.inputs.GetDrPlanArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testDrPlan = DisasterRecoveryFunctions.getDrPlan(GetDrPlanArgs.builder()
            .drPlanId(testDrPlanOciDisasterRecoveryDrPlan.id())
            .build());

    }
}

    variables:
  testDrPlan:
    fn::invoke:
      function: oci:DisasterRecovery:getDrPlan
      arguments:
        drPlanId: ${testDrPlanOciDisasterRecoveryDrPlan.id}

    Using getDrPlan

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDrPlan(args: GetDrPlanArgs, opts?: InvokeOptions): Promise<GetDrPlanResult>
function getDrPlanOutput(args: GetDrPlanOutputArgs, opts?: InvokeOptions): Output<GetDrPlanResult>
    def get_dr_plan(dr_plan_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDrPlanResult
def get_dr_plan_output(dr_plan_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDrPlanResult]
    func LookupDrPlan(ctx *Context, args *LookupDrPlanArgs, opts ...InvokeOption) (*LookupDrPlanResult, error)
func LookupDrPlanOutput(ctx *Context, args *LookupDrPlanOutputArgs, opts ...InvokeOption) LookupDrPlanResultOutput

    > Note: This function is named LookupDrPlan in the Go SDK.

    public static class GetDrPlan 
{
    public static Task<GetDrPlanResult> InvokeAsync(GetDrPlanArgs args, InvokeOptions? opts = null)
    public static Output<GetDrPlanResult> Invoke(GetDrPlanInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDrPlanResult> getDrPlan(GetDrPlanArgs args, InvokeOptions options)
public static Output<GetDrPlanResult> getDrPlan(GetDrPlanArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:DisasterRecovery/getDrPlan:getDrPlan
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DrPlanId string
    The OCID of the DR plan. Example: ocid1.drplan.oc1..uniqueID
    DrPlanId string
    The OCID of the DR plan. Example: ocid1.drplan.oc1..uniqueID
    drPlanId String
    The OCID of the DR plan. Example: ocid1.drplan.oc1..uniqueID
    drPlanId string
    The OCID of the DR plan. Example: ocid1.drplan.oc1..uniqueID
    dr_plan_id str
    The OCID of the DR plan. Example: ocid1.drplan.oc1..uniqueID
    drPlanId String
    The OCID of the DR plan. Example: ocid1.drplan.oc1..uniqueID

    getDrPlan Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    The display name of the group. Example: DATABASE_SWITCHOVER
    DrPlanId string
    DrProtectionGroupId string
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drplan.oc1..uniqueID
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    Id string
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    LifeCycleDetails string
    A message describing the DR plan's current state in more detail.
    LifecycleSubState string
    The current state of the DR plan.
    PeerDrProtectionGroupId string
    The OCID of the peer DR protection group associated with this plan's DR protection group. Example: ocid1.drprotectiongroup.oc1..uniqueID
    PeerRegion string
    The region of the peer DR protection group associated with this plan's DR protection group. Example: us-ashburn-1
    PlanGroups List<GetDrPlanPlanGroup>
    The list of groups in this DR plan.
    RefreshTrigger int
    SourcePlanId string
    If this is a cloned DR plan, the OCID of the source DR plan that was used to clone this DR plan. If this DR plan was not cloned, then the value for this will be null. Example: ocid1.drplan.oc1..uniqueID
    State string
    The current state of the DR plan.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the DR plan was created. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    TimeUpdated string
    The date and time the DR plan was updated. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    Type string
    The type of the DR plan.
    VerifyTrigger int
    CompartmentId string
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    The display name of the group. Example: DATABASE_SWITCHOVER
    DrPlanId string
    DrProtectionGroupId string
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drplan.oc1..uniqueID
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    Id string
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    LifeCycleDetails string
    A message describing the DR plan's current state in more detail.
    LifecycleSubState string
    The current state of the DR plan.
    PeerDrProtectionGroupId string
    The OCID of the peer DR protection group associated with this plan's DR protection group. Example: ocid1.drprotectiongroup.oc1..uniqueID
    PeerRegion string
    The region of the peer DR protection group associated with this plan's DR protection group. Example: us-ashburn-1
    PlanGroups []GetDrPlanPlanGroup
    The list of groups in this DR plan.
    RefreshTrigger int
    SourcePlanId string
    If this is a cloned DR plan, the OCID of the source DR plan that was used to clone this DR plan. If this DR plan was not cloned, then the value for this will be null. Example: ocid1.drplan.oc1..uniqueID
    State string
    The current state of the DR plan.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the DR plan was created. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    TimeUpdated string
    The date and time the DR plan was updated. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    Type string
    The type of the DR plan.
    VerifyTrigger int
    compartmentId String
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    displayName String
    The display name of the group. Example: DATABASE_SWITCHOVER
    drPlanId String
    drProtectionGroupId String
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drplan.oc1..uniqueID
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    id String
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    lifeCycleDetails String
    A message describing the DR plan's current state in more detail.
    lifecycleSubState String
    The current state of the DR plan.
    peerDrProtectionGroupId String
    The OCID of the peer DR protection group associated with this plan's DR protection group. Example: ocid1.drprotectiongroup.oc1..uniqueID
    peerRegion String
    The region of the peer DR protection group associated with this plan's DR protection group. Example: us-ashburn-1
    planGroups List<GetDrPlanPlanGroup>
    The list of groups in this DR plan.
    refreshTrigger Integer
    sourcePlanId String
    If this is a cloned DR plan, the OCID of the source DR plan that was used to clone this DR plan. If this DR plan was not cloned, then the value for this will be null. Example: ocid1.drplan.oc1..uniqueID
    state String
    The current state of the DR plan.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the DR plan was created. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    timeUpdated String
    The date and time the DR plan was updated. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    type String
    The type of the DR plan.
    verifyTrigger Integer
    compartmentId string
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    displayName string
    The display name of the group. Example: DATABASE_SWITCHOVER
    drPlanId string
    drProtectionGroupId string
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drplan.oc1..uniqueID
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    id string
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    lifeCycleDetails string
    A message describing the DR plan's current state in more detail.
    lifecycleSubState string
    The current state of the DR plan.
    peerDrProtectionGroupId string
    The OCID of the peer DR protection group associated with this plan's DR protection group. Example: ocid1.drprotectiongroup.oc1..uniqueID
    peerRegion string
    The region of the peer DR protection group associated with this plan's DR protection group. Example: us-ashburn-1
    planGroups GetDrPlanPlanGroup[]
    The list of groups in this DR plan.
    refreshTrigger number
    sourcePlanId string
    If this is a cloned DR plan, the OCID of the source DR plan that was used to clone this DR plan. If this DR plan was not cloned, then the value for this will be null. Example: ocid1.drplan.oc1..uniqueID
    state string
    The current state of the DR plan.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the DR plan was created. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    timeUpdated string
    The date and time the DR plan was updated. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    type string
    The type of the DR plan.
    verifyTrigger number
    compartment_id str
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    display_name str
    The display name of the group. Example: DATABASE_SWITCHOVER
    dr_plan_id str
    dr_protection_group_id str
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drplan.oc1..uniqueID
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    id str
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    life_cycle_details str
    A message describing the DR plan's current state in more detail.
    lifecycle_sub_state str
    The current state of the DR plan.
    peer_dr_protection_group_id str
    The OCID of the peer DR protection group associated with this plan's DR protection group. Example: ocid1.drprotectiongroup.oc1..uniqueID
    peer_region str
    The region of the peer DR protection group associated with this plan's DR protection group. Example: us-ashburn-1
    plan_groups Sequence[GetDrPlanPlanGroup]
    The list of groups in this DR plan.
    refresh_trigger int
    source_plan_id str
    If this is a cloned DR plan, the OCID of the source DR plan that was used to clone this DR plan. If this DR plan was not cloned, then the value for this will be null. Example: ocid1.drplan.oc1..uniqueID
    state str
    The current state of the DR plan.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the DR plan was created. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    time_updated str
    The date and time the DR plan was updated. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    type str
    The type of the DR plan.
    verify_trigger int
    compartmentId String
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    displayName String
    The display name of the group. Example: DATABASE_SWITCHOVER
    drPlanId String
    drProtectionGroupId String
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drplan.oc1..uniqueID
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    id String
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    lifeCycleDetails String
    A message describing the DR plan's current state in more detail.
    lifecycleSubState String
    The current state of the DR plan.
    peerDrProtectionGroupId String
    The OCID of the peer DR protection group associated with this plan's DR protection group. Example: ocid1.drprotectiongroup.oc1..uniqueID
    peerRegion String
    The region of the peer DR protection group associated with this plan's DR protection group. Example: us-ashburn-1
    planGroups List<Property Map>
    The list of groups in this DR plan.
    refreshTrigger Number
    sourcePlanId String
    If this is a cloned DR plan, the OCID of the source DR plan that was used to clone this DR plan. If this DR plan was not cloned, then the value for this will be null. Example: ocid1.drplan.oc1..uniqueID
    state String
    The current state of the DR plan.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the DR plan was created. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    timeUpdated String
    The date and time the DR plan was updated. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z
    type String
    The type of the DR plan.
    verifyTrigger Number

    Supporting Types

    GetDrPlanPlanGroup

    DisplayName string
    The display name of the group. Example: DATABASE_SWITCHOVER
    Id string
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    IsPauseEnabled bool
    A flag indicating whether this group should be enabled for execution. This flag is only applicable to the USER_DEFINED_PAUSE group. The flag should be null for the remaining group types. Example: true
    RefreshStatus string
    The DR plan step refresh status. Example: STEP_ADDED
    Steps List<GetDrPlanPlanGroupStep>
    The list of steps in the group.
    Type string
    The type of the DR plan.
    DisplayName string
    The display name of the group. Example: DATABASE_SWITCHOVER
    Id string
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    IsPauseEnabled bool
    A flag indicating whether this group should be enabled for execution. This flag is only applicable to the USER_DEFINED_PAUSE group. The flag should be null for the remaining group types. Example: true
    RefreshStatus string
    The DR plan step refresh status. Example: STEP_ADDED
    Steps []GetDrPlanPlanGroupStep
    The list of steps in the group.
    Type string
    The type of the DR plan.
    displayName String
    The display name of the group. Example: DATABASE_SWITCHOVER
    id String
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    isPauseEnabled Boolean
    A flag indicating whether this group should be enabled for execution. This flag is only applicable to the USER_DEFINED_PAUSE group. The flag should be null for the remaining group types. Example: true
    refreshStatus String
    The DR plan step refresh status. Example: STEP_ADDED
    steps List<GetDrPlanPlanGroupStep>
    The list of steps in the group.
    type String
    The type of the DR plan.
    displayName string
    The display name of the group. Example: DATABASE_SWITCHOVER
    id string
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    isPauseEnabled boolean
    A flag indicating whether this group should be enabled for execution. This flag is only applicable to the USER_DEFINED_PAUSE group. The flag should be null for the remaining group types. Example: true
    refreshStatus string
    The DR plan step refresh status. Example: STEP_ADDED
    steps GetDrPlanPlanGroupStep[]
    The list of steps in the group.
    type string
    The type of the DR plan.
    display_name str
    The display name of the group. Example: DATABASE_SWITCHOVER
    id str
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    is_pause_enabled bool
    A flag indicating whether this group should be enabled for execution. This flag is only applicable to the USER_DEFINED_PAUSE group. The flag should be null for the remaining group types. Example: true
    refresh_status str
    The DR plan step refresh status. Example: STEP_ADDED
    steps Sequence[GetDrPlanPlanGroupStep]
    The list of steps in the group.
    type str
    The type of the DR plan.
    displayName String
    The display name of the group. Example: DATABASE_SWITCHOVER
    id String
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    isPauseEnabled Boolean
    A flag indicating whether this group should be enabled for execution. This flag is only applicable to the USER_DEFINED_PAUSE group. The flag should be null for the remaining group types. Example: true
    refreshStatus String
    The DR plan step refresh status. Example: STEP_ADDED
    steps List<Property Map>
    The list of steps in the group.
    type String
    The type of the DR plan.

    GetDrPlanPlanGroupStep

    DisplayName string
    The display name of the group. Example: DATABASE_SWITCHOVER
    ErrorMode string
    The error mode for this step.
    GroupId string
    The unique id of the group to which this step belongs. Must not be modified by user. Example: sgid1.group..uniqueID
    Id string
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    IsEnabled bool
    A flag indicating whether this step should be enabled for execution. Example: true
    MemberId string
    The OCID of the member associated with this step. Example: ocid1.database.oc1..uniqueID
    RefreshStatus string
    The DR plan step refresh status. Example: STEP_ADDED
    Timeout int
    The timeout in seconds for executing this step. Example: 600
    Type string
    The type of the DR plan.
    TypeDisplayName string
    The display name of the DR Plan step type. Example: Database Switchover
    UserDefinedSteps List<GetDrPlanPlanGroupStepUserDefinedStep>
    The details for a user-defined step in a DR plan.
    DisplayName string
    The display name of the group. Example: DATABASE_SWITCHOVER
    ErrorMode string
    The error mode for this step.
    GroupId string
    The unique id of the group to which this step belongs. Must not be modified by user. Example: sgid1.group..uniqueID
    Id string
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    IsEnabled bool
    A flag indicating whether this step should be enabled for execution. Example: true
    MemberId string
    The OCID of the member associated with this step. Example: ocid1.database.oc1..uniqueID
    RefreshStatus string
    The DR plan step refresh status. Example: STEP_ADDED
    Timeout int
    The timeout in seconds for executing this step. Example: 600
    Type string
    The type of the DR plan.
    TypeDisplayName string
    The display name of the DR Plan step type. Example: Database Switchover
    UserDefinedSteps []GetDrPlanPlanGroupStepUserDefinedStep
    The details for a user-defined step in a DR plan.
    displayName String
    The display name of the group. Example: DATABASE_SWITCHOVER
    errorMode String
    The error mode for this step.
    groupId String
    The unique id of the group to which this step belongs. Must not be modified by user. Example: sgid1.group..uniqueID
    id String
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    isEnabled Boolean
    A flag indicating whether this step should be enabled for execution. Example: true
    memberId String
    The OCID of the member associated with this step. Example: ocid1.database.oc1..uniqueID
    refreshStatus String
    The DR plan step refresh status. Example: STEP_ADDED
    timeout Integer
    The timeout in seconds for executing this step. Example: 600
    type String
    The type of the DR plan.
    typeDisplayName String
    The display name of the DR Plan step type. Example: Database Switchover
    userDefinedSteps List<GetDrPlanPlanGroupStepUserDefinedStep>
    The details for a user-defined step in a DR plan.
    displayName string
    The display name of the group. Example: DATABASE_SWITCHOVER
    errorMode string
    The error mode for this step.
    groupId string
    The unique id of the group to which this step belongs. Must not be modified by user. Example: sgid1.group..uniqueID
    id string
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    isEnabled boolean
    A flag indicating whether this step should be enabled for execution. Example: true
    memberId string
    The OCID of the member associated with this step. Example: ocid1.database.oc1..uniqueID
    refreshStatus string
    The DR plan step refresh status. Example: STEP_ADDED
    timeout number
    The timeout in seconds for executing this step. Example: 600
    type string
    The type of the DR plan.
    typeDisplayName string
    The display name of the DR Plan step type. Example: Database Switchover
    userDefinedSteps GetDrPlanPlanGroupStepUserDefinedStep[]
    The details for a user-defined step in a DR plan.
    display_name str
    The display name of the group. Example: DATABASE_SWITCHOVER
    error_mode str
    The error mode for this step.
    group_id str
    The unique id of the group to which this step belongs. Must not be modified by user. Example: sgid1.group..uniqueID
    id str
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    is_enabled bool
    A flag indicating whether this step should be enabled for execution. Example: true
    member_id str
    The OCID of the member associated with this step. Example: ocid1.database.oc1..uniqueID
    refresh_status str
    The DR plan step refresh status. Example: STEP_ADDED
    timeout int
    The timeout in seconds for executing this step. Example: 600
    type str
    The type of the DR plan.
    type_display_name str
    The display name of the DR Plan step type. Example: Database Switchover
    user_defined_steps Sequence[GetDrPlanPlanGroupStepUserDefinedStep]
    The details for a user-defined step in a DR plan.
    displayName String
    The display name of the group. Example: DATABASE_SWITCHOVER
    errorMode String
    The error mode for this step.
    groupId String
    The unique id of the group to which this step belongs. Must not be modified by user. Example: sgid1.group..uniqueID
    id String
    The unique id of the step. Must not be modified by the user. Example: sgid1.step..uniqueID
    isEnabled Boolean
    A flag indicating whether this step should be enabled for execution. Example: true
    memberId String
    The OCID of the member associated with this step. Example: ocid1.database.oc1..uniqueID
    refreshStatus String
    The DR plan step refresh status. Example: STEP_ADDED
    timeout Number
    The timeout in seconds for executing this step. Example: 600
    type String
    The type of the DR plan.
    typeDisplayName String
    The display name of the DR Plan step type. Example: Database Switchover
    userDefinedSteps List<Property Map>
    The details for a user-defined step in a DR plan.

    GetDrPlanPlanGroupStepUserDefinedStep

    FunctionId string
    The OCID of function to be invoked. Example: ocid1.fnfunc.oc1..uniqueID
    FunctionRegion string
    The region in which the function is deployed. Example: us-ashburn-1
    ObjectStorageScriptLocations List<GetDrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation>
    The details of an object storage script location for a user-defined step in a DR plan.
    RequestBody string
    The request body for the function. Example: { "FnParam1", "FnParam2" }
    RunAsUser string
    The userid on the instance to be used for executing the script or command. Example: opc
    RunOnInstanceId string
    The OCID of the instance on which this script or command should be executed.
    RunOnInstanceRegion string
    The region of the instance where this script or command should be executed. Example: us-ashburn-1
    ScriptCommand string
    The script name and arguments. Example: /usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3
    StepType string
    The type of the user-defined step.
    FunctionId string
    The OCID of function to be invoked. Example: ocid1.fnfunc.oc1..uniqueID
    FunctionRegion string
    The region in which the function is deployed. Example: us-ashburn-1
    ObjectStorageScriptLocations []GetDrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation
    The details of an object storage script location for a user-defined step in a DR plan.
    RequestBody string
    The request body for the function. Example: { "FnParam1", "FnParam2" }
    RunAsUser string
    The userid on the instance to be used for executing the script or command. Example: opc
    RunOnInstanceId string
    The OCID of the instance on which this script or command should be executed.
    RunOnInstanceRegion string
    The region of the instance where this script or command should be executed. Example: us-ashburn-1
    ScriptCommand string
    The script name and arguments. Example: /usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3
    StepType string
    The type of the user-defined step.
    functionId String
    The OCID of function to be invoked. Example: ocid1.fnfunc.oc1..uniqueID
    functionRegion String
    The region in which the function is deployed. Example: us-ashburn-1
    objectStorageScriptLocations List<GetDrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation>
    The details of an object storage script location for a user-defined step in a DR plan.
    requestBody String
    The request body for the function. Example: { "FnParam1", "FnParam2" }
    runAsUser String
    The userid on the instance to be used for executing the script or command. Example: opc
    runOnInstanceId String
    The OCID of the instance on which this script or command should be executed.
    runOnInstanceRegion String
    The region of the instance where this script or command should be executed. Example: us-ashburn-1
    scriptCommand String
    The script name and arguments. Example: /usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3
    stepType String
    The type of the user-defined step.
    functionId string
    The OCID of function to be invoked. Example: ocid1.fnfunc.oc1..uniqueID
    functionRegion string
    The region in which the function is deployed. Example: us-ashburn-1
    objectStorageScriptLocations GetDrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation[]
    The details of an object storage script location for a user-defined step in a DR plan.
    requestBody string
    The request body for the function. Example: { "FnParam1", "FnParam2" }
    runAsUser string
    The userid on the instance to be used for executing the script or command. Example: opc
    runOnInstanceId string
    The OCID of the instance on which this script or command should be executed.
    runOnInstanceRegion string
    The region of the instance where this script or command should be executed. Example: us-ashburn-1
    scriptCommand string
    The script name and arguments. Example: /usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3
    stepType string
    The type of the user-defined step.
    function_id str
    The OCID of function to be invoked. Example: ocid1.fnfunc.oc1..uniqueID
    function_region str
    The region in which the function is deployed. Example: us-ashburn-1
    object_storage_script_locations Sequence[GetDrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation]
    The details of an object storage script location for a user-defined step in a DR plan.
    request_body str
    The request body for the function. Example: { "FnParam1", "FnParam2" }
    run_as_user str
    The userid on the instance to be used for executing the script or command. Example: opc
    run_on_instance_id str
    The OCID of the instance on which this script or command should be executed.
    run_on_instance_region str
    The region of the instance where this script or command should be executed. Example: us-ashburn-1
    script_command str
    The script name and arguments. Example: /usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3
    step_type str
    The type of the user-defined step.
    functionId String
    The OCID of function to be invoked. Example: ocid1.fnfunc.oc1..uniqueID
    functionRegion String
    The region in which the function is deployed. Example: us-ashburn-1
    objectStorageScriptLocations List<Property Map>
    The details of an object storage script location for a user-defined step in a DR plan.
    requestBody String
    The request body for the function. Example: { "FnParam1", "FnParam2" }
    runAsUser String
    The userid on the instance to be used for executing the script or command. Example: opc
    runOnInstanceId String
    The OCID of the instance on which this script or command should be executed.
    runOnInstanceRegion String
    The region of the instance where this script or command should be executed. Example: us-ashburn-1
    scriptCommand String
    The script name and arguments. Example: /usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3
    stepType String
    The type of the user-defined step.

    GetDrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation

    Bucket string
    The bucket name inside the object storage namespace. Example: custom_dr_scripts
    Namespace string
    The namespace in object storage (Note - this is usually the tenancy name). Example: myocitenancy
    Object string
    The object name inside the object storage bucket. Example: validate_app_start.sh
    Bucket string
    The bucket name inside the object storage namespace. Example: custom_dr_scripts
    Namespace string
    The namespace in object storage (Note - this is usually the tenancy name). Example: myocitenancy
    Object string
    The object name inside the object storage bucket. Example: validate_app_start.sh
    bucket String
    The bucket name inside the object storage namespace. Example: custom_dr_scripts
    namespace String
    The namespace in object storage (Note - this is usually the tenancy name). Example: myocitenancy
    object String
    The object name inside the object storage bucket. Example: validate_app_start.sh
    bucket string
    The bucket name inside the object storage namespace. Example: custom_dr_scripts
    namespace string
    The namespace in object storage (Note - this is usually the tenancy name). Example: myocitenancy
    object string
    The object name inside the object storage bucket. Example: validate_app_start.sh
    bucket str
    The bucket name inside the object storage namespace. Example: custom_dr_scripts
    namespace str
    The namespace in object storage (Note - this is usually the tenancy name). Example: myocitenancy
    object str
    The object name inside the object storage bucket. Example: validate_app_start.sh
    bucket String
    The bucket name inside the object storage namespace. Example: custom_dr_scripts
    namespace String
    The namespace in object storage (Note - this is usually the tenancy name). Example: myocitenancy
    object String
    The object name inside the object storage bucket. Example: validate_app_start.sh

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci