oci.Redis.getOciCacheBackup

Oracle Cloud Infrastructure v4.11.0, May 15 26

Viewing docs for Oracle Cloud Infrastructure v4.11.0
published on Friday, May 15, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Viewing docs for Oracle Cloud Infrastructure v4.11.0
published on Friday, May 15, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Example Usage

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

const testOciCacheBackup = oci.redis.getOciCacheBackup({
    ociCacheBackupId: testOciCacheBackupOciRedisOciCacheBackup.id,
});

import pulumi
import pulumi_oci as oci

test_oci_cache_backup = oci.redis.get_oci_cache_backup(oci_cache_backup_id=test_oci_cache_backup_oci_redis_oci_cache_backup["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/redis"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redis.GetOciCacheBackup(ctx, &redis.GetOciCacheBackupArgs{
			OciCacheBackupId: testOciCacheBackupOciRedisOciCacheBackup.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testOciCacheBackup = Oci.Redis.GetOciCacheBackup.Invoke(new()
    {
        OciCacheBackupId = testOciCacheBackupOciRedisOciCacheBackup.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Redis.RedisFunctions;
import com.pulumi.oci.Redis.inputs.GetOciCacheBackupArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 testOciCacheBackup = RedisFunctions.getOciCacheBackup(GetOciCacheBackupArgs.builder()
            .ociCacheBackupId(testOciCacheBackupOciRedisOciCacheBackup.id())
            .build());

    }
}

variables:
  testOciCacheBackup:
    fn::invoke:
      function: oci:Redis:getOciCacheBackup
      arguments:
        ociCacheBackupId: ${testOciCacheBackupOciRedisOciCacheBackup.id}

Example coming soon!

Using getOciCacheBackup

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 getOciCacheBackup(args: GetOciCacheBackupArgs, opts?: InvokeOptions): Promise<GetOciCacheBackupResult>
function getOciCacheBackupOutput(args: GetOciCacheBackupOutputArgs, opts?: InvokeOptions): Output<GetOciCacheBackupResult>

def get_oci_cache_backup(oci_cache_backup_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetOciCacheBackupResult
def get_oci_cache_backup_output(oci_cache_backup_id: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetOciCacheBackupResult]

func LookupOciCacheBackup(ctx *Context, args *LookupOciCacheBackupArgs, opts ...InvokeOption) (*LookupOciCacheBackupResult, error)
func LookupOciCacheBackupOutput(ctx *Context, args *LookupOciCacheBackupOutputArgs, opts ...InvokeOption) LookupOciCacheBackupResultOutput

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

public static class GetOciCacheBackup 
{
    public static Task<GetOciCacheBackupResult> InvokeAsync(GetOciCacheBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetOciCacheBackupResult> Invoke(GetOciCacheBackupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOciCacheBackupResult> getOciCacheBackup(GetOciCacheBackupArgs args, InvokeOptions options)
public static Output<GetOciCacheBackupResult> getOciCacheBackup(GetOciCacheBackupArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Redis/getOciCacheBackup:getOciCacheBackup
  arguments:
    # arguments dictionary

data "oci_redis_getocicachebackup" "name" {
    # arguments
}

The following arguments are supported:

OciCacheBackupId string: Unique Oracle Cloud Infrastructure Cache Backup identifier.

OciCacheBackupId string: Unique Oracle Cloud Infrastructure Cache Backup identifier.

oci_cache_backup_id string: Unique Oracle Cloud Infrastructure Cache Backup identifier.

ociCacheBackupId String: Unique Oracle Cloud Infrastructure Cache Backup identifier.

ociCacheBackupId string: Unique Oracle Cloud Infrastructure Cache Backup identifier.

oci_cache_backup_id str: Unique Oracle Cloud Infrastructure Cache Backup identifier.

ociCacheBackupId String: Unique Oracle Cloud Infrastructure Cache Backup identifier.

getOciCacheBackup Result

The following output properties are available:

BackupSizeInGbs double: Backup size in GB.
BackupSource string: Specifies whether the backup was created from a replica or primary node
BackupType string: Backup Type.
ClusterMemoryInGbs double: The amount of memory allocated to the cluster, in gigabytes.
ClusterMode string: Specifies whether the cluster is sharded or non-sharded.
CompartmentId string: Backup compartment identifier
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: Backup description
DisplayName string: Backup display name
ExportToObjectStorageTrigger int
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier that is immutable on creation
OciCacheBackupId string
RetentionPeriodInDays int: Backup retention period in days.
ShardCount int: The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
SoftwareVersion string: The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
SourceClusterId string: The source Oracle Cloud Infrastructure Cache Cluster OCID.
State string: The current state of the backup.
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the backup was created. An RFC3339 formatted datetime string.
TimeUpdated string: The date and time the backup was updated. An RFC3339 formatted datetime string.

BackupSizeInGbs float64: Backup size in GB.
BackupSource string: Specifies whether the backup was created from a replica or primary node
BackupType string: Backup Type.
ClusterMemoryInGbs float64: The amount of memory allocated to the cluster, in gigabytes.
ClusterMode string: Specifies whether the cluster is sharded or non-sharded.
CompartmentId string: Backup compartment identifier
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: Backup description
DisplayName string: Backup display name
ExportToObjectStorageTrigger int
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier that is immutable on creation
OciCacheBackupId string
RetentionPeriodInDays int: Backup retention period in days.
ShardCount int: The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
SoftwareVersion string: The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
SourceClusterId string: The source Oracle Cloud Infrastructure Cache Cluster OCID.
State string: The current state of the backup.
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the backup was created. An RFC3339 formatted datetime string.
TimeUpdated string: The date and time the backup was updated. An RFC3339 formatted datetime string.

backup_size_in_gbs number: Backup size in GB.
backup_source string: Specifies whether the backup was created from a replica or primary node
backup_type string: Backup Type.
cluster_memory_in_gbs number: The amount of memory allocated to the cluster, in gigabytes.
cluster_mode string: Specifies whether the cluster is sharded or non-sharded.
compartment_id string: Backup compartment identifier
defined_tags map(string): Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string: Backup description
display_name string: Backup display name
export_to_object_storage_trigger number
freeform_tags map(string): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: Unique identifier that is immutable on creation
oci_cache_backup_id string
retention_period_in_days number: Backup retention period in days.
shard_count number: The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
software_version string: The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
source_cluster_id string: The source Oracle Cloud Infrastructure Cache Cluster OCID.
state string: The current state of the backup.
system_tags map(string): Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created string: The date and time the backup was created. An RFC3339 formatted datetime string.
time_updated string: The date and time the backup was updated. An RFC3339 formatted datetime string.

backupSizeInGbs Double: Backup size in GB.
backupSource String: Specifies whether the backup was created from a replica or primary node
backupType String: Backup Type.
clusterMemoryInGbs Double: The amount of memory allocated to the cluster, in gigabytes.
clusterMode String: Specifies whether the cluster is sharded or non-sharded.
compartmentId String: Backup compartment identifier
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: Backup description
displayName String: Backup display name
exportToObjectStorageTrigger Integer
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier that is immutable on creation
ociCacheBackupId String
retentionPeriodInDays Integer: Backup retention period in days.
shardCount Integer: The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
softwareVersion String: The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
sourceClusterId String: The source Oracle Cloud Infrastructure Cache Cluster OCID.
state String: The current state of the backup.
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the backup was created. An RFC3339 formatted datetime string.
timeUpdated String: The date and time the backup was updated. An RFC3339 formatted datetime string.

backupSizeInGbs number: Backup size in GB.
backupSource string: Specifies whether the backup was created from a replica or primary node
backupType string: Backup Type.
clusterMemoryInGbs number: The amount of memory allocated to the cluster, in gigabytes.
clusterMode string: Specifies whether the cluster is sharded or non-sharded.
compartmentId string: Backup compartment identifier
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string: Backup description
displayName string: Backup display name
exportToObjectStorageTrigger number
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: Unique identifier that is immutable on creation
ociCacheBackupId string
retentionPeriodInDays number: Backup retention period in days.
shardCount number: The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
softwareVersion string: The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
sourceClusterId string: The source Oracle Cloud Infrastructure Cache Cluster OCID.
state string: The current state of the backup.
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The date and time the backup was created. An RFC3339 formatted datetime string.
timeUpdated string: The date and time the backup was updated. An RFC3339 formatted datetime string.

backup_size_in_gbs float: Backup size in GB.
backup_source str: Specifies whether the backup was created from a replica or primary node
backup_type str: Backup Type.
cluster_memory_in_gbs float: The amount of memory allocated to the cluster, in gigabytes.
cluster_mode str: Specifies whether the cluster is sharded or non-sharded.
compartment_id str: Backup compartment identifier
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str: Backup description
display_name str: Backup display name
export_to_object_storage_trigger int
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: Unique identifier that is immutable on creation
oci_cache_backup_id str
retention_period_in_days int: Backup retention period in days.
shard_count int: The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
software_version str: The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
source_cluster_id str: The source Oracle Cloud Infrastructure Cache Cluster OCID.
state str: The current state of the backup.
system_tags Mapping[str, str]: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The date and time the backup was created. An RFC3339 formatted datetime string.
time_updated str: The date and time the backup was updated. An RFC3339 formatted datetime string.

backupSizeInGbs Number: Backup size in GB.
backupSource String: Specifies whether the backup was created from a replica or primary node
backupType String: Backup Type.
clusterMemoryInGbs Number: The amount of memory allocated to the cluster, in gigabytes.
clusterMode String: Specifies whether the cluster is sharded or non-sharded.
compartmentId String: Backup compartment identifier
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: Backup description
displayName String: Backup display name
exportToObjectStorageTrigger Number
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier that is immutable on creation
ociCacheBackupId String
retentionPeriodInDays Number: Backup retention period in days.
shardCount Number: The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
softwareVersion String: The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
sourceClusterId String: The source Oracle Cloud Infrastructure Cache Cluster OCID.
state String: The current state of the backup.
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the backup was created. An RFC3339 formatted datetime string.
timeUpdated String: The date and time the backup was updated. An RFC3339 formatted datetime string.