1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DisasterRecovery
  5. DrPlan
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.DisasterRecovery.DrPlan

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

    This resource provides the Dr Plan resource in Oracle Cloud Infrastructure Disaster Recovery service.

    Create a DR plan of the specified DR plan type.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDrPlan = new oci.disasterrecovery.DrPlan("test_dr_plan", {
        displayName: drPlanDisplayName,
        drProtectionGroupId: testDrProtectionGroup.id,
        type: drPlanType,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        freeformTags: {
            Department: "Finance",
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_dr_plan = oci.disaster_recovery.DrPlan("test_dr_plan",
        display_name=dr_plan_display_name,
        dr_protection_group_id=test_dr_protection_group["id"],
        type=dr_plan_type,
        defined_tags={
            "Operations.CostCenter": "42",
        },
        freeform_tags={
            "Department": "Finance",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/DisasterRecovery"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := DisasterRecovery.NewDrPlan(ctx, "test_dr_plan", &DisasterRecovery.DrPlanArgs{
    			DisplayName:         pulumi.Any(drPlanDisplayName),
    			DrProtectionGroupId: pulumi.Any(testDrProtectionGroup.Id),
    			Type:                pulumi.Any(drPlanType),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    		})
    		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 = new Oci.DisasterRecovery.DrPlan("test_dr_plan", new()
        {
            DisplayName = drPlanDisplayName,
            DrProtectionGroupId = testDrProtectionGroup.Id,
            Type = drPlanType,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.DisasterRecovery.DrPlan;
    import com.pulumi.oci.DisasterRecovery.DrPlanArgs;
    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 testDrPlan = new DrPlan("testDrPlan", DrPlanArgs.builder()
                .displayName(drPlanDisplayName)
                .drProtectionGroupId(testDrProtectionGroup.id())
                .type(drPlanType)
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .freeformTags(Map.of("Department", "Finance"))
                .build());
    
        }
    }
    
    resources:
      testDrPlan:
        type: oci:DisasterRecovery:DrPlan
        name: test_dr_plan
        properties:
          displayName: ${drPlanDisplayName}
          drProtectionGroupId: ${testDrProtectionGroup.id}
          type: ${drPlanType}
          definedTags:
            Operations.CostCenter: '42'
          freeformTags:
            Department: Finance
    

    Create DrPlan Resource

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

    Constructor syntax

    new DrPlan(name: string, args: DrPlanArgs, opts?: CustomResourceOptions);
    @overload
    def DrPlan(resource_name: str,
               args: DrPlanArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def DrPlan(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               display_name: Optional[str] = None,
               dr_protection_group_id: Optional[str] = None,
               type: Optional[str] = None,
               defined_tags: Optional[Mapping[str, Any]] = None,
               freeform_tags: Optional[Mapping[str, Any]] = None)
    func NewDrPlan(ctx *Context, name string, args DrPlanArgs, opts ...ResourceOption) (*DrPlan, error)
    public DrPlan(string name, DrPlanArgs args, CustomResourceOptions? opts = null)
    public DrPlan(String name, DrPlanArgs args)
    public DrPlan(String name, DrPlanArgs args, CustomResourceOptions options)
    
    type: oci:DisasterRecovery:DrPlan
    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 DrPlanArgs
    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 DrPlanArgs
    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 DrPlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DrPlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DrPlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var drPlanResource = new Oci.DisasterRecovery.DrPlan("drPlanResource", new()
    {
        DisplayName = "string",
        DrProtectionGroupId = "string",
        Type = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        FreeformTags = 
        {
            { "string", "any" },
        },
    });
    
    example, err := DisasterRecovery.NewDrPlan(ctx, "drPlanResource", &DisasterRecovery.DrPlanArgs{
    	DisplayName:         pulumi.String("string"),
    	DrProtectionGroupId: pulumi.String("string"),
    	Type:                pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var drPlanResource = new DrPlan("drPlanResource", DrPlanArgs.builder()
        .displayName("string")
        .drProtectionGroupId("string")
        .type("string")
        .definedTags(Map.of("string", "any"))
        .freeformTags(Map.of("string", "any"))
        .build());
    
    dr_plan_resource = oci.disaster_recovery.DrPlan("drPlanResource",
        display_name="string",
        dr_protection_group_id="string",
        type="string",
        defined_tags={
            "string": "any",
        },
        freeform_tags={
            "string": "any",
        })
    
    const drPlanResource = new oci.disasterrecovery.DrPlan("drPlanResource", {
        displayName: "string",
        drProtectionGroupId: "string",
        type: "string",
        definedTags: {
            string: "any",
        },
        freeformTags: {
            string: "any",
        },
    });
    
    type: oci:DisasterRecovery:DrPlan
    properties:
        definedTags:
            string: any
        displayName: string
        drProtectionGroupId: string
        freeformTags:
            string: any
        type: string
    

    DrPlan Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DrPlan resource accepts the following input properties:

    DisplayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    DrProtectionGroupId string
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    Type string

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    FreeformTags Dictionary<string, object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    DisplayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    DrProtectionGroupId string
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    Type string

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    FreeformTags map[string]interface{}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    displayName String
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    drProtectionGroupId String
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    type String

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String,Object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    displayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    drProtectionGroupId string
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    type string

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    freeformTags {[key: string]: any}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    display_name str
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    dr_protection_group_id str
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    type str

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    freeform_tags Mapping[str, Any]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    displayName String
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    drProtectionGroupId String
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    type String

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<Any>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

    Outputs

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

    CompartmentId string
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    Id string
    The provider-assigned unique ID for this managed resource.
    LifeCycleDetails string
    A message describing the DR plan's current state in more detail.
    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<DrPlanPlanGroup>
    The list of groups in this DR plan.
    State string
    The current state of the DR plan.
    SystemTags Dictionary<string, object>
    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
    CompartmentId string
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    Id string
    The provider-assigned unique ID for this managed resource.
    LifeCycleDetails string
    A message describing the DR plan's current state in more detail.
    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 []DrPlanPlanGroup
    The list of groups in this DR plan.
    State string
    The current state of the DR plan.
    SystemTags map[string]interface{}
    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
    compartmentId String
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    id String
    The provider-assigned unique ID for this managed resource.
    lifeCycleDetails String
    A message describing the DR plan's current state in more detail.
    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<DrPlanPlanGroup>
    The list of groups in this DR plan.
    state String
    The current state of the DR plan.
    systemTags Map<String,Object>
    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
    compartmentId string
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    id string
    The provider-assigned unique ID for this managed resource.
    lifeCycleDetails string
    A message describing the DR plan's current state in more detail.
    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 DrPlanPlanGroup[]
    The list of groups in this DR plan.
    state string
    The current state of the DR plan.
    systemTags {[key: string]: any}
    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
    compartment_id str
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    id str
    The provider-assigned unique ID for this managed resource.
    life_cycle_details str
    A message describing the DR plan's current state in more detail.
    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[disasterrecovery.DrPlanPlanGroup]
    The list of groups in this DR plan.
    state str
    The current state of the DR plan.
    system_tags Mapping[str, Any]
    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
    compartmentId String
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    id String
    The provider-assigned unique ID for this managed resource.
    lifeCycleDetails String
    A message describing the DR plan's current state in more detail.
    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.
    state String
    The current state of the DR plan.
    systemTags Map<Any>
    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

    Look up Existing DrPlan Resource

    Get an existing DrPlan 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?: DrPlanState, opts?: CustomResourceOptions): DrPlan
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            dr_protection_group_id: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            life_cycle_details: Optional[str] = None,
            peer_dr_protection_group_id: Optional[str] = None,
            peer_region: Optional[str] = None,
            plan_groups: Optional[Sequence[_disasterrecovery.DrPlanPlanGroupArgs]] = None,
            state: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None,
            type: Optional[str] = None) -> DrPlan
    func GetDrPlan(ctx *Context, name string, id IDInput, state *DrPlanState, opts ...ResourceOption) (*DrPlan, error)
    public static DrPlan Get(string name, Input<string> id, DrPlanState? state, CustomResourceOptions? opts = null)
    public static DrPlan get(String name, Output<String> id, DrPlanState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    DrProtectionGroupId string
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    FreeformTags Dictionary<string, object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    LifeCycleDetails string
    A message describing the DR plan's current state in more detail.
    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<DrPlanPlanGroup>
    The list of groups in this DR plan.
    State string
    The current state of the DR plan.
    SystemTags Dictionary<string, object>
    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 DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    DrProtectionGroupId string
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    FreeformTags map[string]interface{}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    LifeCycleDetails string
    A message describing the DR plan's current state in more detail.
    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 []DrPlanPlanGroupArgs
    The list of groups in this DR plan.
    State string
    The current state of the DR plan.
    SystemTags map[string]interface{}
    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 DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    drProtectionGroupId String
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    freeformTags Map<String,Object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    lifeCycleDetails String
    A message describing the DR plan's current state in more detail.
    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<DrPlanPlanGroup>
    The list of groups in this DR plan.
    state String
    The current state of the DR plan.
    systemTags Map<String,Object>
    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 DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    drProtectionGroupId string
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    freeformTags {[key: string]: any}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    lifeCycleDetails string
    A message describing the DR plan's current state in more detail.
    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 DrPlanPlanGroup[]
    The list of groups in this DR plan.
    state string
    The current state of the DR plan.
    systemTags {[key: string]: any}
    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 DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    dr_protection_group_id str
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    freeform_tags Mapping[str, Any]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    life_cycle_details str
    A message describing the DR plan's current state in more detail.
    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[disasterrecovery.DrPlanPlanGroupArgs]
    The list of groups in this DR plan.
    state str
    The current state of the DR plan.
    system_tags Mapping[str, Any]
    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 DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    The OCID of the compartment containing the DR plan. Example: ocid1.compartment.oc1..uniqueID
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    drProtectionGroupId String
    The OCID of the DR protection group to which this DR plan belongs. Example: ocid1.drprotectiongroup.oc1..uniqueID
    freeformTags Map<Any>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    lifeCycleDetails String
    A message describing the DR plan's current state in more detail.
    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.
    state String
    The current state of the DR plan.
    systemTags Map<Any>
    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 DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Supporting Types

    DrPlanPlanGroup, DrPlanPlanGroupArgs

    DisplayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    Steps List<DrPlanPlanGroupStep>
    The list of steps in the group.
    Type string

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DisplayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    Steps []DrPlanPlanGroupStep
    The list of steps in the group.
    Type string

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    displayName String
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    steps List<DrPlanPlanGroupStep>
    The list of steps in the group.
    type String

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    displayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    steps DrPlanPlanGroupStep[]
    The list of steps in the group.
    type string

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    display_name str
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    steps Sequence[disasterrecovery.DrPlanPlanGroupStep]
    The list of steps in the group.
    type str

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    displayName String
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    steps List<Property Map>
    The list of steps in the group.
    type String

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DrPlanPlanGroupStep, DrPlanPlanGroupStepArgs

    DisplayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    Timeout int
    The timeout in seconds for executing this step. Example: 600
    Type string

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    UserDefinedSteps List<DrPlanPlanGroupStepUserDefinedStep>
    The details for a user-defined step in a DR plan.
    DisplayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    Timeout int
    The timeout in seconds for executing this step. Example: 600
    Type string

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    UserDefinedSteps []DrPlanPlanGroupStepUserDefinedStep
    The details for a user-defined step in a DR plan.
    displayName String
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    timeout Integer
    The timeout in seconds for executing this step. Example: 600
    type String

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    userDefinedSteps List<DrPlanPlanGroupStepUserDefinedStep>
    The details for a user-defined step in a DR plan.
    displayName string
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    timeout number
    The timeout in seconds for executing this step. Example: 600
    type string

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    userDefinedSteps DrPlanPlanGroupStepUserDefinedStep[]
    The details for a user-defined step in a DR plan.
    display_name str
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    timeout int
    The timeout in seconds for executing this step. Example: 600
    type str

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    user_defined_steps Sequence[disasterrecovery.DrPlanPlanGroupStepUserDefinedStep]
    The details for a user-defined step in a DR plan.
    displayName String
    (Updatable) The display name of the DR plan being created. Example: EBS Switchover PHX to IAD
    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
    timeout Number
    The timeout in seconds for executing this step. Example: 600
    type String

    The type of DR plan to be created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    userDefinedSteps List<Property Map>
    The details for a user-defined step in a DR plan.

    DrPlanPlanGroupStepUserDefinedStep, DrPlanPlanGroupStepUserDefinedStepArgs

    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<DrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation>
    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 []DrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation
    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<DrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation>
    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 DrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation[]
    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[disasterrecovery.DrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation]
    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.

    DrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation, DrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocationArgs

    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

    Import

    DrPlans can be imported using the id, e.g.

    $ pulumi import oci:DisasterRecovery/drPlan:DrPlan test_dr_plan "id"
    

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

    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 v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi