Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FileStorage
  5. Replication
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.FileStorage.Replication

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Replication resource in Oracle Cloud Infrastructure File Storage service.

    Creates a new replication in the specified compartment. Replications are the primary resource that governs the policy of cross-region replication between source and target file systems. Replications are associated with a secondary resource called a ReplicationTarget located in another availability domain. The associated replication target resource is automatically created along with the replication resource. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated ReplicationTarget, which retrieves the delta and applies it to the target file system. Only unexported file systems can be used as target file systems. For more information, see Using Replication.

    For information about access control and compartments, see Overview of the IAM Service.

    For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API.

    All Oracle Cloud Infrastructure Services resources, including replications, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

    Example Usage

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

const testReplication = new oci.filestorage.Replication("test_replication", {
    compartmentId: compartmentId,
    sourceId: testSource.id,
    targetId: testTarget.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: replicationDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    locks: [{
        type: replicationLocksType,
        message: replicationLocksMessage,
        relatedResourceId: testResource.id,
        timeCreated: replicationLocksTimeCreated,
    }],
    replicationInterval: replicationReplicationInterval,
});

    import pulumi
import pulumi_oci as oci

test_replication = oci.file_storage.Replication("test_replication",
    compartment_id=compartment_id,
    source_id=test_source["id"],
    target_id=test_target["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=replication_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    locks=[{
        "type": replication_locks_type,
        "message": replication_locks_message,
        "related_resource_id": test_resource["id"],
        "time_created": replication_locks_time_created,
    }],
    replication_interval=replication_replication_interval)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := FileStorage.NewReplication(ctx, "test_replication", &FileStorage.ReplicationArgs{
			CompartmentId: pulumi.Any(compartmentId),
			SourceId:      pulumi.Any(testSource.Id),
			TargetId:      pulumi.Any(testTarget.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(replicationDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			Locks: filestorage.ReplicationLockArray{
				&filestorage.ReplicationLockArgs{
					Type:              pulumi.Any(replicationLocksType),
					Message:           pulumi.Any(replicationLocksMessage),
					RelatedResourceId: pulumi.Any(testResource.Id),
					TimeCreated:       pulumi.Any(replicationLocksTimeCreated),
				},
			},
			ReplicationInterval: pulumi.Any(replicationReplicationInterval),
		})
		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 testReplication = new Oci.FileStorage.Replication("test_replication", new()
    {
        CompartmentId = compartmentId,
        SourceId = testSource.Id,
        TargetId = testTarget.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = replicationDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        Locks = new[]
        {
            new Oci.FileStorage.Inputs.ReplicationLockArgs
            {
                Type = replicationLocksType,
                Message = replicationLocksMessage,
                RelatedResourceId = testResource.Id,
                TimeCreated = replicationLocksTimeCreated,
            },
        },
        ReplicationInterval = replicationReplicationInterval,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FileStorage.Replication;
import com.pulumi.oci.FileStorage.ReplicationArgs;
import com.pulumi.oci.FileStorage.inputs.ReplicationLockArgs;
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 testReplication = new Replication("testReplication", ReplicationArgs.builder()
            .compartmentId(compartmentId)
            .sourceId(testSource.id())
            .targetId(testTarget.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(replicationDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .locks(ReplicationLockArgs.builder()
                .type(replicationLocksType)
                .message(replicationLocksMessage)
                .relatedResourceId(testResource.id())
                .timeCreated(replicationLocksTimeCreated)
                .build())
            .replicationInterval(replicationReplicationInterval)
            .build());

    }
}

    resources:
  testReplication:
    type: oci:FileStorage:Replication
    name: test_replication
    properties:
      compartmentId: ${compartmentId}
      sourceId: ${testSource.id}
      targetId: ${testTarget.id}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${replicationDisplayName}
      freeformTags:
        Department: Finance
      locks:
        - type: ${replicationLocksType}
          message: ${replicationLocksMessage}
          relatedResourceId: ${testResource.id}
          timeCreated: ${replicationLocksTimeCreated}
      replicationInterval: ${replicationReplicationInterval}

    Create Replication Resource

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

    Constructor syntax

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

@overload
def Replication(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                compartment_id: Optional[str] = None,
                source_id: Optional[str] = None,
                target_id: Optional[str] = None,
                defined_tags: Optional[Mapping[str, str]] = None,
                display_name: Optional[str] = None,
                freeform_tags: Optional[Mapping[str, str]] = None,
                is_lock_override: Optional[bool] = None,
                locks: Optional[Sequence[_filestorage.ReplicationLockArgs]] = None,
                replication_interval: Optional[str] = None)
    func NewReplication(ctx *Context, name string, args ReplicationArgs, opts ...ResourceOption) (*Replication, error)
    public Replication(string name, ReplicationArgs args, CustomResourceOptions? opts = null)
    public Replication(String name, ReplicationArgs args)
public Replication(String name, ReplicationArgs args, CustomResourceOptions options)

    type: oci:FileStorage:Replication
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 ReplicationArgs
    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 ReplicationArgs
    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 ReplicationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReplicationArgs
    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 replicationResource = new Oci.FileStorage.Replication("replicationResource", new()
{
    CompartmentId = "string",
    SourceId = "string",
    TargetId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsLockOverride = false,
    Locks = new[]
    {
        new Oci.FileStorage.Inputs.ReplicationLockArgs
        {
            Type = "string",
            Message = "string",
            RelatedResourceId = "string",
            TimeCreated = "string",
        },
    },
    ReplicationInterval = "string",
});

    example, err := FileStorage.NewReplication(ctx, "replicationResource", &FileStorage.ReplicationArgs{
	CompartmentId: pulumi.String("string"),
	SourceId:      pulumi.String("string"),
	TargetId:      pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsLockOverride: pulumi.Bool(false),
	Locks: filestorage.ReplicationLockArray{
		&filestorage.ReplicationLockArgs{
			Type:              pulumi.String("string"),
			Message:           pulumi.String("string"),
			RelatedResourceId: pulumi.String("string"),
			TimeCreated:       pulumi.String("string"),
		},
	},
	ReplicationInterval: pulumi.String("string"),
})

    var replicationResource = new Replication("replicationResource", ReplicationArgs.builder()
    .compartmentId("string")
    .sourceId("string")
    .targetId("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .isLockOverride(false)
    .locks(ReplicationLockArgs.builder()
        .type("string")
        .message("string")
        .relatedResourceId("string")
        .timeCreated("string")
        .build())
    .replicationInterval("string")
    .build());

    replication_resource = oci.file_storage.Replication("replicationResource",
    compartment_id="string",
    source_id="string",
    target_id="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    is_lock_override=False,
    locks=[{
        "type": "string",
        "message": "string",
        "related_resource_id": "string",
        "time_created": "string",
    }],
    replication_interval="string")

    const replicationResource = new oci.filestorage.Replication("replicationResource", {
    compartmentId: "string",
    sourceId: "string",
    targetId: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    isLockOverride: false,
    locks: [{
        type: "string",
        message: "string",
        relatedResourceId: "string",
        timeCreated: "string",
    }],
    replicationInterval: "string",
});

    type: oci:FileStorage:Replication
properties:
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    isLockOverride: false
    locks:
        - message: string
          relatedResourceId: string
          timeCreated: string
          type: string
    replicationInterval: string
    sourceId: string
    targetId: string

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

    CompartmentId string
    (Updatable) The OCID of the compartment that contains the replication.
    SourceId string
    The OCID of the source file system.
    TargetId string

    The OCID of the target file system.

    ** 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, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsLockOverride bool
    Locks List<ReplicationLock>
    Locks associated with this resource.
    ReplicationInterval string
    (Updatable) Duration in minutes between replication snapshots.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the replication.
    SourceId string
    The OCID of the source file system.
    TargetId string

    The OCID of the target file system.

    ** 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]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsLockOverride bool
    Locks []ReplicationLockArgs
    Locks associated with this resource.
    ReplicationInterval string
    (Updatable) Duration in minutes between replication snapshots.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the replication.
    sourceId String
    The OCID of the source file system.
    targetId String

    The OCID of the target file system.

    ** 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,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isLockOverride Boolean
    locks List<ReplicationLock>
    Locks associated with this resource.
    replicationInterval String
    (Updatable) Duration in minutes between replication snapshots.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the replication.
    sourceId string
    The OCID of the source file system.
    targetId string

    The OCID of the target file system.

    ** 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]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isLockOverride boolean
    locks ReplicationLock[]
    Locks associated with this resource.
    replicationInterval string
    (Updatable) Duration in minutes between replication snapshots.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the replication.
    source_id str
    The OCID of the source file system.
    target_id str

    The OCID of the target file system.

    ** 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, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    is_lock_override bool
    locks Sequence[filestorage.ReplicationLockArgs]
    Locks associated with this resource.
    replication_interval str
    (Updatable) Duration in minutes between replication snapshots.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the replication.
    sourceId String
    The OCID of the source file system.
    targetId String

    The OCID of the target file system.

    ** 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>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isLockOverride Boolean
    locks List<Property Map>
    Locks associated with this resource.
    replicationInterval String
    (Updatable) Duration in minutes between replication snapshots.

    Outputs

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

    AvailabilityDomain string
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    DeltaProgress string
    Percentage progress of the current replication cycle.
    DeltaStatus string
    The current state of the snapshot during replication operations.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSnapshotId string
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    LifecycleDetails string
    Additional information about the current 'lifecycleState'.
    RecoveryPointTime string
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    ReplicationTargetId string
    The OCID of the ReplicationTarget.
    State string
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    TimeCreated string
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
    AvailabilityDomain string
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    DeltaProgress string
    Percentage progress of the current replication cycle.
    DeltaStatus string
    The current state of the snapshot during replication operations.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSnapshotId string
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    LifecycleDetails string
    Additional information about the current 'lifecycleState'.
    RecoveryPointTime string
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    ReplicationTargetId string
    The OCID of the ReplicationTarget.
    State string
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    TimeCreated string
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
    availabilityDomain String
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    deltaProgress String
    Percentage progress of the current replication cycle.
    deltaStatus String
    The current state of the snapshot during replication operations.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSnapshotId String
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    lifecycleDetails String
    Additional information about the current 'lifecycleState'.
    recoveryPointTime String
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    replicationTargetId String
    The OCID of the ReplicationTarget.
    state String
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    timeCreated String
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
    availabilityDomain string
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    deltaProgress string
    Percentage progress of the current replication cycle.
    deltaStatus string
    The current state of the snapshot during replication operations.
    id string
    The provider-assigned unique ID for this managed resource.
    lastSnapshotId string
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    lifecycleDetails string
    Additional information about the current 'lifecycleState'.
    recoveryPointTime string
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    replicationTargetId string
    The OCID of the ReplicationTarget.
    state string
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    timeCreated string
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
    availability_domain str
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    delta_progress str
    Percentage progress of the current replication cycle.
    delta_status str
    The current state of the snapshot during replication operations.
    id str
    The provider-assigned unique ID for this managed resource.
    last_snapshot_id str
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    lifecycle_details str
    Additional information about the current 'lifecycleState'.
    recovery_point_time str
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    replication_target_id str
    The OCID of the ReplicationTarget.
    state str
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    time_created str
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
    availabilityDomain String
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    deltaProgress String
    Percentage progress of the current replication cycle.
    deltaStatus String
    The current state of the snapshot during replication operations.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSnapshotId String
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    lifecycleDetails String
    Additional information about the current 'lifecycleState'.
    recoveryPointTime String
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    replicationTargetId String
    The OCID of the ReplicationTarget.
    state String
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    timeCreated String
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z

    Look up Existing Replication Resource

    Get an existing Replication 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?: ReplicationState, opts?: CustomResourceOptions): Replication
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_domain: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        delta_progress: Optional[str] = None,
        delta_status: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_lock_override: Optional[bool] = None,
        last_snapshot_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        locks: Optional[Sequence[_filestorage.ReplicationLockArgs]] = None,
        recovery_point_time: Optional[str] = None,
        replication_interval: Optional[str] = None,
        replication_target_id: Optional[str] = None,
        source_id: Optional[str] = None,
        state: Optional[str] = None,
        target_id: Optional[str] = None,
        time_created: Optional[str] = None) -> Replication
    func GetReplication(ctx *Context, name string, id IDInput, state *ReplicationState, opts ...ResourceOption) (*Replication, error)
    public static Replication Get(string name, Input<string> id, ReplicationState? state, CustomResourceOptions? opts = null)
    public static Replication get(String name, Output<String> id, ReplicationState 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:
    AvailabilityDomain string
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the replication.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DeltaProgress string
    Percentage progress of the current replication cycle.
    DeltaStatus string
    The current state of the snapshot during replication operations.
    DisplayName string
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsLockOverride bool
    LastSnapshotId string
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    LifecycleDetails string
    Additional information about the current 'lifecycleState'.
    Locks List<ReplicationLock>
    Locks associated with this resource.
    RecoveryPointTime string
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    ReplicationInterval string
    (Updatable) Duration in minutes between replication snapshots.
    ReplicationTargetId string
    The OCID of the ReplicationTarget.
    SourceId string
    The OCID of the source file system.
    State string
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    TargetId string

    The OCID of the target file system.

    ** 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

    TimeCreated string
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
    AvailabilityDomain string
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the replication.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DeltaProgress string
    Percentage progress of the current replication cycle.
    DeltaStatus string
    The current state of the snapshot during replication operations.
    DisplayName string
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsLockOverride bool
    LastSnapshotId string
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    LifecycleDetails string
    Additional information about the current 'lifecycleState'.
    Locks []ReplicationLockArgs
    Locks associated with this resource.
    RecoveryPointTime string
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    ReplicationInterval string
    (Updatable) Duration in minutes between replication snapshots.
    ReplicationTargetId string
    The OCID of the ReplicationTarget.
    SourceId string
    The OCID of the source file system.
    State string
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    TargetId string

    The OCID of the target file system.

    ** 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

    TimeCreated string
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
    availabilityDomain String
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment that contains the replication.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    deltaProgress String
    Percentage progress of the current replication cycle.
    deltaStatus String
    The current state of the snapshot during replication operations.
    displayName String
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isLockOverride Boolean
    lastSnapshotId String
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    lifecycleDetails String
    Additional information about the current 'lifecycleState'.
    locks List<ReplicationLock>
    Locks associated with this resource.
    recoveryPointTime String
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    replicationInterval String
    (Updatable) Duration in minutes between replication snapshots.
    replicationTargetId String
    The OCID of the ReplicationTarget.
    sourceId String
    The OCID of the source file system.
    state String
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    targetId String

    The OCID of the target file system.

    ** 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

    timeCreated String
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
    availabilityDomain string
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    compartmentId string
    (Updatable) The OCID of the compartment that contains the replication.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    deltaProgress string
    Percentage progress of the current replication cycle.
    deltaStatus string
    The current state of the snapshot during replication operations.
    displayName string
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isLockOverride boolean
    lastSnapshotId string
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    lifecycleDetails string
    Additional information about the current 'lifecycleState'.
    locks ReplicationLock[]
    Locks associated with this resource.
    recoveryPointTime string
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    replicationInterval string
    (Updatable) Duration in minutes between replication snapshots.
    replicationTargetId string
    The OCID of the ReplicationTarget.
    sourceId string
    The OCID of the source file system.
    state string
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    targetId string

    The OCID of the target file system.

    ** 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

    timeCreated string
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
    availability_domain str
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    compartment_id str
    (Updatable) The OCID of the compartment that contains the replication.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    delta_progress str
    Percentage progress of the current replication cycle.
    delta_status str
    The current state of the snapshot during replication operations.
    display_name str
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    is_lock_override bool
    last_snapshot_id str
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    lifecycle_details str
    Additional information about the current 'lifecycleState'.
    locks Sequence[filestorage.ReplicationLockArgs]
    Locks associated with this resource.
    recovery_point_time str
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    replication_interval str
    (Updatable) Duration in minutes between replication snapshots.
    replication_target_id str
    The OCID of the ReplicationTarget.
    source_id str
    The OCID of the source file system.
    state str
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    target_id str

    The OCID of the target file system.

    ** 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

    time_created str
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
    availabilityDomain String
    The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment that contains the replication.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    deltaProgress String
    Percentage progress of the current replication cycle.
    deltaStatus String
    The current state of the snapshot during replication operations.
    displayName String
    (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isLockOverride Boolean
    lastSnapshotId String
    The OCID of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.
    lifecycleDetails String
    Additional information about the current 'lifecycleState'.
    locks List<Property Map>
    Locks associated with this resource.
    recoveryPointTime String
    The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 timestamp format. Example: 2021-04-04T20:01:29.100Z
    replicationInterval String
    (Updatable) Duration in minutes between replication snapshots.
    replicationTargetId String
    The OCID of the ReplicationTarget.
    sourceId String
    The OCID of the source file system.
    state String
    The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.
    targetId String

    The OCID of the target file system.

    ** 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

    timeCreated String
    The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z

    Supporting Types

    ReplicationLock, ReplicationLockArgs

    Type string
    Type of the lock.
    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    When the lock was created.
    Type string
    Type of the lock.
    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    When the lock was created.
    type String
    Type of the lock.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    When the lock was created.
    type string
    Type of the lock.
    message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId string
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated string
    When the lock was created.
    type str
    Type of the lock.
    message str
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    related_resource_id str
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    time_created str
    When the lock was created.
    type String
    Type of the lock.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    When the lock was created.

    Import

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

    $ pulumi import oci:FileStorage/replication:Replication test_replication "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 v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci