1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. getPluggableDatabaseSnapshots
Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
pulumi/pulumi-oci

oci.Database.getPluggableDatabaseSnapshots

Get Started
oci logo
Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Pluggable Database Snapshots in Oracle Cloud Infrastructure Database service.

    Gets a list of the Exadata Pluggable Database Snapshots in the specified compartment.

    Example Usage

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

const testPluggableDatabaseSnapshots = oci.Database.getPluggableDatabaseSnapshots({
    clusterId: testCluster.id,
    compartmentId: compartmentId,
    name: pluggableDatabaseSnapshotName,
    pluggableDatabaseId: testPluggableDatabase.id,
    state: pluggableDatabaseSnapshotState,
});

    import pulumi
import pulumi_oci as oci

test_pluggable_database_snapshots = oci.Database.get_pluggable_database_snapshots(cluster_id=test_cluster["id"],
    compartment_id=compartment_id,
    name=pluggable_database_snapshot_name,
    pluggable_database_id=test_pluggable_database["id"],
    state=pluggable_database_snapshot_state)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := database.GetPluggableDatabaseSnapshots(ctx, &database.GetPluggableDatabaseSnapshotsArgs{
			ClusterId:           pulumi.StringRef(testCluster.Id),
			CompartmentId:       pulumi.StringRef(compartmentId),
			Name:                pulumi.StringRef(pluggableDatabaseSnapshotName),
			PluggableDatabaseId: pulumi.StringRef(testPluggableDatabase.Id),
			State:               pulumi.StringRef(pluggableDatabaseSnapshotState),
		}, 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 testPluggableDatabaseSnapshots = Oci.Database.GetPluggableDatabaseSnapshots.Invoke(new()
    {
        ClusterId = testCluster.Id,
        CompartmentId = compartmentId,
        Name = pluggableDatabaseSnapshotName,
        PluggableDatabaseId = testPluggableDatabase.Id,
        State = pluggableDatabaseSnapshotState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DatabaseFunctions;
import com.pulumi.oci.Database.inputs.GetPluggableDatabaseSnapshotsArgs;
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 testPluggableDatabaseSnapshots = DatabaseFunctions.getPluggableDatabaseSnapshots(GetPluggableDatabaseSnapshotsArgs.builder()
            .clusterId(testCluster.id())
            .compartmentId(compartmentId)
            .name(pluggableDatabaseSnapshotName)
            .pluggableDatabaseId(testPluggableDatabase.id())
            .state(pluggableDatabaseSnapshotState)
            .build());

    }
}

    variables:
  testPluggableDatabaseSnapshots:
    fn::invoke:
      function: oci:Database:getPluggableDatabaseSnapshots
      arguments:
        clusterId: ${testCluster.id}
        compartmentId: ${compartmentId}
        name: ${pluggableDatabaseSnapshotName}
        pluggableDatabaseId: ${testPluggableDatabase.id}
        state: ${pluggableDatabaseSnapshotState}

    Using getPluggableDatabaseSnapshots

    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 getPluggableDatabaseSnapshots(args: GetPluggableDatabaseSnapshotsArgs, opts?: InvokeOptions): Promise<GetPluggableDatabaseSnapshotsResult>
function getPluggableDatabaseSnapshotsOutput(args: GetPluggableDatabaseSnapshotsOutputArgs, opts?: InvokeOptions): Output<GetPluggableDatabaseSnapshotsResult>
    def get_pluggable_database_snapshots(cluster_id: Optional[str] = None,
                                     compartment_id: Optional[str] = None,
                                     filters: Optional[Sequence[GetPluggableDatabaseSnapshotsFilter]] = None,
                                     name: Optional[str] = None,
                                     pluggable_database_id: Optional[str] = None,
                                     state: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetPluggableDatabaseSnapshotsResult
def get_pluggable_database_snapshots_output(cluster_id: Optional[pulumi.Input[str]] = None,
                                     compartment_id: Optional[pulumi.Input[str]] = None,
                                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetPluggableDatabaseSnapshotsFilterArgs]]]] = None,
                                     name: Optional[pulumi.Input[str]] = None,
                                     pluggable_database_id: Optional[pulumi.Input[str]] = None,
                                     state: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetPluggableDatabaseSnapshotsResult]
    func GetPluggableDatabaseSnapshots(ctx *Context, args *GetPluggableDatabaseSnapshotsArgs, opts ...InvokeOption) (*GetPluggableDatabaseSnapshotsResult, error)
func GetPluggableDatabaseSnapshotsOutput(ctx *Context, args *GetPluggableDatabaseSnapshotsOutputArgs, opts ...InvokeOption) GetPluggableDatabaseSnapshotsResultOutput

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

    public static class GetPluggableDatabaseSnapshots 
{
    public static Task<GetPluggableDatabaseSnapshotsResult> InvokeAsync(GetPluggableDatabaseSnapshotsArgs args, InvokeOptions? opts = null)
    public static Output<GetPluggableDatabaseSnapshotsResult> Invoke(GetPluggableDatabaseSnapshotsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPluggableDatabaseSnapshotsResult> getPluggableDatabaseSnapshots(GetPluggableDatabaseSnapshotsArgs args, InvokeOptions options)
public static Output<GetPluggableDatabaseSnapshotsResult> getPluggableDatabaseSnapshots(GetPluggableDatabaseSnapshotsArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:Database/getPluggableDatabaseSnapshots:getPluggableDatabaseSnapshots
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    CompartmentId string
    The compartment OCID.
    Filters List<GetPluggableDatabaseSnapshotsFilter>
    Name string
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    PluggableDatabaseId string
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    State string
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
    ClusterId string
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    CompartmentId string
    The compartment OCID.
    Filters []GetPluggableDatabaseSnapshotsFilter
    Name string
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    PluggableDatabaseId string
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    State string
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
    clusterId String
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    compartmentId String
    The compartment OCID.
    filters List<GetPluggableSnapshotsFilter>
    name String
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    pluggableDatabaseId String
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    state String
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
    clusterId string
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    compartmentId string
    The compartment OCID.
    filters GetPluggableDatabaseSnapshotsFilter[]
    name string
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    pluggableDatabaseId string
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    state string
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
    cluster_id str
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    compartment_id str
    The compartment OCID.
    filters Sequence[GetPluggableDatabaseSnapshotsFilter]
    name str
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    pluggable_database_id str
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    state str
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
    clusterId String
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    compartmentId String
    The compartment OCID.
    filters List<Property Map>
    name String
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    pluggableDatabaseId String
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    state String
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.

    getPluggableDatabaseSnapshots Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    PluggableDatabaseSnapshots List<GetPluggableDatabaseSnapshotsPluggableDatabaseSnapshot>
    The list of pluggable_database_snapshots.
    ClusterId string
    The OCID of the VM cluster.
    CompartmentId string
    The OCID of the compartment.
    Filters List<GetPluggableDatabaseSnapshotsFilter>
    Name string
    The user-friendly name for the Database Snapshot. The name should be unique.
    PluggableDatabaseId string
    The OCID of the Exadata Pluggable Database.
    State string
    The current state of the Exadata Pluggable Database Snapshot.
    Id string
    The provider-assigned unique ID for this managed resource.
    PluggableDatabaseSnapshots []GetPluggableDatabaseSnapshotsPluggableDatabaseSnapshot
    The list of pluggable_database_snapshots.
    ClusterId string
    The OCID of the VM cluster.
    CompartmentId string
    The OCID of the compartment.
    Filters []GetPluggableDatabaseSnapshotsFilter
    Name string
    The user-friendly name for the Database Snapshot. The name should be unique.
    PluggableDatabaseId string
    The OCID of the Exadata Pluggable Database.
    State string
    The current state of the Exadata Pluggable Database Snapshot.
    id String
    The provider-assigned unique ID for this managed resource.
    pluggableDatabaseSnapshots List<GetPluggableSnapshotsPluggableSnapshot>
    The list of pluggable_database_snapshots.
    clusterId String
    The OCID of the VM cluster.
    compartmentId String
    The OCID of the compartment.
    filters List<GetPluggableSnapshotsFilter>
    name String
    The user-friendly name for the Database Snapshot. The name should be unique.
    pluggableDatabaseId String
    The OCID of the Exadata Pluggable Database.
    state String
    The current state of the Exadata Pluggable Database Snapshot.
    id string
    The provider-assigned unique ID for this managed resource.
    pluggableDatabaseSnapshots GetPluggableDatabaseSnapshotsPluggableDatabaseSnapshot[]
    The list of pluggable_database_snapshots.
    clusterId string
    The OCID of the VM cluster.
    compartmentId string
    The OCID of the compartment.
    filters GetPluggableDatabaseSnapshotsFilter[]
    name string
    The user-friendly name for the Database Snapshot. The name should be unique.
    pluggableDatabaseId string
    The OCID of the Exadata Pluggable Database.
    state string
    The current state of the Exadata Pluggable Database Snapshot.
    id str
    The provider-assigned unique ID for this managed resource.
    pluggable_database_snapshots Sequence[GetPluggableDatabaseSnapshotsPluggableDatabaseSnapshot]
    The list of pluggable_database_snapshots.
    cluster_id str
    The OCID of the VM cluster.
    compartment_id str
    The OCID of the compartment.
    filters Sequence[GetPluggableDatabaseSnapshotsFilter]
    name str
    The user-friendly name for the Database Snapshot. The name should be unique.
    pluggable_database_id str
    The OCID of the Exadata Pluggable Database.
    state str
    The current state of the Exadata Pluggable Database Snapshot.
    id String
    The provider-assigned unique ID for this managed resource.
    pluggableDatabaseSnapshots List<Property Map>
    The list of pluggable_database_snapshots.
    clusterId String
    The OCID of the VM cluster.
    compartmentId String
    The OCID of the compartment.
    filters List<Property Map>
    name String
    The user-friendly name for the Database Snapshot. The name should be unique.
    pluggableDatabaseId String
    The OCID of the Exadata Pluggable Database.
    state String
    The current state of the Exadata Pluggable Database Snapshot.

    Supporting Types

    GetPluggableDatabaseSnapshotsFilter

    Name string
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    Values List<string>
    Regex bool
    Name string
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    Values []string
    Regex bool
    name String
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    values List<String>
    regex Boolean
    name string
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    values string[]
    regex boolean
    name str
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    values Sequence[str]
    regex bool
    name String
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    values List<String>
    regex Boolean

    GetPluggableDatabaseSnapshotsPluggableDatabaseSnapshot

    ClusterId string
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    CompartmentId string
    The compartment OCID.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the Exadata Pluggable Database Snapshot.
    LifecycleDetails string
    Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot.
    Name string
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    PluggableDatabaseId string
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    State string
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    TimeCreated string
    The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z
    ClusterId string
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    CompartmentId string
    The compartment OCID.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the Exadata Pluggable Database Snapshot.
    LifecycleDetails string
    Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot.
    Name string
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    PluggableDatabaseId string
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    State string
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    TimeCreated string
    The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z
    clusterId String
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    compartmentId String
    The compartment OCID.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the Exadata Pluggable Database Snapshot.
    lifecycleDetails String
    Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot.
    name String
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    pluggableDatabaseId String
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    state String
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    timeCreated String
    The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z
    clusterId string
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    compartmentId string
    The compartment OCID.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the Exadata Pluggable Database Snapshot.
    lifecycleDetails string
    Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot.
    name string
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    pluggableDatabaseId string
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    state string
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    timeCreated string
    The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z
    cluster_id str
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    compartment_id str
    The compartment OCID.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the Exadata Pluggable Database Snapshot.
    lifecycle_details str
    Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot.
    name str
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    pluggable_database_id str
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    state str
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    time_created str
    The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z
    clusterId String
    A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
    compartmentId String
    The compartment OCID.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the Exadata Pluggable Database Snapshot.
    lifecycleDetails String
    Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot.
    name String
    A filter to return only resources that match the entire name given. The match is not case sensitive.
    pluggableDatabaseId String
    A filter to return only Exadata Pluggable Database Snapshots that match the given database OCID.
    state String
    A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    timeCreated String
    The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z

    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 v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
    pulumi/pulumi-oci
      Meet Neo: Your AI Platform Teammate