Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GoldenGate
  5. DeploymentBackup
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.GoldenGate.DeploymentBackup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Deployment Backup resource in Oracle Cloud Infrastructure Golden Gate service.

    Creates a new DeploymentBackup.

    Example Usage

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

const testDeploymentBackup = new oci.goldengate.DeploymentBackup("test_deployment_backup", {
    bucket: deploymentBackupBucket,
    compartmentId: compartmentId,
    deploymentId: testDeployment.id,
    displayName: deploymentBackupDisplayName,
    namespace: deploymentBackupNamespace,
    object: deploymentBackupObject,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    isMetadataOnly: deploymentBackupIsMetadataOnly,
    locks: [{
        type: deploymentBackupLocksType,
        message: deploymentBackupLocksMessage,
    }],
});

    import pulumi
import pulumi_oci as oci

test_deployment_backup = oci.golden_gate.DeploymentBackup("test_deployment_backup",
    bucket=deployment_backup_bucket,
    compartment_id=compartment_id,
    deployment_id=test_deployment["id"],
    display_name=deployment_backup_display_name,
    namespace=deployment_backup_namespace,
    object=deployment_backup_object,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    is_metadata_only=deployment_backup_is_metadata_only,
    locks=[{
        "type": deployment_backup_locks_type,
        "message": deployment_backup_locks_message,
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := goldengate.NewDeploymentBackup(ctx, "test_deployment_backup", &goldengate.DeploymentBackupArgs{
			Bucket:        pulumi.Any(deploymentBackupBucket),
			CompartmentId: pulumi.Any(compartmentId),
			DeploymentId:  pulumi.Any(testDeployment.Id),
			DisplayName:   pulumi.Any(deploymentBackupDisplayName),
			Namespace:     pulumi.Any(deploymentBackupNamespace),
			Object:        pulumi.Any(deploymentBackupObject),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			IsMetadataOnly: pulumi.Any(deploymentBackupIsMetadataOnly),
			Locks: goldengate.DeploymentBackupLockArray{
				&goldengate.DeploymentBackupLockArgs{
					Type:    pulumi.Any(deploymentBackupLocksType),
					Message: pulumi.Any(deploymentBackupLocksMessage),
				},
			},
		})
		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 testDeploymentBackup = new Oci.GoldenGate.DeploymentBackup("test_deployment_backup", new()
    {
        Bucket = deploymentBackupBucket,
        CompartmentId = compartmentId,
        DeploymentId = testDeployment.Id,
        DisplayName = deploymentBackupDisplayName,
        Namespace = deploymentBackupNamespace,
        Object = deploymentBackupObject,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        IsMetadataOnly = deploymentBackupIsMetadataOnly,
        Locks = new[]
        {
            new Oci.GoldenGate.Inputs.DeploymentBackupLockArgs
            {
                Type = deploymentBackupLocksType,
                Message = deploymentBackupLocksMessage,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GoldenGate.DeploymentBackup;
import com.pulumi.oci.GoldenGate.DeploymentBackupArgs;
import com.pulumi.oci.GoldenGate.inputs.DeploymentBackupLockArgs;
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 testDeploymentBackup = new DeploymentBackup("testDeploymentBackup", DeploymentBackupArgs.builder()
            .bucket(deploymentBackupBucket)
            .compartmentId(compartmentId)
            .deploymentId(testDeployment.id())
            .displayName(deploymentBackupDisplayName)
            .namespace(deploymentBackupNamespace)
            .object(deploymentBackupObject)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .isMetadataOnly(deploymentBackupIsMetadataOnly)
            .locks(DeploymentBackupLockArgs.builder()
                .type(deploymentBackupLocksType)
                .message(deploymentBackupLocksMessage)
                .build())
            .build());

    }
}

    resources:
  testDeploymentBackup:
    type: oci:GoldenGate:DeploymentBackup
    name: test_deployment_backup
    properties:
      bucket: ${deploymentBackupBucket}
      compartmentId: ${compartmentId}
      deploymentId: ${testDeployment.id}
      displayName: ${deploymentBackupDisplayName}
      namespace: ${deploymentBackupNamespace}
      object: ${deploymentBackupObject}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      isMetadataOnly: ${deploymentBackupIsMetadataOnly}
      locks:
        - type: ${deploymentBackupLocksType}
          message: ${deploymentBackupLocksMessage}

    Create DeploymentBackup Resource

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

    Constructor syntax

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

@overload
def DeploymentBackup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     bucket: Optional[str] = None,
                     compartment_id: Optional[str] = None,
                     deployment_id: Optional[str] = None,
                     display_name: Optional[str] = None,
                     namespace: Optional[str] = None,
                     object: Optional[str] = None,
                     defined_tags: Optional[Mapping[str, str]] = None,
                     freeform_tags: Optional[Mapping[str, str]] = None,
                     is_lock_override: Optional[bool] = None,
                     is_metadata_only: Optional[bool] = None,
                     locks: Optional[Sequence[DeploymentBackupLockArgs]] = None)
    func NewDeploymentBackup(ctx *Context, name string, args DeploymentBackupArgs, opts ...ResourceOption) (*DeploymentBackup, error)
    public DeploymentBackup(string name, DeploymentBackupArgs args, CustomResourceOptions? opts = null)
    public DeploymentBackup(String name, DeploymentBackupArgs args)
public DeploymentBackup(String name, DeploymentBackupArgs args, CustomResourceOptions options)

    type: oci:GoldenGate:DeploymentBackup
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 DeploymentBackupArgs
    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 DeploymentBackupArgs
    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 DeploymentBackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeploymentBackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeploymentBackupArgs
    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 deploymentBackupResource = new Oci.GoldenGate.DeploymentBackup("deploymentBackupResource", new()
{
    Bucket = "string",
    CompartmentId = "string",
    DeploymentId = "string",
    DisplayName = "string",
    Namespace = "string",
    Object = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsLockOverride = false,
    IsMetadataOnly = false,
    Locks = new[]
    {
        new Oci.GoldenGate.Inputs.DeploymentBackupLockArgs
        {
            Type = "string",
            Message = "string",
            RelatedResourceId = "string",
            TimeCreated = "string",
        },
    },
});

    example, err := goldengate.NewDeploymentBackup(ctx, "deploymentBackupResource", &goldengate.DeploymentBackupArgs{
	Bucket:        pulumi.String("string"),
	CompartmentId: pulumi.String("string"),
	DeploymentId:  pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	Namespace:     pulumi.String("string"),
	Object:        pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsLockOverride: pulumi.Bool(false),
	IsMetadataOnly: pulumi.Bool(false),
	Locks: goldengate.DeploymentBackupLockArray{
		&goldengate.DeploymentBackupLockArgs{
			Type:              pulumi.String("string"),
			Message:           pulumi.String("string"),
			RelatedResourceId: pulumi.String("string"),
			TimeCreated:       pulumi.String("string"),
		},
	},
})

    var deploymentBackupResource = new DeploymentBackup("deploymentBackupResource", DeploymentBackupArgs.builder()
    .bucket("string")
    .compartmentId("string")
    .deploymentId("string")
    .displayName("string")
    .namespace("string")
    .object("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .isLockOverride(false)
    .isMetadataOnly(false)
    .locks(DeploymentBackupLockArgs.builder()
        .type("string")
        .message("string")
        .relatedResourceId("string")
        .timeCreated("string")
        .build())
    .build());

    deployment_backup_resource = oci.golden_gate.DeploymentBackup("deploymentBackupResource",
    bucket="string",
    compartment_id="string",
    deployment_id="string",
    display_name="string",
    namespace="string",
    object="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    is_lock_override=False,
    is_metadata_only=False,
    locks=[{
        "type": "string",
        "message": "string",
        "related_resource_id": "string",
        "time_created": "string",
    }])

    const deploymentBackupResource = new oci.goldengate.DeploymentBackup("deploymentBackupResource", {
    bucket: "string",
    compartmentId: "string",
    deploymentId: "string",
    displayName: "string",
    namespace: "string",
    object: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    isLockOverride: false,
    isMetadataOnly: false,
    locks: [{
        type: "string",
        message: "string",
        relatedResourceId: "string",
        timeCreated: "string",
    }],
});

    type: oci:GoldenGate:DeploymentBackup
properties:
    bucket: string
    compartmentId: string
    definedTags:
        string: string
    deploymentId: string
    displayName: string
    freeformTags:
        string: string
    isLockOverride: false
    isMetadataOnly: false
    locks:
        - message: string
          relatedResourceId: string
          timeCreated: string
          type: string
    namespace: string
    object: string

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

    Bucket string
    Name of the bucket where the object is to be uploaded in the object storage
    CompartmentId string
    (Updatable) The OCID of the compartment being referenced.
    DeploymentId string
    The OCID of the deployment being referenced.
    DisplayName string
    An object's Display Name.
    Namespace string
    Name of namespace that serves as a container for all of your buckets
    Object string

    Name of the object to be uploaded to object storage

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, string>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, string>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsLockOverride bool
    IsMetadataOnly bool
    Parameter to allow users to create backup without trails
    Locks List<DeploymentBackupLock>
    Locks associated with this resource.
    Bucket string
    Name of the bucket where the object is to be uploaded in the object storage
    CompartmentId string
    (Updatable) The OCID of the compartment being referenced.
    DeploymentId string
    The OCID of the deployment being referenced.
    DisplayName string
    An object's Display Name.
    Namespace string
    Name of namespace that serves as a container for all of your buckets
    Object string

    Name of the object to be uploaded to object storage

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]string
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]string
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsLockOverride bool
    IsMetadataOnly bool
    Parameter to allow users to create backup without trails
    Locks []DeploymentBackupLockArgs
    Locks associated with this resource.
    bucket String
    Name of the bucket where the object is to be uploaded in the object storage
    compartmentId String
    (Updatable) The OCID of the compartment being referenced.
    deploymentId String
    The OCID of the deployment being referenced.
    displayName String
    An object's Display Name.
    namespace String
    Name of namespace that serves as a container for all of your buckets
    object String

    Name of the object to be uploaded to object storage

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,String>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isLockOverride Boolean
    isMetadataOnly Boolean
    Parameter to allow users to create backup without trails
    locks List<DeploymentBackupLock>
    Locks associated with this resource.
    bucket string
    Name of the bucket where the object is to be uploaded in the object storage
    compartmentId string
    (Updatable) The OCID of the compartment being referenced.
    deploymentId string
    The OCID of the deployment being referenced.
    displayName string
    An object's Display Name.
    namespace string
    Name of namespace that serves as a container for all of your buckets
    object string

    Name of the object to be uploaded to object storage

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: string}
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: string}
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isLockOverride boolean
    isMetadataOnly boolean
    Parameter to allow users to create backup without trails
    locks DeploymentBackupLock[]
    Locks associated with this resource.
    bucket str
    Name of the bucket where the object is to be uploaded in the object storage
    compartment_id str
    (Updatable) The OCID of the compartment being referenced.
    deployment_id str
    The OCID of the deployment being referenced.
    display_name str
    An object's Display Name.
    namespace str
    Name of namespace that serves as a container for all of your buckets
    object str

    Name of the object to be uploaded to object storage

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, str]
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags Mapping[str, str]
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    is_lock_override bool
    is_metadata_only bool
    Parameter to allow users to create backup without trails
    locks Sequence[DeploymentBackupLockArgs]
    Locks associated with this resource.
    bucket String
    Name of the bucket where the object is to be uploaded in the object storage
    compartmentId String
    (Updatable) The OCID of the compartment being referenced.
    deploymentId String
    The OCID of the deployment being referenced.
    displayName String
    An object's Display Name.
    namespace String
    Name of namespace that serves as a container for all of your buckets
    object String

    Name of the object to be uploaded to object storage

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isLockOverride Boolean
    isMetadataOnly Boolean
    Parameter to allow users to create backup without trails
    locks List<Property Map>
    Locks associated with this resource.

    Outputs

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

    BackupSourceType string
    Possible deployment backup source types.
    BackupType string
    Possible Deployment backup types.
    DeploymentType string
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsAutomatic bool
    True if this object is automatically created
    LifecycleDetails string
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    OggVersion string
    Version of OGG
    SizeInBytes double
    The size of the backup stored in object storage (in bytes)
    State string
    Possible lifecycle states.
    SystemTags Dictionary<string, string>
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeBackupFinished string
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeCreated string
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeOfBackup string
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeUpdated string
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    BackupSourceType string
    Possible deployment backup source types.
    BackupType string
    Possible Deployment backup types.
    DeploymentType string
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsAutomatic bool
    True if this object is automatically created
    LifecycleDetails string
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    OggVersion string
    Version of OGG
    SizeInBytes float64
    The size of the backup stored in object storage (in bytes)
    State string
    Possible lifecycle states.
    SystemTags map[string]string
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeBackupFinished string
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeCreated string
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeOfBackup string
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeUpdated string
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    backupSourceType String
    Possible deployment backup source types.
    backupType String
    Possible Deployment backup types.
    deploymentType String
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    id String
    The provider-assigned unique ID for this managed resource.
    isAutomatic Boolean
    True if this object is automatically created
    lifecycleDetails String
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    oggVersion String
    Version of OGG
    sizeInBytes Double
    The size of the backup stored in object storage (in bytes)
    state String
    Possible lifecycle states.
    systemTags Map<String,String>
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    timeBackupFinished String
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeCreated String
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeOfBackup String
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeUpdated String
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    backupSourceType string
    Possible deployment backup source types.
    backupType string
    Possible Deployment backup types.
    deploymentType string
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    id string
    The provider-assigned unique ID for this managed resource.
    isAutomatic boolean
    True if this object is automatically created
    lifecycleDetails string
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    oggVersion string
    Version of OGG
    sizeInBytes number
    The size of the backup stored in object storage (in bytes)
    state string
    Possible lifecycle states.
    systemTags {[key: string]: string}
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    timeBackupFinished string
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeCreated string
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeOfBackup string
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeUpdated string
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    backup_source_type str
    Possible deployment backup source types.
    backup_type str
    Possible Deployment backup types.
    deployment_type str
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    id str
    The provider-assigned unique ID for this managed resource.
    is_automatic bool
    True if this object is automatically created
    lifecycle_details str
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    ogg_version str
    Version of OGG
    size_in_bytes float
    The size of the backup stored in object storage (in bytes)
    state str
    Possible lifecycle states.
    system_tags Mapping[str, str]
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    time_backup_finished str
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    time_created str
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    time_of_backup str
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    time_updated str
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    backupSourceType String
    Possible deployment backup source types.
    backupType String
    Possible Deployment backup types.
    deploymentType String
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    id String
    The provider-assigned unique ID for this managed resource.
    isAutomatic Boolean
    True if this object is automatically created
    lifecycleDetails String
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    oggVersion String
    Version of OGG
    sizeInBytes Number
    The size of the backup stored in object storage (in bytes)
    state String
    Possible lifecycle states.
    systemTags Map<String>
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    timeBackupFinished String
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeCreated String
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeOfBackup String
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeUpdated String
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

    Look up Existing DeploymentBackup Resource

    Get an existing DeploymentBackup 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?: DeploymentBackupState, opts?: CustomResourceOptions): DeploymentBackup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_source_type: Optional[str] = None,
        backup_type: Optional[str] = None,
        bucket: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        deployment_id: Optional[str] = None,
        deployment_type: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_automatic: Optional[bool] = None,
        is_lock_override: Optional[bool] = None,
        is_metadata_only: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        locks: Optional[Sequence[DeploymentBackupLockArgs]] = None,
        namespace: Optional[str] = None,
        object: Optional[str] = None,
        ogg_version: Optional[str] = None,
        size_in_bytes: Optional[float] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_backup_finished: Optional[str] = None,
        time_created: Optional[str] = None,
        time_of_backup: Optional[str] = None,
        time_updated: Optional[str] = None) -> DeploymentBackup
    func GetDeploymentBackup(ctx *Context, name string, id IDInput, state *DeploymentBackupState, opts ...ResourceOption) (*DeploymentBackup, error)
    public static DeploymentBackup Get(string name, Input<string> id, DeploymentBackupState? state, CustomResourceOptions? opts = null)
    public static DeploymentBackup get(String name, Output<String> id, DeploymentBackupState state, CustomResourceOptions options)
    resources:  _:    type: oci:GoldenGate:DeploymentBackup    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:
    BackupSourceType string
    Possible deployment backup source types.
    BackupType string
    Possible Deployment backup types.
    Bucket string
    Name of the bucket where the object is to be uploaded in the object storage
    CompartmentId string
    (Updatable) The OCID of the compartment being referenced.
    DefinedTags Dictionary<string, string>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DeploymentId string
    The OCID of the deployment being referenced.
    DeploymentType string
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    DisplayName string
    An object's Display Name.
    FreeformTags Dictionary<string, string>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsAutomatic bool
    True if this object is automatically created
    IsLockOverride bool
    IsMetadataOnly bool
    Parameter to allow users to create backup without trails
    LifecycleDetails string
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    Locks List<DeploymentBackupLock>
    Locks associated with this resource.
    Namespace string
    Name of namespace that serves as a container for all of your buckets
    Object string

    Name of the object to be uploaded to object storage

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

    OggVersion string
    Version of OGG
    SizeInBytes double
    The size of the backup stored in object storage (in bytes)
    State string
    Possible lifecycle states.
    SystemTags Dictionary<string, string>
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeBackupFinished string
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeCreated string
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeOfBackup string
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeUpdated string
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    BackupSourceType string
    Possible deployment backup source types.
    BackupType string
    Possible Deployment backup types.
    Bucket string
    Name of the bucket where the object is to be uploaded in the object storage
    CompartmentId string
    (Updatable) The OCID of the compartment being referenced.
    DefinedTags map[string]string
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DeploymentId string
    The OCID of the deployment being referenced.
    DeploymentType string
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    DisplayName string
    An object's Display Name.
    FreeformTags map[string]string
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsAutomatic bool
    True if this object is automatically created
    IsLockOverride bool
    IsMetadataOnly bool
    Parameter to allow users to create backup without trails
    LifecycleDetails string
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    Locks []DeploymentBackupLockArgs
    Locks associated with this resource.
    Namespace string
    Name of namespace that serves as a container for all of your buckets
    Object string

    Name of the object to be uploaded to object storage

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

    OggVersion string
    Version of OGG
    SizeInBytes float64
    The size of the backup stored in object storage (in bytes)
    State string
    Possible lifecycle states.
    SystemTags map[string]string
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeBackupFinished string
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeCreated string
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeOfBackup string
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    TimeUpdated string
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    backupSourceType String
    Possible deployment backup source types.
    backupType String
    Possible Deployment backup types.
    bucket String
    Name of the bucket where the object is to be uploaded in the object storage
    compartmentId String
    (Updatable) The OCID of the compartment being referenced.
    definedTags Map<String,String>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    deploymentId String
    The OCID of the deployment being referenced.
    deploymentType String
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    displayName String
    An object's Display Name.
    freeformTags Map<String,String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isAutomatic Boolean
    True if this object is automatically created
    isLockOverride Boolean
    isMetadataOnly Boolean
    Parameter to allow users to create backup without trails
    lifecycleDetails String
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    locks List<DeploymentBackupLock>
    Locks associated with this resource.
    namespace String
    Name of namespace that serves as a container for all of your buckets
    object String

    Name of the object to be uploaded to object storage

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

    oggVersion String
    Version of OGG
    sizeInBytes Double
    The size of the backup stored in object storage (in bytes)
    state String
    Possible lifecycle states.
    systemTags Map<String,String>
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    timeBackupFinished String
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeCreated String
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeOfBackup String
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeUpdated String
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    backupSourceType string
    Possible deployment backup source types.
    backupType string
    Possible Deployment backup types.
    bucket string
    Name of the bucket where the object is to be uploaded in the object storage
    compartmentId string
    (Updatable) The OCID of the compartment being referenced.
    definedTags {[key: string]: string}
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    deploymentId string
    The OCID of the deployment being referenced.
    deploymentType string
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    displayName string
    An object's Display Name.
    freeformTags {[key: string]: string}
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isAutomatic boolean
    True if this object is automatically created
    isLockOverride boolean
    isMetadataOnly boolean
    Parameter to allow users to create backup without trails
    lifecycleDetails string
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    locks DeploymentBackupLock[]
    Locks associated with this resource.
    namespace string
    Name of namespace that serves as a container for all of your buckets
    object string

    Name of the object to be uploaded to object storage

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

    oggVersion string
    Version of OGG
    sizeInBytes number
    The size of the backup stored in object storage (in bytes)
    state string
    Possible lifecycle states.
    systemTags {[key: string]: string}
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    timeBackupFinished string
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeCreated string
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeOfBackup string
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeUpdated string
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    backup_source_type str
    Possible deployment backup source types.
    backup_type str
    Possible Deployment backup types.
    bucket str
    Name of the bucket where the object is to be uploaded in the object storage
    compartment_id str
    (Updatable) The OCID of the compartment being referenced.
    defined_tags Mapping[str, str]
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    deployment_id str
    The OCID of the deployment being referenced.
    deployment_type str
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    display_name str
    An object's Display Name.
    freeform_tags Mapping[str, str]
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    is_automatic bool
    True if this object is automatically created
    is_lock_override bool
    is_metadata_only bool
    Parameter to allow users to create backup without trails
    lifecycle_details str
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    locks Sequence[DeploymentBackupLockArgs]
    Locks associated with this resource.
    namespace str
    Name of namespace that serves as a container for all of your buckets
    object str

    Name of the object to be uploaded to object storage

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

    ogg_version str
    Version of OGG
    size_in_bytes float
    The size of the backup stored in object storage (in bytes)
    state str
    Possible lifecycle states.
    system_tags Mapping[str, str]
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    time_backup_finished str
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    time_created str
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    time_of_backup str
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    time_updated str
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    backupSourceType String
    Possible deployment backup source types.
    backupType String
    Possible Deployment backup types.
    bucket String
    Name of the bucket where the object is to be uploaded in the object storage
    compartmentId String
    (Updatable) The OCID of the compartment being referenced.
    definedTags Map<String>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    deploymentId String
    The OCID of the deployment being referenced.
    deploymentType String
    The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
    displayName String
    An object's Display Name.
    freeformTags Map<String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isAutomatic Boolean
    True if this object is automatically created
    isLockOverride Boolean
    isMetadataOnly Boolean
    Parameter to allow users to create backup without trails
    lifecycleDetails String
    Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
    locks List<Property Map>
    Locks associated with this resource.
    namespace String
    Name of namespace that serves as a container for all of your buckets
    object String

    Name of the object to be uploaded to object storage

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

    oggVersion String
    Version of OGG
    sizeInBytes Number
    The size of the backup stored in object storage (in bytes)
    state String
    Possible lifecycle states.
    systemTags Map<String>
    The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    timeBackupFinished String
    The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeCreated String
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeOfBackup String
    The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    timeUpdated String
    The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

    Supporting Types

    DeploymentBackupLock, DeploymentBackupLockArgs

    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 time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    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 time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    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 time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    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 time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    type str
    Type of the lock.
    message str
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    related_resource_id str
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    time_created str
    The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    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 time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

    Import

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

    $ pulumi import oci:GoldenGate/deploymentBackup:DeploymentBackup test_deployment_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.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci