1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GoldenGate
  5. getDeploymentBackups
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.GoldenGate.getDeploymentBackups

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

This data source provides the list of Deployment Backups in Oracle Cloud Infrastructure Golden Gate service.

Lists the Backups in a compartment.

Example Usage

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

const testDeploymentBackups = oci.GoldenGate.getDeploymentBackups({
    compartmentId: compartmentId,
    deploymentId: testDeployment.id,
    displayName: deploymentBackupDisplayName,
    state: deploymentBackupState,
});
Copy
import pulumi
import pulumi_oci as oci

test_deployment_backups = oci.GoldenGate.get_deployment_backups(compartment_id=compartment_id,
    deployment_id=test_deployment["id"],
    display_name=deployment_backup_display_name,
    state=deployment_backup_state)
Copy
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.GetDeploymentBackups(ctx, &goldengate.GetDeploymentBackupsArgs{
			CompartmentId: compartmentId,
			DeploymentId:  pulumi.StringRef(testDeployment.Id),
			DisplayName:   pulumi.StringRef(deploymentBackupDisplayName),
			State:         pulumi.StringRef(deploymentBackupState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDeploymentBackups = Oci.GoldenGate.GetDeploymentBackups.Invoke(new()
    {
        CompartmentId = compartmentId,
        DeploymentId = testDeployment.Id,
        DisplayName = deploymentBackupDisplayName,
        State = deploymentBackupState,
    });

});
Copy
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.GetDeploymentBackupsArgs;
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 testDeploymentBackups = GoldenGateFunctions.getDeploymentBackups(GetDeploymentBackupsArgs.builder()
            .compartmentId(compartmentId)
            .deploymentId(testDeployment.id())
            .displayName(deploymentBackupDisplayName)
            .state(deploymentBackupState)
            .build());

    }
}
Copy
variables:
  testDeploymentBackups:
    fn::invoke:
      function: oci:GoldenGate:getDeploymentBackups
      arguments:
        compartmentId: ${compartmentId}
        deploymentId: ${testDeployment.id}
        displayName: ${deploymentBackupDisplayName}
        state: ${deploymentBackupState}
Copy

Using getDeploymentBackups

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 getDeploymentBackups(args: GetDeploymentBackupsArgs, opts?: InvokeOptions): Promise<GetDeploymentBackupsResult>
function getDeploymentBackupsOutput(args: GetDeploymentBackupsOutputArgs, opts?: InvokeOptions): Output<GetDeploymentBackupsResult>
Copy
def get_deployment_backups(compartment_id: Optional[str] = None,
                           deployment_id: Optional[str] = None,
                           display_name: Optional[str] = None,
                           filters: Optional[Sequence[_goldengate.GetDeploymentBackupsFilter]] = None,
                           state: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetDeploymentBackupsResult
def get_deployment_backups_output(compartment_id: Optional[pulumi.Input[str]] = None,
                           deployment_id: Optional[pulumi.Input[str]] = None,
                           display_name: Optional[pulumi.Input[str]] = None,
                           filters: Optional[pulumi.Input[Sequence[pulumi.Input[_goldengate.GetDeploymentBackupsFilterArgs]]]] = None,
                           state: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentBackupsResult]
Copy
func GetDeploymentBackups(ctx *Context, args *GetDeploymentBackupsArgs, opts ...InvokeOption) (*GetDeploymentBackupsResult, error)
func GetDeploymentBackupsOutput(ctx *Context, args *GetDeploymentBackupsOutputArgs, opts ...InvokeOption) GetDeploymentBackupsResultOutput
Copy

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

public static class GetDeploymentBackups 
{
    public static Task<GetDeploymentBackupsResult> InvokeAsync(GetDeploymentBackupsArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentBackupsResult> Invoke(GetDeploymentBackupsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDeploymentBackupsResult> getDeploymentBackups(GetDeploymentBackupsArgs args, InvokeOptions options)
public static Output<GetDeploymentBackupsResult> getDeploymentBackups(GetDeploymentBackupsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:GoldenGate/getDeploymentBackups:getDeploymentBackups
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
DeploymentId string
The OCID of the deployment in which to list resources.
DisplayName string
A filter to return only the resources that match the entire 'displayName' given.
Filters Changes to this property will trigger replacement. List<GetDeploymentBackupsFilter>
State string
A filter to return only the resources that match the 'lifecycleState' given.
CompartmentId This property is required. string
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
DeploymentId string
The OCID of the deployment in which to list resources.
DisplayName string
A filter to return only the resources that match the entire 'displayName' given.
Filters Changes to this property will trigger replacement. []GetDeploymentBackupsFilter
State string
A filter to return only the resources that match the 'lifecycleState' given.
compartmentId This property is required. String
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
deploymentId String
The OCID of the deployment in which to list resources.
displayName String
A filter to return only the resources that match the entire 'displayName' given.
filters Changes to this property will trigger replacement. List<GetDeploymentBackupsFilter>
state String
A filter to return only the resources that match the 'lifecycleState' given.
compartmentId This property is required. string
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
deploymentId string
The OCID of the deployment in which to list resources.
displayName string
A filter to return only the resources that match the entire 'displayName' given.
filters Changes to this property will trigger replacement. GetDeploymentBackupsFilter[]
state string
A filter to return only the resources that match the 'lifecycleState' given.
compartment_id This property is required. str
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
deployment_id str
The OCID of the deployment in which to list resources.
display_name str
A filter to return only the resources that match the entire 'displayName' given.
filters Changes to this property will trigger replacement. Sequence[goldengate.GetDeploymentBackupsFilter]
state str
A filter to return only the resources that match the 'lifecycleState' given.
compartmentId This property is required. String
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
deploymentId String
The OCID of the deployment in which to list resources.
displayName String
A filter to return only the resources that match the entire 'displayName' given.
filters Changes to this property will trigger replacement. List<Property Map>
state String
A filter to return only the resources that match the 'lifecycleState' given.

getDeploymentBackups Result

The following output properties are available:

CompartmentId string
The OCID of the compartment being referenced.
DeploymentBackupCollections List<GetDeploymentBackupsDeploymentBackupCollection>
The list of deployment_backup_collection.
Id string
The provider-assigned unique ID for this managed resource.
DeploymentId string
The OCID of the deployment being referenced.
DisplayName string
An object's Display Name.
Filters List<GetDeploymentBackupsFilter>
State string
Possible lifecycle states.
CompartmentId string
The OCID of the compartment being referenced.
DeploymentBackupCollections []GetDeploymentBackupsDeploymentBackupCollection
The list of deployment_backup_collection.
Id string
The provider-assigned unique ID for this managed resource.
DeploymentId string
The OCID of the deployment being referenced.
DisplayName string
An object's Display Name.
Filters []GetDeploymentBackupsFilter
State string
Possible lifecycle states.
compartmentId String
The OCID of the compartment being referenced.
deploymentBackupCollections List<GetDeploymentBackupsDeploymentBackupCollection>
The list of deployment_backup_collection.
id String
The provider-assigned unique ID for this managed resource.
deploymentId String
The OCID of the deployment being referenced.
displayName String
An object's Display Name.
filters List<GetDeploymentBackupsFilter>
state String
Possible lifecycle states.
compartmentId string
The OCID of the compartment being referenced.
deploymentBackupCollections GetDeploymentBackupsDeploymentBackupCollection[]
The list of deployment_backup_collection.
id string
The provider-assigned unique ID for this managed resource.
deploymentId string
The OCID of the deployment being referenced.
displayName string
An object's Display Name.
filters GetDeploymentBackupsFilter[]
state string
Possible lifecycle states.
compartment_id str
The OCID of the compartment being referenced.
deployment_backup_collections Sequence[goldengate.GetDeploymentBackupsDeploymentBackupCollection]
The list of deployment_backup_collection.
id str
The provider-assigned unique ID for this managed resource.
deployment_id str
The OCID of the deployment being referenced.
display_name str
An object's Display Name.
filters Sequence[goldengate.GetDeploymentBackupsFilter]
state str
Possible lifecycle states.
compartmentId String
The OCID of the compartment being referenced.
deploymentBackupCollections List<Property Map>
The list of deployment_backup_collection.
id String
The provider-assigned unique ID for this managed resource.
deploymentId String
The OCID of the deployment being referenced.
displayName String
An object's Display Name.
filters List<Property Map>
state String
Possible lifecycle states.

Supporting Types

GetDeploymentBackupsDeploymentBackupCollection

items This property is required. List<Property Map>

GetDeploymentBackupsDeploymentBackupCollectionItem

BackupSourceType This property is required. string
Possible deployment backup source types.
BackupType This property is required. string
Possible Deployment backup types.
Bucket This property is required. string
Name of the bucket where the object is to be uploaded in the object storage
CompartmentId This property is required. string
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
DefinedTags This property is required. Dictionary<string, string>
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentId This property is required. string
The OCID of the deployment in which to list resources.
DeploymentType This property is required. 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 This property is required. string
A filter to return only the resources that match the entire 'displayName' given.
FreeformTags This property is required. 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 This property is required. string
The OCID of the backup being referenced.
IsAutomatic This property is required. bool
True if this object is automatically created
IsLockOverride This property is required. bool
IsMetadataOnly This property is required. bool
Parameter to allow users to create backup without trails
LifecycleDetails This property is required. 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 This property is required. List<GetDeploymentBackupsDeploymentBackupCollectionItemLock>
Locks associated with this resource.
Namespace This property is required. string
Name of namespace that serves as a container for all of your buckets
Object This property is required. string
Name of the object to be uploaded to object storage
OggVersion This property is required. string
Version of OGG
SizeInBytes This property is required. double
The size of the backup stored in object storage (in bytes)
State This property is required. string
A filter to return only the resources that match the 'lifecycleState' given.
SystemTags This property is required. 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 This property is required. string
The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeCreated This property is required. string
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOfBackup This property is required. string
The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpdated This property is required. string
The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
BackupSourceType This property is required. string
Possible deployment backup source types.
BackupType This property is required. string
Possible Deployment backup types.
Bucket This property is required. string
Name of the bucket where the object is to be uploaded in the object storage
CompartmentId This property is required. string
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
DefinedTags This property is required. map[string]string
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentId This property is required. string
The OCID of the deployment in which to list resources.
DeploymentType This property is required. 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 This property is required. string
A filter to return only the resources that match the entire 'displayName' given.
FreeformTags This property is required. 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 This property is required. string
The OCID of the backup being referenced.
IsAutomatic This property is required. bool
True if this object is automatically created
IsLockOverride This property is required. bool
IsMetadataOnly This property is required. bool
Parameter to allow users to create backup without trails
LifecycleDetails This property is required. 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 This property is required. []GetDeploymentBackupsDeploymentBackupCollectionItemLock
Locks associated with this resource.
Namespace This property is required. string
Name of namespace that serves as a container for all of your buckets
Object This property is required. string
Name of the object to be uploaded to object storage
OggVersion This property is required. string
Version of OGG
SizeInBytes This property is required. float64
The size of the backup stored in object storage (in bytes)
State This property is required. string
A filter to return only the resources that match the 'lifecycleState' given.
SystemTags This property is required. 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 This property is required. string
The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeCreated This property is required. string
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOfBackup This property is required. string
The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpdated This property is required. string
The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
backupSourceType This property is required. String
Possible deployment backup source types.
backupType This property is required. String
Possible Deployment backup types.
bucket This property is required. String
Name of the bucket where the object is to be uploaded in the object storage
compartmentId This property is required. String
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
definedTags This property is required. Map<String,String>
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentId This property is required. String
The OCID of the deployment in which to list resources.
deploymentType This property is required. 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 This property is required. String
A filter to return only the resources that match the entire 'displayName' given.
freeformTags This property is required. 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 This property is required. String
The OCID of the backup being referenced.
isAutomatic This property is required. Boolean
True if this object is automatically created
isLockOverride This property is required. Boolean
isMetadataOnly This property is required. Boolean
Parameter to allow users to create backup without trails
lifecycleDetails This property is required. 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 This property is required. List<GetDeploymentBackupsDeploymentBackupCollectionItemLock>
Locks associated with this resource.
namespace This property is required. String
Name of namespace that serves as a container for all of your buckets
object This property is required. String
Name of the object to be uploaded to object storage
oggVersion This property is required. String
Version of OGG
sizeInBytes This property is required. Double
The size of the backup stored in object storage (in bytes)
state This property is required. String
A filter to return only the resources that match the 'lifecycleState' given.
systemTags This property is required. 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 This property is required. String
The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeCreated This property is required. String
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOfBackup This property is required. String
The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpdated This property is required. String
The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
backupSourceType This property is required. string
Possible deployment backup source types.
backupType This property is required. string
Possible Deployment backup types.
bucket This property is required. string
Name of the bucket where the object is to be uploaded in the object storage
compartmentId This property is required. string
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
definedTags This property is required. {[key: string]: string}
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentId This property is required. string
The OCID of the deployment in which to list resources.
deploymentType This property is required. 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 This property is required. string
A filter to return only the resources that match the entire 'displayName' given.
freeformTags This property is required. {[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 This property is required. string
The OCID of the backup being referenced.
isAutomatic This property is required. boolean
True if this object is automatically created
isLockOverride This property is required. boolean
isMetadataOnly This property is required. boolean
Parameter to allow users to create backup without trails
lifecycleDetails This property is required. 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 This property is required. GetDeploymentBackupsDeploymentBackupCollectionItemLock[]
Locks associated with this resource.
namespace This property is required. string
Name of namespace that serves as a container for all of your buckets
object This property is required. string
Name of the object to be uploaded to object storage
oggVersion This property is required. string
Version of OGG
sizeInBytes This property is required. number
The size of the backup stored in object storage (in bytes)
state This property is required. string
A filter to return only the resources that match the 'lifecycleState' given.
systemTags This property is required. {[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 This property is required. string
The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeCreated This property is required. string
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOfBackup This property is required. string
The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpdated This property is required. 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 This property is required. str
Possible deployment backup source types.
backup_type This property is required. str
Possible Deployment backup types.
bucket This property is required. str
Name of the bucket where the object is to be uploaded in the object storage
compartment_id This property is required. str
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
defined_tags This property is required. Mapping[str, str]
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deployment_id This property is required. str
The OCID of the deployment in which to list resources.
deployment_type This property is required. 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 This property is required. str
A filter to return only the resources that match the entire 'displayName' given.
freeform_tags This property is required. 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 This property is required. str
The OCID of the backup being referenced.
is_automatic This property is required. bool
True if this object is automatically created
is_lock_override This property is required. bool
is_metadata_only This property is required. bool
Parameter to allow users to create backup without trails
lifecycle_details This property is required. 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 This property is required. Sequence[goldengate.GetDeploymentBackupsDeploymentBackupCollectionItemLock]
Locks associated with this resource.
namespace This property is required. str
Name of namespace that serves as a container for all of your buckets
object This property is required. str
Name of the object to be uploaded to object storage
ogg_version This property is required. str
Version of OGG
size_in_bytes This property is required. float
The size of the backup stored in object storage (in bytes)
state This property is required. str
A filter to return only the resources that match the 'lifecycleState' given.
system_tags This property is required. 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 This property is required. str
The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_created This property is required. str
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_of_backup This property is required. str
The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_updated This property is required. str
The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
backupSourceType This property is required. String
Possible deployment backup source types.
backupType This property is required. String
Possible Deployment backup types.
bucket This property is required. String
Name of the bucket where the object is to be uploaded in the object storage
compartmentId This property is required. String
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
definedTags This property is required. Map<String>
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentId This property is required. String
The OCID of the deployment in which to list resources.
deploymentType This property is required. 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 This property is required. String
A filter to return only the resources that match the entire 'displayName' given.
freeformTags This property is required. 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 This property is required. String
The OCID of the backup being referenced.
isAutomatic This property is required. Boolean
True if this object is automatically created
isLockOverride This property is required. Boolean
isMetadataOnly This property is required. Boolean
Parameter to allow users to create backup without trails
lifecycleDetails This property is required. 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 This property is required. List<Property Map>
Locks associated with this resource.
namespace This property is required. String
Name of namespace that serves as a container for all of your buckets
object This property is required. String
Name of the object to be uploaded to object storage
oggVersion This property is required. String
Version of OGG
sizeInBytes This property is required. Number
The size of the backup stored in object storage (in bytes)
state This property is required. String
A filter to return only the resources that match the 'lifecycleState' given.
systemTags This property is required. 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 This property is required. String
The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeCreated This property is required. String
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOfBackup This property is required. String
The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpdated This property is required. String
The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

GetDeploymentBackupsDeploymentBackupCollectionItemLock

Message This property is required. 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 This property is required. string
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated This property is required. string
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
Type This property is required. string
Type of the lock.
Message This property is required. 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 This property is required. string
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated This property is required. string
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
Type This property is required. string
Type of the lock.
message This property is required. 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 This property is required. String
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated This property is required. String
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type This property is required. String
Type of the lock.
message This property is required. 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 This property is required. string
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated This property is required. string
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type This property is required. string
Type of the lock.
message This property is required. 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 This property is required. str
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created This property is required. str
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type This property is required. str
Type of the lock.
message This property is required. 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 This property is required. String
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated This property is required. String
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type This property is required. String
Type of the lock.

GetDeploymentBackupsFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

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.31.0 published on Thursday, Apr 17, 2025 by Pulumi