1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. getKeyStores
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.Database.getKeyStores

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

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,
});
Copy
import pulumi
import pulumi_oci as oci

test_key_stores = oci.Database.get_key_stores(compartment_id=compartment_id)
Copy
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.GetKeyStores(ctx, &database.GetKeyStoresArgs{
			CompartmentId: compartmentId,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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,
    });

});
Copy
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());

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

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>
Copy
def get_key_stores(compartment_id: Optional[str] = None,
                   filters: Optional[Sequence[_database.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[_database.GetKeyStoresFilterArgs]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetKeyStoresResult]
Copy
func GetKeyStores(ctx *Context, args *GetKeyStoresArgs, opts ...InvokeOption) (*GetKeyStoresResult, error)
func GetKeyStoresOutput(ctx *Context, args *GetKeyStoresOutputArgs, opts ...InvokeOption) GetKeyStoresResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetKeyStoresResult> getKeyStores(GetKeyStoresArgs args, InvokeOptions options)
public static Output<GetKeyStoresResult> getKeyStores(GetKeyStoresArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Database/getKeyStores:getKeyStores
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The compartment OCID.
Filters Changes to this property will trigger replacement. List<GetKeyStoresFilter>
CompartmentId This property is required. string
The compartment OCID.
Filters Changes to this property will trigger replacement. []GetKeyStoresFilter
compartmentId This property is required. String
The compartment OCID.
filters Changes to this property will trigger replacement. List<GetKeyStoresFilter>
compartmentId This property is required. string
The compartment OCID.
filters Changes to this property will trigger replacement. GetKeyStoresFilter[]
compartment_id This property is required. str
The compartment OCID.
filters Changes to this property will trigger replacement. Sequence[database.GetKeyStoresFilter]
compartmentId This property is required. String
The compartment OCID.
filters Changes to this property will trigger replacement. List<Property Map>

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[database.GetKeyStoresKeyStore]
The list of key_stores.
filters Sequence[database.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 This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

GetKeyStoresKeyStore

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

GetKeyStoresKeyStoreAssociatedDatabase

DbName This property is required. string
The name of the database that is associated with the key store.
Id This property is required. string
The OCID of the key store.
DbName This property is required. string
The name of the database that is associated with the key store.
Id This property is required. string
The OCID of the key store.
dbName This property is required. String
The name of the database that is associated with the key store.
id This property is required. String
The OCID of the key store.
dbName This property is required. string
The name of the database that is associated with the key store.
id This property is required. string
The OCID of the key store.
db_name This property is required. str
The name of the database that is associated with the key store.
id This property is required. str
The OCID of the key store.
dbName This property is required. String
The name of the database that is associated with the key store.
id This property is required. String
The OCID of the key store.

GetKeyStoresKeyStoreTypeDetail

AdminUsername This property is required. string
The administrator username to connect to Oracle Key Vault
ConnectionIps This property is required. List<string>
The list of Oracle Key Vault connection IP addresses.
SecretId This property is required. string
The OCID of the Oracle Cloud Infrastructure secret.
Type This property is required. string
The type of key store.
VaultId This property is required. string
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
AdminUsername This property is required. string
The administrator username to connect to Oracle Key Vault
ConnectionIps This property is required. []string
The list of Oracle Key Vault connection IP addresses.
SecretId This property is required. string
The OCID of the Oracle Cloud Infrastructure secret.
Type This property is required. string
The type of key store.
VaultId This property is required. string
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
adminUsername This property is required. String
The administrator username to connect to Oracle Key Vault
connectionIps This property is required. List<String>
The list of Oracle Key Vault connection IP addresses.
secretId This property is required. String
The OCID of the Oracle Cloud Infrastructure secret.
type This property is required. String
The type of key store.
vaultId This property is required. String
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
adminUsername This property is required. string
The administrator username to connect to Oracle Key Vault
connectionIps This property is required. string[]
The list of Oracle Key Vault connection IP addresses.
secretId This property is required. string
The OCID of the Oracle Cloud Infrastructure secret.
type This property is required. string
The type of key store.
vaultId This property is required. string
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
admin_username This property is required. str
The administrator username to connect to Oracle Key Vault
connection_ips This property is required. Sequence[str]
The list of Oracle Key Vault connection IP addresses.
secret_id This property is required. str
The OCID of the Oracle Cloud Infrastructure secret.
type This property is required. str
The type of key store.
vault_id This property is required. str
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
adminUsername This property is required. String
The administrator username to connect to Oracle Key Vault
connectionIps This property is required. List<String>
The list of Oracle Key Vault connection IP addresses.
secretId This property is required. String
The OCID of the Oracle Cloud Infrastructure secret.
type This property is required. String
The type of key store.
vaultId This property is required. 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.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi