Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Nosql
  5. getConfiguration
Oracle Cloud Infrastructure v3.3.0 published on Thursday, Jul 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.Nosql.getConfiguration

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v3.3.0 published on Thursday, Jul 17, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Configuration resource in Oracle Cloud Infrastructure NoSQL Database service.

    Retrieves the current service-level configuration. The service may of the standard MULTI_TENANCY type, or of the HOSTED environment type. In the latter case, information about the current state of the environment’s global encryption key is included in the response.

    Example Usage

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

const testConfiguration = oci.Nosql.getConfiguration({
    compartmentId: compartmentId,
});

    import pulumi
import pulumi_oci as oci

test_configuration = oci.Nosql.get_configuration(compartment_id=compartment_id)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nosql.GetConfiguration(ctx, &nosql.GetConfigurationArgs{
			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 testConfiguration = Oci.Nosql.GetConfiguration.Invoke(new()
    {
        CompartmentId = compartmentId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Nosql.NosqlFunctions;
import com.pulumi.oci.Nosql.inputs.GetConfigurationArgs;
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 testConfiguration = NosqlFunctions.getConfiguration(GetConfigurationArgs.builder()
            .compartmentId(compartmentId)
            .build());

    }
}

    variables:
  testConfiguration:
    fn::invoke:
      function: oci:Nosql:getConfiguration
      arguments:
        compartmentId: ${compartmentId}

    Using getConfiguration

    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 getConfiguration(args: GetConfigurationArgs, opts?: InvokeOptions): Promise<GetConfigurationResult>
function getConfigurationOutput(args: GetConfigurationOutputArgs, opts?: InvokeOptions): Output<GetConfigurationResult>
    def get_configuration(compartment_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetConfigurationResult
def get_configuration_output(compartment_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetConfigurationResult]
    func LookupConfiguration(ctx *Context, args *LookupConfigurationArgs, opts ...InvokeOption) (*LookupConfigurationResult, error)
func LookupConfigurationOutput(ctx *Context, args *LookupConfigurationOutputArgs, opts ...InvokeOption) LookupConfigurationResultOutput

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

    public static class GetConfiguration 
{
    public static Task<GetConfigurationResult> InvokeAsync(GetConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigurationResult> Invoke(GetConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetConfigurationResult> getConfiguration(GetConfigurationArgs args, InvokeOptions options)
public static Output<GetConfigurationResult> getConfiguration(GetConfigurationArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:Nosql/getConfiguration:getConfiguration
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The ID of a table's compartment.
    CompartmentId string
    The ID of a table's compartment.
    compartmentId String
    The ID of a table's compartment.
    compartmentId string
    The ID of a table's compartment.
    compartment_id str
    The ID of a table's compartment.
    compartmentId String
    The ID of a table's compartment.

    getConfiguration Result

    The following output properties are available:

    CompartmentId string
    Environment string
    The service environment type.
    Id string
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    IsOpcDryRun bool
    KmsKeys List<GetConfigurationKmsKey>
    Information about the state of the service's encryption key management. The following properties are read-only and ignored when this object is used in UpdateConfiguration: kmsKeyState, timeCreated, timeUpdated.
    CompartmentId string
    Environment string
    The service environment type.
    Id string
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    IsOpcDryRun bool
    KmsKeys []GetConfigurationKmsKey
    Information about the state of the service's encryption key management. The following properties are read-only and ignored when this object is used in UpdateConfiguration: kmsKeyState, timeCreated, timeUpdated.
    compartmentId String
    environment String
    The service environment type.
    id String
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    isOpcDryRun Boolean
    kmsKeys List<GetConfigurationKmsKey>
    Information about the state of the service's encryption key management. The following properties are read-only and ignored when this object is used in UpdateConfiguration: kmsKeyState, timeCreated, timeUpdated.
    compartmentId string
    environment string
    The service environment type.
    id string
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    isOpcDryRun boolean
    kmsKeys GetConfigurationKmsKey[]
    Information about the state of the service's encryption key management. The following properties are read-only and ignored when this object is used in UpdateConfiguration: kmsKeyState, timeCreated, timeUpdated.
    compartment_id str
    environment str
    The service environment type.
    id str
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    is_opc_dry_run bool
    kms_keys Sequence[GetConfigurationKmsKey]
    Information about the state of the service's encryption key management. The following properties are read-only and ignored when this object is used in UpdateConfiguration: kmsKeyState, timeCreated, timeUpdated.
    compartmentId String
    environment String
    The service environment type.
    id String
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    isOpcDryRun Boolean
    kmsKeys List<Property Map>
    Information about the state of the service's encryption key management. The following properties are read-only and ignored when this object is used in UpdateConfiguration: kmsKeyState, timeCreated, timeUpdated.

    Supporting Types

    GetConfigurationKmsKey

    Id string
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    KmsKeyState string
    The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.
    KmsVaultId string
    The OCID of the vault containing the encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the kmsVaultId will be a null string.
    TimeCreated string
    The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    TimeUpdated string
    The timestamp of the last update to the encryption key status. RFC3339 formatted.
    Id string
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    KmsKeyState string
    The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.
    KmsVaultId string
    The OCID of the vault containing the encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the kmsVaultId will be a null string.
    TimeCreated string
    The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    TimeUpdated string
    The timestamp of the last update to the encryption key status. RFC3339 formatted.
    id String
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    kmsKeyState String
    The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.
    kmsVaultId String
    The OCID of the vault containing the encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the kmsVaultId will be a null string.
    timeCreated String
    The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    timeUpdated String
    The timestamp of the last update to the encryption key status. RFC3339 formatted.
    id string
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    kmsKeyState string
    The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.
    kmsVaultId string
    The OCID of the vault containing the encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the kmsVaultId will be a null string.
    timeCreated string
    The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    timeUpdated string
    The timestamp of the last update to the encryption key status. RFC3339 formatted.
    id str
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    kms_key_state str
    The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.
    kms_vault_id str
    The OCID of the vault containing the encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the kmsVaultId will be a null string.
    time_created str
    The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    time_updated str
    The timestamp of the last update to the encryption key status. RFC3339 formatted.
    id String
    The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string.
    kmsKeyState String
    The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.
    kmsVaultId String
    The OCID of the vault containing the encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the kmsVaultId will be a null string.
    timeCreated String
    The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    timeUpdated String
    The timestamp of the last update to the encryption key status. RFC3339 formatted.

    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.3.0 published on Thursday, Jul 17, 2025 by Pulumi
    pulumi/pulumi-oci