oci.Database.getKeyStore (v3)

Oracle Cloud Infrastructure v3.16.0 (3.x), Mar 9 26

Viewing docs for Oracle Cloud Infrastructure v3.16.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-oci

Viewing docs for Oracle Cloud Infrastructure v3.16.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-oci

Example Usage

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

const testKeyStore = oci.Database.getKeyStore({
    keyStoreId: testKeyStoreOciDatabaseKeyStore.id,
});

import pulumi
import pulumi_oci as oci

test_key_store = oci.Database.get_key_store(key_store_id=test_key_store_oci_database_key_store["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.GetKeyStore(ctx, &database.GetKeyStoreArgs{
			KeyStoreId: testKeyStoreOciDatabaseKeyStore.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testKeyStore = Oci.Database.GetKeyStore.Invoke(new()
    {
        KeyStoreId = testKeyStoreOciDatabaseKeyStore.Id,
    });

});

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.GetKeyStoreArgs;
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 testKeyStore = DatabaseFunctions.getKeyStore(GetKeyStoreArgs.builder()
            .keyStoreId(testKeyStoreOciDatabaseKeyStore.id())
            .build());

    }
}

variables:
  testKeyStore:
    fn::invoke:
      function: oci:Database:getKeyStore
      arguments:
        keyStoreId: ${testKeyStoreOciDatabaseKeyStore.id}

Using getKeyStore

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 getKeyStore(args: GetKeyStoreArgs, opts?: InvokeOptions): Promise<GetKeyStoreResult>
function getKeyStoreOutput(args: GetKeyStoreOutputArgs, opts?: InvokeOptions): Output<GetKeyStoreResult>

def get_key_store(key_store_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetKeyStoreResult
def get_key_store_output(key_store_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetKeyStoreResult]

func LookupKeyStore(ctx *Context, args *LookupKeyStoreArgs, opts ...InvokeOption) (*LookupKeyStoreResult, error)
func LookupKeyStoreOutput(ctx *Context, args *LookupKeyStoreOutputArgs, opts ...InvokeOption) LookupKeyStoreResultOutput

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

public static class GetKeyStore 
{
    public static Task<GetKeyStoreResult> InvokeAsync(GetKeyStoreArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyStoreResult> Invoke(GetKeyStoreInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKeyStoreResult> getKeyStore(GetKeyStoreArgs args, InvokeOptions options)
public static Output<GetKeyStoreResult> getKeyStore(GetKeyStoreArgs args, InvokeOptions options)

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

The following arguments are supported:

KeyStoreId string: The OCID of the key store.

KeyStoreId string: The OCID of the key store.

keyStoreId String: The OCID of the key store.

keyStoreId string: The OCID of the key store.

key_store_id str: The OCID of the key store.

keyStoreId String: The OCID of the key store.

getKeyStore Result

The following output properties are available:

AssociatedDatabases List<GetKeyStoreAssociatedDatabase>: List of databases associated with the key store.
AssociatedLongTermBackupCount int: Indicates the number of long term backups of Autonomous Databases associated with this backup destination.
AssociatedLongTermBackups List<GetKeyStoreAssociatedLongTermBackup>: List of long term backups of Autonomous Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024.
CompartmentId string: The OCID of the compartment.
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.
KeyStoreId string
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<GetKeyStoreTypeDetail>: Key store type details.

AssociatedDatabases []GetKeyStoreAssociatedDatabase: List of databases associated with the key store.
AssociatedLongTermBackupCount int: Indicates the number of long term backups of Autonomous Databases associated with this backup destination.
AssociatedLongTermBackups []GetKeyStoreAssociatedLongTermBackup: List of long term backups of Autonomous Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024.
CompartmentId string: The OCID of the compartment.
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.
KeyStoreId string
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 []GetKeyStoreTypeDetail: Key store type details.

associatedDatabases List<GetKeyStoreAssociated>: List of databases associated with the key store.
associatedLongTermBackupCount Integer: Indicates the number of long term backups of Autonomous Databases associated with this backup destination.
associatedLongTermBackups List<GetKeyStoreAssociatedLongTermBackup>: List of long term backups of Autonomous Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024.
compartmentId String: The OCID of the compartment.
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.
keyStoreId String
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<GetKeyStoreTypeDetail>: Key store type details.

associatedDatabases GetKeyStoreAssociatedDatabase[]: List of databases associated with the key store.
associatedLongTermBackupCount number: Indicates the number of long term backups of Autonomous Databases associated with this backup destination.
associatedLongTermBackups GetKeyStoreAssociatedLongTermBackup[]: List of long term backups of Autonomous Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024.
compartmentId string: The OCID of the compartment.
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.
keyStoreId string
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 GetKeyStoreTypeDetail[]: Key store type details.

associated_databases Sequence[GetKeyStoreAssociatedDatabase]: List of databases associated with the key store.
associated_long_term_backup_count int: Indicates the number of long term backups of Autonomous Databases associated with this backup destination.
associated_long_term_backups Sequence[GetKeyStoreAssociatedLongTermBackup]: List of long term backups of Autonomous Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024.
compartment_id str: The OCID of the compartment.
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.
key_store_id str
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[GetKeyStoreTypeDetail]: Key store type details.

associatedDatabases List<Property Map>: List of databases associated with the key store.
associatedLongTermBackupCount Number: Indicates the number of long term backups of Autonomous Databases associated with this backup destination.
associatedLongTermBackups List<Property Map>: List of long term backups of Autonomous Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024.
compartmentId String: The OCID of the compartment.
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.
keyStoreId String
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.

Supporting Types

GetKeyStoreAssociatedDatabase

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.

GetKeyStoreAssociatedLongTermBackup

DisplayName string: The user-friendly name for the key store. The name does not need to be unique.
Id string: The OCID of the key store.

DisplayName string: The user-friendly name for the key store. The name does not need to be unique.
Id string: The OCID of the key store.

displayName String: The user-friendly name for the key store. The name does not need to be unique.
id String: The OCID of the key store.

displayName string: The user-friendly name for the key store. The name does not need to be unique.
id string: The OCID of the key store.

display_name str: The user-friendly name for the key store. The name does not need to be unique.
id str: The OCID of the key store.

displayName String: The user-friendly name for the key store. The name does not need to be unique.
id String: The OCID of the key store.

GetKeyStoreTypeDetail

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.