Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.GoldenGate.getDeploymentBackup

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

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

const testDeploymentBackup = oci.GoldenGate.getDeploymentBackup({
    deploymentBackupId: testDeploymentBackupOciGoldenGateDeploymentBackup.id,
});

import pulumi
import pulumi_oci as oci

test_deployment_backup = oci.GoldenGate.get_deployment_backup(deployment_backup_id=test_deployment_backup_oci_golden_gate_deployment_backup["id"])

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.GetDeploymentBackup(ctx, &goldengate.GetDeploymentBackupArgs{
			DeploymentBackupId: testDeploymentBackupOciGoldenGateDeploymentBackup.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testDeploymentBackup = Oci.GoldenGate.GetDeploymentBackup.Invoke(new()
    {
        DeploymentBackupId = testDeploymentBackupOciGoldenGateDeploymentBackup.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GoldenGate.GoldenGateFunctions;
import com.pulumi.oci.GoldenGate.inputs.GetDeploymentBackupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var testDeploymentBackup = GoldenGateFunctions.getDeploymentBackup(GetDeploymentBackupArgs.builder()
            .deploymentBackupId(testDeploymentBackupOciGoldenGateDeploymentBackup.id())
            .build());

    }
}

variables:
  testDeploymentBackup:
    fn::invoke:
      function: oci:GoldenGate:getDeploymentBackup
      arguments:
        deploymentBackupId: ${testDeploymentBackupOciGoldenGateDeploymentBackup.id}

Using getDeploymentBackup

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

function getDeploymentBackup(args: GetDeploymentBackupArgs, opts?: InvokeOptions): Promise<GetDeploymentBackupResult>
function getDeploymentBackupOutput(args: GetDeploymentBackupOutputArgs, opts?: InvokeOptions): Output<GetDeploymentBackupResult>

def get_deployment_backup(deployment_backup_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDeploymentBackupResult
def get_deployment_backup_output(deployment_backup_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentBackupResult]

func LookupDeploymentBackup(ctx *Context, args *LookupDeploymentBackupArgs, opts ...InvokeOption) (*LookupDeploymentBackupResult, error)
func LookupDeploymentBackupOutput(ctx *Context, args *LookupDeploymentBackupOutputArgs, opts ...InvokeOption) LookupDeploymentBackupResultOutput

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

public static class GetDeploymentBackup 
{
    public static Task<GetDeploymentBackupResult> InvokeAsync(GetDeploymentBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentBackupResult> Invoke(GetDeploymentBackupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDeploymentBackupResult> getDeploymentBackup(GetDeploymentBackupArgs args, InvokeOptions options)
public static Output<GetDeploymentBackupResult> getDeploymentBackup(GetDeploymentBackupArgs args, InvokeOptions options)

fn::invoke:
  function: oci:GoldenGate/getDeploymentBackup:getDeploymentBackup
  arguments:
    # arguments dictionary

The following arguments are supported:

DeploymentBackupId string: A unique DeploymentBackup identifier.

DeploymentBackupId string: A unique DeploymentBackup identifier.

deploymentBackupId String: A unique DeploymentBackup identifier.

deploymentBackupId string: A unique DeploymentBackup identifier.

deployment_backup_id str: A unique DeploymentBackup identifier.

deploymentBackupId String: A unique DeploymentBackup identifier.

getDeploymentBackup Result

The following output properties are available:

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: The OCID of the compartment being referenced.
DefinedTags Dictionary<string, string>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId string
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>: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The OCID of the backup being referenced.
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<GetDeploymentBackupLock>: 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
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: The OCID of the compartment being referenced.
DefinedTags map[string]string: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId string
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: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The OCID of the backup being referenced.
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 []GetDeploymentBackupLock: 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
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: The OCID of the compartment being referenced.
definedTags Map<String,String>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId String
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>: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The OCID of the backup being referenced.
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<GetDeploymentBackupLock>: 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
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: The OCID of the compartment being referenced.
definedTags {[key: string]: string}: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId string
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}: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: The OCID of the backup being referenced.
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 GetDeploymentBackupLock[]: 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
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: The OCID of the compartment being referenced.
defined_tags Mapping[str, str]: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deployment_backup_id str
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]: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: The OCID of the backup being referenced.
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[GetDeploymentBackupLock]: 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
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: The OCID of the compartment being referenced.
definedTags Map<String>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId String
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>: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The OCID of the backup being referenced.
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
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

GetDeploymentBackupLock

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 string: Type of the lock.

message str: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
related_resource_id str: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created str: The 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 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.

Package Details

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

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.GoldenGate.getDeploymentBackup

On this page

On this page

Example Usage

Using getDeploymentBackup

getDeploymentBackup Result

Supporting Types

GetDeploymentBackupLock

Package Details

On this page

On this page