Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.GoldenGate.getDeploymentBackups

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

Lists the Backups in a compartment.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testDeploymentBackups = Oci.GoldenGate.GetDeploymentBackups.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        DeploymentId = oci_golden_gate_deployment.Test_deployment.Id,
        DisplayName = @var.Deployment_backup_display_name,
        State = @var.Deployment_backup_state,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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: _var.Compartment_id,
			DeploymentId:  pulumi.StringRef(oci_golden_gate_deployment.Test_deployment.Id),
			DisplayName:   pulumi.StringRef(_var.Deployment_backup_display_name),
			State:         pulumi.StringRef(_var.Deployment_backup_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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(var_.compartment_id())
            .deploymentId(oci_golden_gate_deployment.test_deployment().id())
            .displayName(var_.deployment_backup_display_name())
            .state(var_.deployment_backup_state())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_deployment_backups = oci.GoldenGate.get_deployment_backups(compartment_id=var["compartment_id"],
    deployment_id=oci_golden_gate_deployment["test_deployment"]["id"],
    display_name=var["deployment_backup_display_name"],
    state=var["deployment_backup_state"])

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

const testDeploymentBackups = oci.GoldenGate.getDeploymentBackups({
    compartmentId: _var.compartment_id,
    deploymentId: oci_golden_gate_deployment.test_deployment.id,
    displayName: _var.deployment_backup_display_name,
    state: _var.deployment_backup_state,
});

variables:
  testDeploymentBackups:
    fn::invoke:
      Function: oci:GoldenGate:getDeploymentBackups
      Arguments:
        compartmentId: ${var.compartment_id}
        deploymentId: ${oci_golden_gate_deployment.test_deployment.id}
        displayName: ${var.deployment_backup_display_name}
        state: ${var.deployment_backup_state}

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>

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]

func GetDeploymentBackups(ctx *Context, args *GetDeploymentBackupsArgs, opts ...InvokeOption) (*GetDeploymentBackupsResult, error)
func GetDeploymentBackupsOutput(ctx *Context, args *GetDeploymentBackupsOutputArgs, opts ...InvokeOption) GetDeploymentBackupsResultOutput

> 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)
}

public static CompletableFuture<GetDeploymentBackupsResult> getDeploymentBackups(GetDeploymentBackupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

CompartmentId 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 List<GetDeploymentBackupsFilter>
State string: A filter to return only the resources that match the 'lifecycleState' given.

CompartmentId 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 []GetDeploymentBackupsFilter
State string: A filter to return only the resources that match the 'lifecycleState' given.

compartmentId 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 List<GetDeploymentBackupsFilter>
state String: A filter to return only the resources that match the 'lifecycleState' given.

compartmentId 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 GetDeploymentBackupsFilter[]
state string: A filter to return only the resources that match the 'lifecycleState' given.

compartment_id 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 GetDeploymentBackupsFilter]
state str: A filter to return only the resources that match the 'lifecycleState' given.

compartmentId 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 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 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 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 List<GetDeploymentBackupsDeploymentBackupCollectionItem>

Items []GetDeploymentBackupsDeploymentBackupCollectionItem

items List<GetDeploymentBackupsDeploymentBackupCollectionItem>

items GetDeploymentBackupsDeploymentBackupCollectionItem[]

items GetDeploymentBackupsDeploymentBackupCollectionItem]

items List<Property Map>

GetDeploymentBackupsDeploymentBackupCollectionItem

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 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 Dictionary<string, object>: 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 in which to list resources.
DisplayName string: A filter to return only the resources that match the entire 'displayName' given.
FreeformTags Dictionary<string, object>: 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
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.
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: A filter to return only the resources that match the 'lifecycleState' given.
SystemTags Dictionary<string, object>: 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.

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 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 map[string]interface{}: 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 in which to list resources.
DisplayName string: A filter to return only the resources that match the entire 'displayName' given.
FreeformTags map[string]interface{}: 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
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.
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: A filter to return only the resources that match the 'lifecycleState' given.
SystemTags map[string]interface{}: 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.

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 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 Map<String,Object>: 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 in which to list resources.
displayName String: A filter to return only the resources that match the entire 'displayName' given.
freeformTags Map<String,Object>: 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
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.
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: A filter to return only the resources that match the 'lifecycleState' given.
systemTags Map<String,Object>: 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.

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 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 {[key: string]: any}: 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 in which to list resources.
displayName string: A filter to return only the resources that match the entire 'displayName' given.
freeformTags {[key: string]: any}: 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
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.
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: A filter to return only the resources that match the 'lifecycleState' given.
systemTags {[key: string]: any}: 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_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 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 Mapping[str, Any]: 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 in which to list resources.
display_name str: A filter to return only the resources that match the entire 'displayName' given.
freeform_tags Mapping[str, Any]: 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
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.
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: A filter to return only the resources that match the 'lifecycleState' given.
system_tags Mapping[str, Any]: 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.

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 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 Map<Any>: 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 in which to list resources.
displayName String: A filter to return only the resources that match the entire 'displayName' given.
freeformTags Map<Any>: 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
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.
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: A filter to return only the resources that match the 'lifecycleState' given.
systemTags Map<Any>: 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.

GetDeploymentBackupsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values 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.