Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
oci.Database.getKeyStore
Explore with Pulumi AI
This data source provides details about a specific Key Store resource in Oracle Cloud Infrastructure Database service.
Gets information about the specified key store.
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/v2/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 GetKeyStore(ctx *Context, args *GetKeyStoreArgs, opts ...InvokeOption) (*GetKeyStoreResult, error)
func GetKeyStoreOutput(ctx *Context, args *GetKeyStoreOutputArgs, opts ...InvokeOption) GetKeyStoreResultOutput> Note: This function is named GetKeyStore 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 dictionaryThe following arguments are supported:
- KeyStore stringId 
- The OCID of the key store.
- KeyStore stringId 
- The OCID of the key store.
- keyStore StringId 
- The OCID of the key store.
- keyStore stringId 
- The OCID of the key store.
- key_store_ strid 
- The OCID of the key store.
- keyStore StringId 
- The OCID of the key store.
getKeyStore Result
The following output properties are available:
- AssociatedDatabases List<GetKey Store Associated Database> 
- List of databases associated with the key store.
- CompartmentId string
- The OCID of the compartment.
- ConfirmDetails intTrigger 
- 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.
- 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.
- KeyStore stringId 
- LifecycleDetails string
- Additional information about the current lifecycle state.
- State string
- The current state of the key store.
- TimeCreated string
- The date and time that the key store was created.
- TypeDetails List<GetKey Store Type Detail> 
- Key store type details.
- AssociatedDatabases []GetKey Store Associated Database 
- List of databases associated with the key store.
- CompartmentId string
- The OCID of the compartment.
- ConfirmDetails intTrigger 
- 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.
- 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.
- KeyStore stringId 
- LifecycleDetails string
- Additional information about the current lifecycle state.
- State string
- The current state of the key store.
- TimeCreated string
- The date and time that the key store was created.
- TypeDetails []GetKey Store Type Detail 
- Key store type details.
- associatedDatabases List<GetKey Store Associated> 
- List of databases associated with the key store.
- compartmentId String
- The OCID of the compartment.
- confirmDetails IntegerTrigger 
- 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.
- 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.
- keyStore StringId 
- lifecycleDetails String
- Additional information about the current lifecycle state.
- state String
- The current state of the key store.
- timeCreated String
- The date and time that the key store was created.
- typeDetails List<GetKey Store Type Detail> 
- Key store type details.
- associatedDatabases GetKey Store Associated Database[] 
- List of databases associated with the key store.
- compartmentId string
- The OCID of the compartment.
- confirmDetails numberTrigger 
- {[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.
- {[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.
- keyStore stringId 
- lifecycleDetails string
- Additional information about the current lifecycle state.
- state string
- The current state of the key store.
- timeCreated string
- The date and time that the key store was created.
- typeDetails GetKey Store Type Detail[] 
- Key store type details.
- associated_databases Sequence[database.Get Key Store Associated Database] 
- List of databases associated with the key store.
- compartment_id str
- The OCID of the compartment.
- confirm_details_ inttrigger 
- 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.
- 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_ strid 
- lifecycle_details str
- Additional information about the current lifecycle state.
- state str
- The current state of the key store.
- time_created str
- The date and time that the key store was created.
- type_details Sequence[database.Get Key Store Type Detail] 
- Key store type details.
- associatedDatabases List<Property Map>
- List of databases associated with the key store.
- compartmentId String
- The OCID of the compartment.
- confirmDetails NumberTrigger 
- 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.
- 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.
- keyStore StringId 
- lifecycleDetails String
- Additional information about the current lifecycle state.
- state String
- The current state of the key store.
- timeCreated String
- The date and time that the key store was created.
- typeDetails List<Property Map>
- Key store type details.
Supporting Types
GetKeyStoreAssociatedDatabase    
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 secretIdare 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 secretIdare 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 secretIdare 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 secretIdare 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 secretIdare 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 secretIdare required for Customer Managed Keys.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.