Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Psql
  5. Backup
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

oci.Psql.Backup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Backup resource in Oracle Cloud Infrastructure Psql service.

    Creates a new backup.

    Example Usage

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

const testBackup = new oci.psql.Backup("test_backup", {
    compartmentId: compartmentId,
    dbSystemId: testDbSystem.id,
    displayName: backupDisplayName,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: backupDescription,
    freeformTags: {
        "bar-key": "value",
    },
    retentionPeriod: backupRetentionPeriod,
});

    import pulumi
import pulumi_oci as oci

test_backup = oci.psql.Backup("test_backup",
    compartment_id=compartment_id,
    db_system_id=test_db_system["id"],
    display_name=backup_display_name,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=backup_description,
    freeform_tags={
        "bar-key": "value",
    },
    retention_period=backup_retention_period)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := psql.NewBackup(ctx, "test_backup", &psql.BackupArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DbSystemId:    pulumi.Any(testDbSystem.Id),
			DisplayName:   pulumi.Any(backupDisplayName),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(backupDescription),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			RetentionPeriod: pulumi.Any(backupRetentionPeriod),
		})
		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 testBackup = new Oci.Psql.Backup("test_backup", new()
    {
        CompartmentId = compartmentId,
        DbSystemId = testDbSystem.Id,
        DisplayName = backupDisplayName,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = backupDescription,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        RetentionPeriod = backupRetentionPeriod,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Psql.Backup;
import com.pulumi.oci.Psql.BackupArgs;
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 testBackup = new Backup("testBackup", BackupArgs.builder()
            .compartmentId(compartmentId)
            .dbSystemId(testDbSystem.id())
            .displayName(backupDisplayName)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(backupDescription)
            .freeformTags(Map.of("bar-key", "value"))
            .retentionPeriod(backupRetentionPeriod)
            .build());

    }
}

    resources:
  testBackup:
    type: oci:Psql:Backup
    name: test_backup
    properties:
      compartmentId: ${compartmentId}
      dbSystemId: ${testDbSystem.id}
      displayName: ${backupDisplayName}
      definedTags:
        foo-namespace.bar-key: value
      description: ${backupDescription}
      freeformTags:
        bar-key: value
      retentionPeriod: ${backupRetentionPeriod}

    Create Backup Resource

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

    Constructor syntax

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

@overload
def Backup(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           compartment_id: Optional[str] = None,
           db_system_id: Optional[str] = None,
           defined_tags: Optional[Mapping[str, str]] = None,
           description: Optional[str] = None,
           display_name: Optional[str] = None,
           freeform_tags: Optional[Mapping[str, str]] = None,
           retention_period: Optional[int] = None,
           source_backup_details: Optional[_psql.BackupSourceBackupDetailsArgs] = None)
    func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
    public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
    public Backup(String name, BackupArgs args)
public Backup(String name, BackupArgs args, CustomResourceOptions options)

    type: oci:Psql:Backup
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 BackupArgs
    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 BackupArgs
    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 BackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupArgs
    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 ociBackupResource = new Oci.Psql.Backup("ociBackupResource", new()
{
    CompartmentId = "string",
    DbSystemId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    RetentionPeriod = 0,
    SourceBackupDetails = new Oci.Psql.Inputs.BackupSourceBackupDetailsArgs
    {
        SourceBackupId = "string",
        SourceRegion = "string",
    },
});

    example, err := Psql.NewBackup(ctx, "ociBackupResource", &Psql.BackupArgs{
	CompartmentId: pulumi.String("string"),
	DbSystemId:    pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	RetentionPeriod: pulumi.Int(0),
	SourceBackupDetails: &psql.BackupSourceBackupDetailsArgs{
		SourceBackupId: pulumi.String("string"),
		SourceRegion:   pulumi.String("string"),
	},
})

    var ociBackupResource = new Backup("ociBackupResource", BackupArgs.builder()
    .compartmentId("string")
    .dbSystemId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .retentionPeriod(0)
    .sourceBackupDetails(BackupSourceBackupDetailsArgs.builder()
        .sourceBackupId("string")
        .sourceRegion("string")
        .build())
    .build());

    oci_backup_resource = oci.psql.Backup("ociBackupResource",
    compartment_id="string",
    db_system_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    retention_period=0,
    source_backup_details={
        "source_backup_id": "string",
        "source_region": "string",
    })

    const ociBackupResource = new oci.psql.Backup("ociBackupResource", {
    compartmentId: "string",
    dbSystemId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    retentionPeriod: 0,
    sourceBackupDetails: {
        sourceBackupId: "string",
        sourceRegion: "string",
    },
});

    type: oci:Psql:Backup
properties:
    compartmentId: string
    dbSystemId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    retentionPeriod: 0
    sourceBackupDetails:
        sourceBackupId: string
        sourceRegion: string

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

    CompartmentId string
    (Updatable) The OCID of the compartment that contains the backup.
    DbSystemId string
    The ID of the database system.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) A description for the backup.
    DisplayName string
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    RetentionPeriod int

    (Updatable) Backup retention period in days.

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

    SourceBackupDetails BackupSourceBackupDetails
    Information about the Source Backup associated with a backup.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the backup.
    DbSystemId string
    The ID of the database system.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) A description for the backup.
    DisplayName string
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    RetentionPeriod int

    (Updatable) Backup retention period in days.

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

    SourceBackupDetails BackupSourceBackupDetailsArgs
    Information about the Source Backup associated with a backup.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the backup.
    dbSystemId String
    The ID of the database system.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) A description for the backup.
    displayName String
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    retentionPeriod Integer

    (Updatable) Backup retention period in days.

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

    sourceBackupDetails BackupSourceBackupDetails
    Information about the Source Backup associated with a backup.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the backup.
    dbSystemId string
    The ID of the database system.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) A description for the backup.
    displayName string
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    retentionPeriod number

    (Updatable) Backup retention period in days.

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

    sourceBackupDetails BackupSourceBackupDetails
    Information about the Source Backup associated with a backup.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the backup.
    db_system_id str
    The ID of the database system.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) A description for the backup.
    display_name str
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    retention_period int

    (Updatable) Backup retention period in days.

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

    source_backup_details psql.BackupSourceBackupDetailsArgs
    Information about the Source Backup associated with a backup.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the backup.
    dbSystemId String
    The ID of the database system.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) A description for the backup.
    displayName String
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    retentionPeriod Number

    (Updatable) Backup retention period in days.

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

    sourceBackupDetails Property Map
    Information about the Source Backup associated with a backup.

    Outputs

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

    BackupSize int
    The size of the backup, in gigabytes.
    CopyStatuses List<BackupCopyStatus>
    List of status for Backup Copy
    DbSystemDetails List<BackupDbSystemDetail>
    Information about the database system associated with a backup.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastAcceptedRequestToken string
    lastAcceptedRequestToken from MP.
    LastCompletedRequestToken string
    lastCompletedRequestToken from MP.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    SourceType string
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    State string
    The current state of the backup.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeCreatedPrecise string
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    BackupSize int
    The size of the backup, in gigabytes.
    CopyStatuses []BackupCopyStatus
    List of status for Backup Copy
    DbSystemDetails []BackupDbSystemDetail
    Information about the database system associated with a backup.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastAcceptedRequestToken string
    lastAcceptedRequestToken from MP.
    LastCompletedRequestToken string
    lastCompletedRequestToken from MP.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    SourceType string
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    State string
    The current state of the backup.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeCreatedPrecise string
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    backupSize Integer
    The size of the backup, in gigabytes.
    copyStatuses List<BackupCopyStatus>
    List of status for Backup Copy
    dbSystemDetails List<BackupDbSystemDetail>
    Information about the database system associated with a backup.
    id String
    The provider-assigned unique ID for this managed resource.
    lastAcceptedRequestToken String
    lastAcceptedRequestToken from MP.
    lastCompletedRequestToken String
    lastCompletedRequestToken from MP.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    sourceType String
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    state String
    The current state of the backup.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeCreatedPrecise String
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    backupSize number
    The size of the backup, in gigabytes.
    copyStatuses BackupCopyStatus[]
    List of status for Backup Copy
    dbSystemDetails BackupDbSystemDetail[]
    Information about the database system associated with a backup.
    id string
    The provider-assigned unique ID for this managed resource.
    lastAcceptedRequestToken string
    lastAcceptedRequestToken from MP.
    lastCompletedRequestToken string
    lastCompletedRequestToken from MP.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    sourceType string
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    state string
    The current state of the backup.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeCreatedPrecise string
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    backup_size int
    The size of the backup, in gigabytes.
    copy_statuses Sequence[psql.BackupCopyStatus]
    List of status for Backup Copy
    db_system_details Sequence[psql.BackupDbSystemDetail]
    Information about the database system associated with a backup.
    id str
    The provider-assigned unique ID for this managed resource.
    last_accepted_request_token str
    lastAcceptedRequestToken from MP.
    last_completed_request_token str
    lastCompletedRequestToken from MP.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    source_type str
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    state str
    The current state of the backup.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    time_created_precise str
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    backupSize Number
    The size of the backup, in gigabytes.
    copyStatuses List<Property Map>
    List of status for Backup Copy
    dbSystemDetails List<Property Map>
    Information about the database system associated with a backup.
    id String
    The provider-assigned unique ID for this managed resource.
    lastAcceptedRequestToken String
    lastAcceptedRequestToken from MP.
    lastCompletedRequestToken String
    lastCompletedRequestToken from MP.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    sourceType String
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    state String
    The current state of the backup.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeCreatedPrecise String
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

    Look up Existing Backup Resource

    Get an existing Backup 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?: BackupState, opts?: CustomResourceOptions): Backup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_size: Optional[int] = None,
        compartment_id: Optional[str] = None,
        copy_statuses: Optional[Sequence[_psql.BackupCopyStatusArgs]] = None,
        db_system_details: Optional[Sequence[_psql.BackupDbSystemDetailArgs]] = None,
        db_system_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        last_accepted_request_token: Optional[str] = None,
        last_completed_request_token: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        retention_period: Optional[int] = None,
        source_backup_details: Optional[_psql.BackupSourceBackupDetailsArgs] = None,
        source_type: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_created_precise: Optional[str] = None,
        time_updated: Optional[str] = None) -> Backup
    func GetBackup(ctx *Context, name string, id IDInput, state *BackupState, opts ...ResourceOption) (*Backup, error)
    public static Backup Get(string name, Input<string> id, BackupState? state, CustomResourceOptions? opts = null)
    public static Backup get(String name, Output<String> id, BackupState state, CustomResourceOptions options)
    resources:  _:    type: oci:Psql:Backup    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:
    BackupSize int
    The size of the backup, in gigabytes.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the backup.
    CopyStatuses List<BackupCopyStatus>
    List of status for Backup Copy
    DbSystemDetails List<BackupDbSystemDetail>
    Information about the database system associated with a backup.
    DbSystemId string
    The ID of the database system.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) A description for the backup.
    DisplayName string
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LastAcceptedRequestToken string
    lastAcceptedRequestToken from MP.
    LastCompletedRequestToken string
    lastCompletedRequestToken from MP.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    RetentionPeriod int

    (Updatable) Backup retention period in days.

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

    SourceBackupDetails BackupSourceBackupDetails
    Information about the Source Backup associated with a backup.
    SourceType string
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    State string
    The current state of the backup.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeCreatedPrecise string
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    BackupSize int
    The size of the backup, in gigabytes.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the backup.
    CopyStatuses []BackupCopyStatusArgs
    List of status for Backup Copy
    DbSystemDetails []BackupDbSystemDetailArgs
    Information about the database system associated with a backup.
    DbSystemId string
    The ID of the database system.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) A description for the backup.
    DisplayName string
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LastAcceptedRequestToken string
    lastAcceptedRequestToken from MP.
    LastCompletedRequestToken string
    lastCompletedRequestToken from MP.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    RetentionPeriod int

    (Updatable) Backup retention period in days.

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

    SourceBackupDetails BackupSourceBackupDetailsArgs
    Information about the Source Backup associated with a backup.
    SourceType string
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    State string
    The current state of the backup.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeCreatedPrecise string
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    backupSize Integer
    The size of the backup, in gigabytes.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the backup.
    copyStatuses List<BackupCopyStatus>
    List of status for Backup Copy
    dbSystemDetails List<BackupDbSystemDetail>
    Information about the database system associated with a backup.
    dbSystemId String
    The ID of the database system.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) A description for the backup.
    displayName String
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lastAcceptedRequestToken String
    lastAcceptedRequestToken from MP.
    lastCompletedRequestToken String
    lastCompletedRequestToken from MP.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    retentionPeriod Integer

    (Updatable) Backup retention period in days.

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

    sourceBackupDetails BackupSourceBackupDetails
    Information about the Source Backup associated with a backup.
    sourceType String
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    state String
    The current state of the backup.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeCreatedPrecise String
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    backupSize number
    The size of the backup, in gigabytes.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the backup.
    copyStatuses BackupCopyStatus[]
    List of status for Backup Copy
    dbSystemDetails BackupDbSystemDetail[]
    Information about the database system associated with a backup.
    dbSystemId string
    The ID of the database system.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) A description for the backup.
    displayName string
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lastAcceptedRequestToken string
    lastAcceptedRequestToken from MP.
    lastCompletedRequestToken string
    lastCompletedRequestToken from MP.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    retentionPeriod number

    (Updatable) Backup retention period in days.

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

    sourceBackupDetails BackupSourceBackupDetails
    Information about the Source Backup associated with a backup.
    sourceType string
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    state string
    The current state of the backup.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeCreatedPrecise string
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    backup_size int
    The size of the backup, in gigabytes.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the backup.
    copy_statuses Sequence[psql.BackupCopyStatusArgs]
    List of status for Backup Copy
    db_system_details Sequence[psql.BackupDbSystemDetailArgs]
    Information about the database system associated with a backup.
    db_system_id str
    The ID of the database system.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) A description for the backup.
    display_name str
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    last_accepted_request_token str
    lastAcceptedRequestToken from MP.
    last_completed_request_token str
    lastCompletedRequestToken from MP.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    retention_period int

    (Updatable) Backup retention period in days.

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

    source_backup_details psql.BackupSourceBackupDetailsArgs
    Information about the Source Backup associated with a backup.
    source_type str
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    state str
    The current state of the backup.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    time_created_precise str
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    backupSize Number
    The size of the backup, in gigabytes.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the backup.
    copyStatuses List<Property Map>
    List of status for Backup Copy
    dbSystemDetails List<Property Map>
    Information about the database system associated with a backup.
    dbSystemId String
    The ID of the database system.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) A description for the backup.
    displayName String
    (Updatable) A user-friendly display name for the backup. Avoid entering confidential information.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lastAcceptedRequestToken String
    lastAcceptedRequestToken from MP.
    lastCompletedRequestToken String
    lastCompletedRequestToken from MP.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    retentionPeriod Number

    (Updatable) Backup retention period in days.

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

    sourceBackupDetails Property Map
    Information about the Source Backup associated with a backup.
    sourceType String
    Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.
    state String
    The current state of the backup.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the backup request was received, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeCreatedPrecise String
    The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the backup was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

    Supporting Types

    BackupCopyStatus, BackupCopyStatusArgs

    BackupId string
    The OCID of the backup in the source region
    Region string
    Region name of the remote region
    State string
    The current state of the backup.
    StateDetails string
    A message describing the current state of copy in more detail
    BackupId string
    The OCID of the backup in the source region
    Region string
    Region name of the remote region
    State string
    The current state of the backup.
    StateDetails string
    A message describing the current state of copy in more detail
    backupId String
    The OCID of the backup in the source region
    region String
    Region name of the remote region
    state String
    The current state of the backup.
    stateDetails String
    A message describing the current state of copy in more detail
    backupId string
    The OCID of the backup in the source region
    region string
    Region name of the remote region
    state string
    The current state of the backup.
    stateDetails string
    A message describing the current state of copy in more detail
    backup_id str
    The OCID of the backup in the source region
    region str
    Region name of the remote region
    state str
    The current state of the backup.
    state_details str
    A message describing the current state of copy in more detail
    backupId String
    The OCID of the backup in the source region
    region String
    Region name of the remote region
    state String
    The current state of the backup.
    stateDetails String
    A message describing the current state of copy in more detail

    BackupDbSystemDetail, BackupDbSystemDetailArgs

    ConfigId string
    OCID of the configuration that was applied on the source dbSystem at the time when backup was taken.
    DbVersion string
    The major and minor versions of the database system software.
    SystemType string
    Type of the database system.
    ConfigId string
    OCID of the configuration that was applied on the source dbSystem at the time when backup was taken.
    DbVersion string
    The major and minor versions of the database system software.
    SystemType string
    Type of the database system.
    configId String
    OCID of the configuration that was applied on the source dbSystem at the time when backup was taken.
    dbVersion String
    The major and minor versions of the database system software.
    systemType String
    Type of the database system.
    configId string
    OCID of the configuration that was applied on the source dbSystem at the time when backup was taken.
    dbVersion string
    The major and minor versions of the database system software.
    systemType string
    Type of the database system.
    config_id str
    OCID of the configuration that was applied on the source dbSystem at the time when backup was taken.
    db_version str
    The major and minor versions of the database system software.
    system_type str
    Type of the database system.
    configId String
    OCID of the configuration that was applied on the source dbSystem at the time when backup was taken.
    dbVersion String
    The major and minor versions of the database system software.
    systemType String
    Type of the database system.

    BackupSourceBackupDetails, BackupSourceBackupDetailsArgs

    SourceBackupId string
    Backup ID of the COPY source type.
    SourceRegion string
    Backup Region of the COPY source type.
    SourceBackupId string
    Backup ID of the COPY source type.
    SourceRegion string
    Backup Region of the COPY source type.
    sourceBackupId String
    Backup ID of the COPY source type.
    sourceRegion String
    Backup Region of the COPY source type.
    sourceBackupId string
    Backup ID of the COPY source type.
    sourceRegion string
    Backup Region of the COPY source type.
    source_backup_id str
    Backup ID of the COPY source type.
    source_region str
    Backup Region of the COPY source type.
    sourceBackupId String
    Backup ID of the COPY source type.
    sourceRegion String
    Backup Region of the COPY source type.

    Import

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

    $ pulumi import oci:Psql/backup:Backup test_backup "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.28.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-oci