1. Packages
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. Redis
  6. OciCacheBackupExportToObjectStorage
Viewing docs for Oracle Cloud Infrastructure v4.10.0
published on Thursday, May 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.Redis.OciCacheBackupExportToObjectStorage

oci logo
Viewing docs for Oracle Cloud Infrastructure v4.10.0
published on Thursday, May 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This resource provides the Oci Cache Backup Export To Object Storage resource in Oracle Cloud Infrastructure Redis service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/ocicache/latest/OciCacheBackup/ExportToObjectStorage

    Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/redis

    Initiates an asynchronous export of the backup’s RDB file(s) to the specified Object Storage bucket. The service generates the object names. For sharded backups, one object is written per shard under the optional prefix.

    Example Usage

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

const testOciCacheBackupExportToObjectStorage = new oci.redis.OciCacheBackupExportToObjectStorage("test_oci_cache_backup_export_to_object_storage", {
    bucket: ociCacheBackupExportToObjectStorageBucket,
    namespace: ociCacheBackupExportToObjectStorageNamespace,
    ociCacheBackupId: testOciCacheBackup.id,
    prefix: ociCacheBackupExportToObjectStoragePrefix,
});

    import pulumi
import pulumi_oci as oci

test_oci_cache_backup_export_to_object_storage = oci.redis.OciCacheBackupExportToObjectStorage("test_oci_cache_backup_export_to_object_storage",
    bucket=oci_cache_backup_export_to_object_storage_bucket,
    namespace=oci_cache_backup_export_to_object_storage_namespace,
    oci_cache_backup_id=test_oci_cache_backup["id"],
    prefix=oci_cache_backup_export_to_object_storage_prefix)

    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.NewOciCacheBackupExportToObjectStorage(ctx, "test_oci_cache_backup_export_to_object_storage", &redis.OciCacheBackupExportToObjectStorageArgs{
			Bucket:           pulumi.Any(ociCacheBackupExportToObjectStorageBucket),
			Namespace:        pulumi.Any(ociCacheBackupExportToObjectStorageNamespace),
			OciCacheBackupId: pulumi.Any(testOciCacheBackup.Id),
			Prefix:           pulumi.Any(ociCacheBackupExportToObjectStoragePrefix),
		})
		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 testOciCacheBackupExportToObjectStorage = new Oci.Redis.OciCacheBackupExportToObjectStorage("test_oci_cache_backup_export_to_object_storage", new()
    {
        Bucket = ociCacheBackupExportToObjectStorageBucket,
        Namespace = ociCacheBackupExportToObjectStorageNamespace,
        OciCacheBackupId = testOciCacheBackup.Id,
        Prefix = ociCacheBackupExportToObjectStoragePrefix,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Redis.OciCacheBackupExportToObjectStorage;
import com.pulumi.oci.Redis.OciCacheBackupExportToObjectStorageArgs;
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 testOciCacheBackupExportToObjectStorage = new OciCacheBackupExportToObjectStorage("testOciCacheBackupExportToObjectStorage", OciCacheBackupExportToObjectStorageArgs.builder()
            .bucket(ociCacheBackupExportToObjectStorageBucket)
            .namespace(ociCacheBackupExportToObjectStorageNamespace)
            .ociCacheBackupId(testOciCacheBackup.id())
            .prefix(ociCacheBackupExportToObjectStoragePrefix)
            .build());

    }
}

    resources:
  testOciCacheBackupExportToObjectStorage:
    type: oci:Redis:OciCacheBackupExportToObjectStorage
    name: test_oci_cache_backup_export_to_object_storage
    properties:
      bucket: ${ociCacheBackupExportToObjectStorageBucket}
      namespace: ${ociCacheBackupExportToObjectStorageNamespace}
      ociCacheBackupId: ${testOciCacheBackup.id}
      prefix: ${ociCacheBackupExportToObjectStoragePrefix}

    Create OciCacheBackupExportToObjectStorage Resource

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

    Constructor syntax

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

@overload
def OciCacheBackupExportToObjectStorage(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        bucket: Optional[str] = None,
                                        namespace: Optional[str] = None,
                                        oci_cache_backup_id: Optional[str] = None,
                                        prefix: Optional[str] = None)
    func NewOciCacheBackupExportToObjectStorage(ctx *Context, name string, args OciCacheBackupExportToObjectStorageArgs, opts ...ResourceOption) (*OciCacheBackupExportToObjectStorage, error)
    public OciCacheBackupExportToObjectStorage(string name, OciCacheBackupExportToObjectStorageArgs args, CustomResourceOptions? opts = null)
    public OciCacheBackupExportToObjectStorage(String name, OciCacheBackupExportToObjectStorageArgs args)
public OciCacheBackupExportToObjectStorage(String name, OciCacheBackupExportToObjectStorageArgs args, CustomResourceOptions options)

    type: oci:Redis:OciCacheBackupExportToObjectStorage
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 OciCacheBackupExportToObjectStorageArgs
    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 OciCacheBackupExportToObjectStorageArgs
    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 OciCacheBackupExportToObjectStorageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OciCacheBackupExportToObjectStorageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OciCacheBackupExportToObjectStorageArgs
    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 ociCacheBackupExportToObjectStorageResource = new Oci.Redis.OciCacheBackupExportToObjectStorage("ociCacheBackupExportToObjectStorageResource", new()
{
    Bucket = "string",
    Namespace = "string",
    OciCacheBackupId = "string",
    Prefix = "string",
});

    example, err := redis.NewOciCacheBackupExportToObjectStorage(ctx, "ociCacheBackupExportToObjectStorageResource", &redis.OciCacheBackupExportToObjectStorageArgs{
	Bucket:           pulumi.String("string"),
	Namespace:        pulumi.String("string"),
	OciCacheBackupId: pulumi.String("string"),
	Prefix:           pulumi.String("string"),
})

    var ociCacheBackupExportToObjectStorageResource = new OciCacheBackupExportToObjectStorage("ociCacheBackupExportToObjectStorageResource", OciCacheBackupExportToObjectStorageArgs.builder()
    .bucket("string")
    .namespace("string")
    .ociCacheBackupId("string")
    .prefix("string")
    .build());

    oci_cache_backup_export_to_object_storage_resource = oci.redis.OciCacheBackupExportToObjectStorage("ociCacheBackupExportToObjectStorageResource",
    bucket="string",
    namespace="string",
    oci_cache_backup_id="string",
    prefix="string")

    const ociCacheBackupExportToObjectStorageResource = new oci.redis.OciCacheBackupExportToObjectStorage("ociCacheBackupExportToObjectStorageResource", {
    bucket: "string",
    namespace: "string",
    ociCacheBackupId: "string",
    prefix: "string",
});

    type: oci:Redis:OciCacheBackupExportToObjectStorage
properties:
    bucket: string
    namespace: string
    ociCacheBackupId: string
    prefix: string

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

    Bucket string
    The target Object Storage bucket name.
    Namespace string
    The Object Storage namespace name.
    OciCacheBackupId string
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    Prefix string

    Optional prefix under which the service will place the exported object(s).

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

    Bucket string
    The target Object Storage bucket name.
    Namespace string
    The Object Storage namespace name.
    OciCacheBackupId string
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    Prefix string

    Optional prefix under which the service will place the exported object(s).

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

    bucket String
    The target Object Storage bucket name.
    namespace String
    The Object Storage namespace name.
    ociCacheBackupId String
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    prefix String

    Optional prefix under which the service will place the exported object(s).

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

    bucket string
    The target Object Storage bucket name.
    namespace string
    The Object Storage namespace name.
    ociCacheBackupId string
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    prefix string

    Optional prefix under which the service will place the exported object(s).

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

    bucket str
    The target Object Storage bucket name.
    namespace str
    The Object Storage namespace name.
    oci_cache_backup_id str
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    prefix str

    Optional prefix under which the service will place the exported object(s).

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

    bucket String
    The target Object Storage bucket name.
    namespace String
    The Object Storage namespace name.
    ociCacheBackupId String
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    prefix String

    Optional prefix under which the service will place the exported object(s).

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OciCacheBackupExportToObjectStorage Resource

    Get an existing OciCacheBackupExportToObjectStorage 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?: OciCacheBackupExportToObjectStorageState, opts?: CustomResourceOptions): OciCacheBackupExportToObjectStorage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket: Optional[str] = None,
        namespace: Optional[str] = None,
        oci_cache_backup_id: Optional[str] = None,
        prefix: Optional[str] = None) -> OciCacheBackupExportToObjectStorage
    func GetOciCacheBackupExportToObjectStorage(ctx *Context, name string, id IDInput, state *OciCacheBackupExportToObjectStorageState, opts ...ResourceOption) (*OciCacheBackupExportToObjectStorage, error)
    public static OciCacheBackupExportToObjectStorage Get(string name, Input<string> id, OciCacheBackupExportToObjectStorageState? state, CustomResourceOptions? opts = null)
    public static OciCacheBackupExportToObjectStorage get(String name, Output<String> id, OciCacheBackupExportToObjectStorageState state, CustomResourceOptions options)
    resources:  _:    type: oci:Redis:OciCacheBackupExportToObjectStorage    get:      id: ${id}
    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:
    Bucket string
    The target Object Storage bucket name.
    Namespace string
    The Object Storage namespace name.
    OciCacheBackupId string
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    Prefix string

    Optional prefix under which the service will place the exported object(s).

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

    Bucket string
    The target Object Storage bucket name.
    Namespace string
    The Object Storage namespace name.
    OciCacheBackupId string
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    Prefix string

    Optional prefix under which the service will place the exported object(s).

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

    bucket String
    The target Object Storage bucket name.
    namespace String
    The Object Storage namespace name.
    ociCacheBackupId String
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    prefix String

    Optional prefix under which the service will place the exported object(s).

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

    bucket string
    The target Object Storage bucket name.
    namespace string
    The Object Storage namespace name.
    ociCacheBackupId string
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    prefix string

    Optional prefix under which the service will place the exported object(s).

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

    bucket str
    The target Object Storage bucket name.
    namespace str
    The Object Storage namespace name.
    oci_cache_backup_id str
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    prefix str

    Optional prefix under which the service will place the exported object(s).

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

    bucket String
    The target Object Storage bucket name.
    namespace String
    The Object Storage namespace name.
    ociCacheBackupId String
    Unique Oracle Cloud Infrastructure Cache Backup identifier.
    prefix String

    Optional prefix under which the service will place the exported object(s).

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

    Import

    Import is not supported for this resource.

    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
    Viewing docs for Oracle Cloud Infrastructure v4.10.0
    published on Thursday, May 7, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Try Pulumi Cloud free. Your team will thank you.