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

oci.Database.getKeyStores

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 Key Stores in Oracle Cloud Infrastructure Database service.

    Gets a list of key stores in the specified compartment.

    Example Usage

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

const testKeyStores = oci.Database.getKeyStores({
    compartmentId: compartmentId,
});

    import pulumi
import pulumi_oci as oci

test_key_stores = oci.Database.get_key_stores(compartment_id=compartment_id)

    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.GetKeyStores(ctx, &database.GetKeyStoresArgs{
			CompartmentId: compartmentId,
		}, 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 testKeyStores = Oci.Database.GetKeyStores.Invoke(new()
    {
        CompartmentId = compartmentId,
    });

});

    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.GetKeyStoresArgs;
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 testKeyStores = DatabaseFunctions.getKeyStores(GetKeyStoresArgs.builder()
            .compartmentId(compartmentId)
            .build());

    }
}

    variables:
  testKeyStores:
    fn::invoke:
      function: oci:Database:getKeyStores
      arguments:
        compartmentId: ${compartmentId}

    Using getKeyStores

    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 getKeyStores(args: GetKeyStoresArgs, opts?: InvokeOptions): Promise<GetKeyStoresResult>
function getKeyStoresOutput(args: GetKeyStoresOutputArgs, opts?: InvokeOptions): Output<GetKeyStoresResult>
    def get_key_stores(compartment_id: Optional[str] = None,
                   filters: Optional[Sequence[GetKeyStoresFilter]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetKeyStoresResult
def get_key_stores_output(compartment_id: Optional[pulumi.Input[str]] = None,
                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetKeyStoresFilterArgs]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetKeyStoresResult]
    func GetKeyStores(ctx *Context, args *GetKeyStoresArgs, opts ...InvokeOption) (*GetKeyStoresResult, error)
func GetKeyStoresOutput(ctx *Context, args *GetKeyStoresOutputArgs, opts ...InvokeOption) GetKeyStoresResultOutput

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

    public static class GetKeyStores 
{
    public static Task<GetKeyStoresResult> InvokeAsync(GetKeyStoresArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyStoresResult> Invoke(GetKeyStoresInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKeyStoresResult> getKeyStores(GetKeyStoresArgs args, InvokeOptions options)
public static Output<GetKeyStoresResult> getKeyStores(GetKeyStoresArgs args, InvokeOptions options)

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

    The following arguments are supported:

    getKeyStores Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyStores List<GetKeyStoresKeyStore>
    The list of key_stores.
    Filters List<GetKeyStoresFilter>
    CompartmentId string
    The OCID of the compartment.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyStores []GetKeyStoresKeyStore
    The list of key_stores.
    Filters []GetKeyStoresFilter
    compartmentId String
    The OCID of the compartment.
    id String
    The provider-assigned unique ID for this managed resource.
    keyStores List<GetKeyStoresKeyStore>
    The list of key_stores.
    filters List<GetKeyStoresFilter>
    compartmentId string
    The OCID of the compartment.
    id string
    The provider-assigned unique ID for this managed resource.
    keyStores GetKeyStoresKeyStore[]
    The list of key_stores.
    filters GetKeyStoresFilter[]
    compartment_id str
    The OCID of the compartment.
    id str
    The provider-assigned unique ID for this managed resource.
    key_stores Sequence[GetKeyStoresKeyStore]
    The list of key_stores.
    filters Sequence[GetKeyStoresFilter]
    compartmentId String
    The OCID of the compartment.
    id String
    The provider-assigned unique ID for this managed resource.
    keyStores List<Property Map>
    The list of key_stores.
    filters List<Property Map>

    Supporting Types

    GetKeyStoresFilter

    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

    GetKeyStoresKeyStore

    AssociatedDatabases List<GetKeyStoresKeyStoreAssociatedDatabase>
    List of databases associated with the key store.
    CompartmentId string
    The compartment OCID.
    ConfirmDetailsTrigger int
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    DisplayName string
    The user-friendly name for the key store. The name does not need to be unique.
    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 key store.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    State string
    The current state of the key store.
    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 key store was created.
    TypeDetails List<GetKeyStoresKeyStoreTypeDetail>
    Key store type details.
    AssociatedDatabases []GetKeyStoresKeyStoreAssociatedDatabase
    List of databases associated with the key store.
    CompartmentId string
    The compartment OCID.
    ConfirmDetailsTrigger int
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    DisplayName string
    The user-friendly name for the key store. The name does not need to be unique.
    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 key store.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    State string
    The current state of the key store.
    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 key store was created.
    TypeDetails []GetKeyStoresKeyStoreTypeDetail
    Key store type details.
    associatedDatabases List<GetKeyStoresKeyStoreAssociated>
    List of databases associated with the key store.
    compartmentId String
    The compartment OCID.
    confirmDetailsTrigger Integer
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    displayName String
    The user-friendly name for the key store. The name does not need to be unique.
    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 key store.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    state String
    The current state of the key store.
    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 key store was created.
    typeDetails List<GetKeyStoresKeyStoreTypeDetail>
    Key store type details.
    associatedDatabases GetKeyStoresKeyStoreAssociatedDatabase[]
    List of databases associated with the key store.
    compartmentId string
    The compartment OCID.
    confirmDetailsTrigger number
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    displayName string
    The user-friendly name for the key store. The name does not need to be unique.
    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 key store.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    state string
    The current state of the key store.
    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 key store was created.
    typeDetails GetKeyStoresKeyStoreTypeDetail[]
    Key store type details.
    associated_databases Sequence[GetKeyStoresKeyStoreAssociatedDatabase]
    List of databases associated with the key store.
    compartment_id str
    The compartment OCID.
    confirm_details_trigger int
    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.
    display_name str
    The user-friendly name for the key store. The name does not need to be unique.
    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 key store.
    lifecycle_details str
    Additional information about the current lifecycle state.
    state str
    The current state of the key store.
    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 key store was created.
    type_details Sequence[GetKeyStoresKeyStoreTypeDetail]
    Key store type details.
    associatedDatabases List<Property Map>
    List of databases associated with the key store.
    compartmentId String
    The compartment OCID.
    confirmDetailsTrigger Number
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    displayName String
    The user-friendly name for the key store. The name does not need to be unique.
    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 key store.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    state String
    The current state of the key store.
    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 key store was created.
    typeDetails List<Property Map>
    Key store type details.

    GetKeyStoresKeyStoreAssociatedDatabase

    DbName string
    The name of the database that is associated with the key store.
    DbUniqueName string
    The unique name of the database that is associated with the key store.
    Id string
    The OCID of the key store.
    DbName string
    The name of the database that is associated with the key store.
    DbUniqueName string
    The unique name of the database that is associated with the key store.
    Id string
    The OCID of the key store.
    dbName String
    The name of the database that is associated with the key store.
    dbUniqueName String
    The unique name of the database that is associated with the key store.
    id String
    The OCID of the key store.
    dbName string
    The name of the database that is associated with the key store.
    dbUniqueName string
    The unique name of the database that is associated with the key store.
    id string
    The OCID of the key store.
    db_name str
    The name of the database that is associated with the key store.
    db_unique_name str
    The unique name of the database that is associated with the key store.
    id str
    The OCID of the key store.
    dbName String
    The name of the database that is associated with the key store.
    dbUniqueName String
    The unique name of the database that is associated with the key store.
    id String
    The OCID of the key store.

    GetKeyStoresKeyStoreTypeDetail

    AdminUsername string
    The administrator username to connect to Oracle Key Vault
    ConnectionIps List<string>
    The list of Oracle Key Vault connection IP addresses.
    SecretId string
    The OCID of the Oracle Cloud Infrastructure secret.
    Type string
    The type of key store.
    VaultId string
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    AdminUsername string
    The administrator username to connect to Oracle Key Vault
    ConnectionIps []string
    The list of Oracle Key Vault connection IP addresses.
    SecretId string
    The OCID of the Oracle Cloud Infrastructure secret.
    Type string
    The type of key store.
    VaultId string
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    adminUsername String
    The administrator username to connect to Oracle Key Vault
    connectionIps List<String>
    The list of Oracle Key Vault connection IP addresses.
    secretId String
    The OCID of the Oracle Cloud Infrastructure secret.
    type String
    The type of key store.
    vaultId String
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    adminUsername string
    The administrator username to connect to Oracle Key Vault
    connectionIps string[]
    The list of Oracle Key Vault connection IP addresses.
    secretId string
    The OCID of the Oracle Cloud Infrastructure secret.
    type string
    The type of key store.
    vaultId string
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    admin_username str
    The administrator username to connect to Oracle Key Vault
    connection_ips Sequence[str]
    The list of Oracle Key Vault connection IP addresses.
    secret_id str
    The OCID of the Oracle Cloud Infrastructure secret.
    type str
    The type of key store.
    vault_id str
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    adminUsername String
    The administrator username to connect to Oracle Key Vault
    connectionIps List<String>
    The list of Oracle Key Vault connection IP addresses.
    secretId String
    The OCID of the Oracle Cloud Infrastructure secret.
    type String
    The type of key store.
    vaultId String
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

    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