Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.FileStorage.getReplications

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

Example Usage

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

const testReplications = oci.FileStorage.getReplications({
    availabilityDomain: replicationAvailabilityDomain,
    compartmentId: compartmentId,
    displayName: replicationDisplayName,
    fileSystemId: testFileSystem.id,
    id: replicationId,
    state: replicationState,
});

import pulumi
import pulumi_oci as oci

test_replications = oci.FileStorage.get_replications(availability_domain=replication_availability_domain,
    compartment_id=compartment_id,
    display_name=replication_display_name,
    file_system_id=test_file_system["id"],
    id=replication_id,
    state=replication_state)

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.GetReplications(ctx, &filestorage.GetReplicationsArgs{
			AvailabilityDomain: replicationAvailabilityDomain,
			CompartmentId:      compartmentId,
			DisplayName:        pulumi.StringRef(replicationDisplayName),
			FileSystemId:       pulumi.StringRef(testFileSystem.Id),
			Id:                 pulumi.StringRef(replicationId),
			State:              pulumi.StringRef(replicationState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testReplications = Oci.FileStorage.GetReplications.Invoke(new()
    {
        AvailabilityDomain = replicationAvailabilityDomain,
        CompartmentId = compartmentId,
        DisplayName = replicationDisplayName,
        FileSystemId = testFileSystem.Id,
        Id = replicationId,
        State = replicationState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FileStorage.FileStorageFunctions;
import com.pulumi.oci.FileStorage.inputs.GetReplicationsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var testReplications = FileStorageFunctions.getReplications(GetReplicationsArgs.builder()
            .availabilityDomain(replicationAvailabilityDomain)
            .compartmentId(compartmentId)
            .displayName(replicationDisplayName)
            .fileSystemId(testFileSystem.id())
            .id(replicationId)
            .state(replicationState)
            .build());

    }
}

variables:
  testReplications:
    fn::invoke:
      Function: oci:FileStorage:getReplications
      Arguments:
        availabilityDomain: ${replicationAvailabilityDomain}
        compartmentId: ${compartmentId}
        displayName: ${replicationDisplayName}
        fileSystemId: ${testFileSystem.id}
        id: ${replicationId}
        state: ${replicationState}

Using getReplications

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

function getReplications(args: GetReplicationsArgs, opts?: InvokeOptions): Promise<GetReplicationsResult>
function getReplicationsOutput(args: GetReplicationsOutputArgs, opts?: InvokeOptions): Output<GetReplicationsResult>

def get_replications(availability_domain: Optional[str] = None,
                     compartment_id: Optional[str] = None,
                     display_name: Optional[str] = None,
                     file_system_id: Optional[str] = None,
                     filters: Optional[Sequence[_filestorage.GetReplicationsFilter]] = None,
                     id: Optional[str] = None,
                     state: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetReplicationsResult
def get_replications_output(availability_domain: Optional[pulumi.Input[str]] = None,
                     compartment_id: Optional[pulumi.Input[str]] = None,
                     display_name: Optional[pulumi.Input[str]] = None,
                     file_system_id: Optional[pulumi.Input[str]] = None,
                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[_filestorage.GetReplicationsFilterArgs]]]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     state: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetReplicationsResult]

func GetReplications(ctx *Context, args *GetReplicationsArgs, opts ...InvokeOption) (*GetReplicationsResult, error)
func GetReplicationsOutput(ctx *Context, args *GetReplicationsOutputArgs, opts ...InvokeOption) GetReplicationsResultOutput

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

public static class GetReplications 
{
    public static Task<GetReplicationsResult> InvokeAsync(GetReplicationsArgs args, InvokeOptions? opts = null)
    public static Output<GetReplicationsResult> Invoke(GetReplicationsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetReplicationsResult> getReplications(GetReplicationsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:FileStorage/getReplications:getReplications
  arguments:
    # arguments dictionary

The following arguments are supported:

AvailabilityDomain string: The name of the availability domain. Example: Uocm:PHX-AD-1
CompartmentId string: The OCID of the compartment.
DisplayName string: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
FileSystemId string: The OCID of the source file system.
Filters List<GetReplicationsFilter>
Id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

AvailabilityDomain string: The name of the availability domain. Example: Uocm:PHX-AD-1
CompartmentId string: The OCID of the compartment.
DisplayName string: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
FileSystemId string: The OCID of the source file system.
Filters []GetReplicationsFilter
Id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

availabilityDomain String: The name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId String: The OCID of the compartment.
displayName String: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
fileSystemId String: The OCID of the source file system.
filters List<GetReplicationsFilter>
id String: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

availabilityDomain string: The name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId string: The OCID of the compartment.
displayName string: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
fileSystemId string: The OCID of the source file system.
filters GetReplicationsFilter[]
id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

availability_domain str: The name of the availability domain. Example: Uocm:PHX-AD-1
compartment_id str: The OCID of the compartment.
display_name str: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
file_system_id str: The OCID of the source file system.
filters Sequence[filestorage.GetReplicationsFilter]
id str: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

availabilityDomain String: The name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId String: The OCID of the compartment.
displayName String: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
fileSystemId String: The OCID of the source file system.
filters List<Property Map>
id String: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

getReplications Result

The following output properties are available:

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: The OCID of the compartment that contains the replication.
Replications List<GetReplicationsReplication>: The list of replications.
DisplayName string: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My replication
FileSystemId string
Filters List<GetReplicationsFilter>
Id string: The OCID of the replication.
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.

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: The OCID of the compartment that contains the replication.
Replications []GetReplicationsReplication: The list of replications.
DisplayName string: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My replication
FileSystemId string
Filters []GetReplicationsFilter
Id string: The OCID of the replication.
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.

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: The OCID of the compartment that contains the replication.
replications List<GetReplicationsReplication>: The list of replications.
displayName String: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My replication
fileSystemId String
filters List<GetReplicationsFilter>
id String: The OCID of the replication.
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.

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: The OCID of the compartment that contains the replication.
replications GetReplicationsReplication[]: The list of replications.
displayName string: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My replication
fileSystemId string
filters GetReplicationsFilter[]
id string: The OCID of the replication.
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.

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: The OCID of the compartment that contains the replication.
replications Sequence[filestorage.GetReplicationsReplication]: The list of replications.
display_name str: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My replication
file_system_id str
filters Sequence[filestorage.GetReplicationsFilter]
id str: The OCID of the replication.
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.

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: The OCID of the compartment that contains the replication.
replications List<Property Map>: The list of replications.
displayName String: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My replication
fileSystemId String
filters List<Property Map>
id String: The OCID of the replication.
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.

Supporting Types

GetReplicationsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetReplicationsReplication

AvailabilityDomain string: The name of the availability domain. Example: Uocm:PHX-AD-1
CompartmentId string: The OCID of the compartment.
DefinedTags Dictionary<string, string>: 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: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
FreeformTags Dictionary<string, string>: 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"}
Id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
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<GetReplicationsReplicationLock>: 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: Duration in minutes between replication snapshots.
ReplicationTargetId string: The OCID of the ReplicationTarget.
SourceId string: The OCID of the source file system.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
TargetId string: The OCID of the target file system.
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 name of the availability domain. Example: Uocm:PHX-AD-1
CompartmentId string: The OCID of the compartment.
DefinedTags map[string]string: 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: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
FreeformTags map[string]string: 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"}
Id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
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 []GetReplicationsReplicationLock: 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: Duration in minutes between replication snapshots.
ReplicationTargetId string: The OCID of the ReplicationTarget.
SourceId string: The OCID of the source file system.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
TargetId string: The OCID of the target file system.
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 name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId String: The OCID of the compartment.
definedTags Map<String,String>: 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: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
freeformTags Map<String,String>: 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"}
id String: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
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<GetReplicationsReplicationLock>: 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: Duration in minutes between replication snapshots.
replicationTargetId String: The OCID of the ReplicationTarget.
sourceId String: The OCID of the source file system.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
targetId String: The OCID of the target file system.
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 name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId string: The OCID of the compartment.
definedTags {[key: string]: string}: 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: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
freeformTags {[key: string]: string}: 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"}
id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
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 GetReplicationsReplicationLock[]: 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: Duration in minutes between replication snapshots.
replicationTargetId string: The OCID of the ReplicationTarget.
sourceId string: The OCID of the source file system.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
targetId string: The OCID of the target file system.
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 name of the availability domain. Example: Uocm:PHX-AD-1
compartment_id str: The OCID of the compartment.
defined_tags Mapping[str, str]: 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: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
freeform_tags Mapping[str, str]: 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"}
id str: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
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.GetReplicationsReplicationLock]: 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: 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: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
target_id str: The OCID of the target file system.
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 name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId String: The OCID of the compartment.
definedTags Map<String>: 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: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
freeformTags Map<String>: 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"}
id String: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
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: Duration in minutes between replication snapshots.
replicationTargetId String: The OCID of the ReplicationTarget.
sourceId String: The OCID of the source file system.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
targetId String: The OCID of the target file system.
timeCreated String: The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z

GetReplicationsReplicationLock

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: The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
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: The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
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: The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
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: The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
type string: 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: The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
type str: 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: The date and time the replication was created in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z
type String: Type of the lock.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.FileStorage.getReplications

On this page

On this page

Example Usage

Using getReplications

getReplications Result

Supporting Types

GetReplicationsFilter

GetReplicationsReplication

GetReplicationsReplicationLock

Package Details

On this page

On this page