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

oci.Nosql.Configuration

Explore with Pulumi AI

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

    This resource provides the Configuration in Oracle Cloud Infrastructure NoSQL Database service.

    Updates the service-level configuration. The discriminator value UpdateConfigurationDetails.environment must match the service’s environment type.

    A configuration serves as a centralized repository for global parameters that affect the NoSQL service. Currently, there is only one such parameter: a customer-provided key for encrypting NoSQL data at rest.

    The Customer-Managed Encryption Keys (CMEK) feature is exclusively available in private NoSQL environments dedicated to a single tenancy, where the CMEK option has been enabled. Updating the configuration of the default, regional, multi-tenancy NoSQL service is not supported.

    To specify the dedicated environment, set the environment variable CLIENT_HOST_OVERRIDES=oci_nosql.NosqlClient=$ENDPOINT Where $ENDPOINT is the endpoint of the dedicated NoSQL environment. For example: $ export CLIENT_HOST_OVERRIDES=oci_nosql.NosqlClient=https://acme-widgets.nosql.oci.oraclecloud.com

    Example Usage

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

const testConfiguration = new oci.nosql.Configuration("test_configuration", {
    compartmentId: compartmentId,
    environment: "HOSTED",
    isOpcDryRun: configurationIsOpcDryRun,
    kmsKey: {
        id: configurationKmsKeyId,
        kmsVaultId: testVault.id,
    },
});

    import pulumi
import pulumi_oci as oci

test_configuration = oci.nosql.Configuration("test_configuration",
    compartment_id=compartment_id,
    environment="HOSTED",
    is_opc_dry_run=configuration_is_opc_dry_run,
    kms_key={
        "id": configuration_kms_key_id,
        "kms_vault_id": test_vault["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.NewConfiguration(ctx, "test_configuration", &nosql.ConfigurationArgs{
			CompartmentId: pulumi.Any(compartmentId),
			Environment:   pulumi.String("HOSTED"),
			IsOpcDryRun:   pulumi.Any(configurationIsOpcDryRun),
			KmsKey: &nosql.ConfigurationKmsKeyArgs{
				Id:         pulumi.Any(configurationKmsKeyId),
				KmsVaultId: pulumi.Any(testVault.Id),
			},
		})
		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 = new Oci.Nosql.Configuration("test_configuration", new()
    {
        CompartmentId = compartmentId,
        Environment = "HOSTED",
        IsOpcDryRun = configurationIsOpcDryRun,
        KmsKey = new Oci.Nosql.Inputs.ConfigurationKmsKeyArgs
        {
            Id = configurationKmsKeyId,
            KmsVaultId = testVault.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Nosql.Configuration;
import com.pulumi.oci.Nosql.ConfigurationArgs;
import com.pulumi.oci.Nosql.inputs.ConfigurationKmsKeyArgs;
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) {
        var testConfiguration = new Configuration("testConfiguration", ConfigurationArgs.builder()
            .compartmentId(compartmentId)
            .environment("HOSTED")
            .isOpcDryRun(configurationIsOpcDryRun)
            .kmsKey(ConfigurationKmsKeyArgs.builder()
                .id(configurationKmsKeyId)
                .kmsVaultId(testVault.id())
                .build())
            .build());

    }
}

    resources:
  testConfiguration:
    type: oci:Nosql:Configuration
    name: test_configuration
    properties:
      compartmentId: ${compartmentId}
      environment: HOSTED
      isOpcDryRun: ${configurationIsOpcDryRun}
      kmsKey:
        id: ${configurationKmsKeyId}
        kmsVaultId: ${testVault.id}

    Create Configuration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Configuration(name: string, args: ConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def Configuration(resource_name: str,
                  args: ConfigurationArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def Configuration(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  compartment_id: Optional[str] = None,
                  environment: Optional[str] = None,
                  is_opc_dry_run: Optional[bool] = None,
                  kms_key: Optional[ConfigurationKmsKeyArgs] = None)
    func NewConfiguration(ctx *Context, name string, args ConfigurationArgs, opts ...ResourceOption) (*Configuration, error)
    public Configuration(string name, ConfigurationArgs args, CustomResourceOptions? opts = null)
    public Configuration(String name, ConfigurationArgs args)
public Configuration(String name, ConfigurationArgs args, CustomResourceOptions options)

    type: oci:Nosql:Configuration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleconfigurationResourceResourceFromNosqlconfiguration = new Oci.Nosql.Configuration("exampleconfigurationResourceResourceFromNosqlconfiguration", new()
{
    CompartmentId = "string",
    Environment = "string",
    IsOpcDryRun = false,
    KmsKey = new Oci.Nosql.Inputs.ConfigurationKmsKeyArgs
    {
        Id = "string",
        KmsKeyState = "string",
        KmsVaultId = "string",
        TimeCreated = "string",
        TimeUpdated = "string",
    },
});

    example, err := nosql.NewConfiguration(ctx, "exampleconfigurationResourceResourceFromNosqlconfiguration", &nosql.ConfigurationArgs{
	CompartmentId: pulumi.String("string"),
	Environment:   pulumi.String("string"),
	IsOpcDryRun:   pulumi.Bool(false),
	KmsKey: &nosql.ConfigurationKmsKeyArgs{
		Id:          pulumi.String("string"),
		KmsKeyState: pulumi.String("string"),
		KmsVaultId:  pulumi.String("string"),
		TimeCreated: pulumi.String("string"),
		TimeUpdated: pulumi.String("string"),
	},
})

    var exampleconfigurationResourceResourceFromNosqlconfiguration = new com.pulumi.oci.Nosql.Configuration("exampleconfigurationResourceResourceFromNosqlconfiguration", com.pulumi.oci.Nosql.ConfigurationArgs.builder()
    .compartmentId("string")
    .environment("string")
    .isOpcDryRun(false)
    .kmsKey(ConfigurationKmsKeyArgs.builder()
        .id("string")
        .kmsKeyState("string")
        .kmsVaultId("string")
        .timeCreated("string")
        .timeUpdated("string")
        .build())
    .build());

    exampleconfiguration_resource_resource_from_nosqlconfiguration = oci.nosql.Configuration("exampleconfigurationResourceResourceFromNosqlconfiguration",
    compartment_id="string",
    environment="string",
    is_opc_dry_run=False,
    kms_key={
        "id": "string",
        "kms_key_state": "string",
        "kms_vault_id": "string",
        "time_created": "string",
        "time_updated": "string",
    })

    const exampleconfigurationResourceResourceFromNosqlconfiguration = new oci.nosql.Configuration("exampleconfigurationResourceResourceFromNosqlconfiguration", {
    compartmentId: "string",
    environment: "string",
    isOpcDryRun: false,
    kmsKey: {
        id: "string",
        kmsKeyState: "string",
        kmsVaultId: "string",
        timeCreated: "string",
        timeUpdated: "string",
    },
});

    type: oci:Nosql:Configuration
properties:
    compartmentId: string
    environment: string
    isOpcDryRun: false
    kmsKey:
        id: string
        kmsKeyState: string
        kmsVaultId: string
        timeCreated: string
        timeUpdated: string

    Configuration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Configuration resource accepts the following input properties:

    CompartmentId string
    (Updatable) The tenancy's OCID
    Environment string
    (Updatable) The service environment type.
    IsOpcDryRun bool
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    KmsKey ConfigurationKmsKey
    (Updatable) 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
    (Updatable) The tenancy's OCID
    Environment string
    (Updatable) The service environment type.
    IsOpcDryRun bool
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    KmsKey ConfigurationKmsKeyArgs
    (Updatable) 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
    (Updatable) The tenancy's OCID
    environment String
    (Updatable) The service environment type.
    isOpcDryRun Boolean
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    kmsKey ConfigurationKmsKey
    (Updatable) 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
    (Updatable) The tenancy's OCID
    environment string
    (Updatable) The service environment type.
    isOpcDryRun boolean
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    kmsKey ConfigurationKmsKey
    (Updatable) 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
    (Updatable) The tenancy's OCID
    environment str
    (Updatable) The service environment type.
    is_opc_dry_run bool
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    kms_key ConfigurationKmsKeyArgs
    (Updatable) 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
    (Updatable) The tenancy's OCID
    environment String
    (Updatable) The service environment type.
    isOpcDryRun Boolean
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    kmsKey Property Map
    (Updatable) 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Configuration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Configuration Resource

    Get an existing Configuration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ConfigurationState, opts?: CustomResourceOptions): Configuration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        environment: Optional[str] = None,
        is_opc_dry_run: Optional[bool] = None,
        kms_key: Optional[ConfigurationKmsKeyArgs] = None) -> Configuration
    func GetConfiguration(ctx *Context, name string, id IDInput, state *ConfigurationState, opts ...ResourceOption) (*Configuration, error)
    public static Configuration Get(string name, Input<string> id, ConfigurationState? state, CustomResourceOptions? opts = null)
    public static Configuration get(String name, Output<String> id, ConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: oci:Nosql:Configuration    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The tenancy's OCID
    Environment string
    (Updatable) The service environment type.
    IsOpcDryRun bool
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    KmsKey ConfigurationKmsKey
    (Updatable) 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
    (Updatable) The tenancy's OCID
    Environment string
    (Updatable) The service environment type.
    IsOpcDryRun bool
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    KmsKey ConfigurationKmsKeyArgs
    (Updatable) 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
    (Updatable) The tenancy's OCID
    environment String
    (Updatable) The service environment type.
    isOpcDryRun Boolean
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    kmsKey ConfigurationKmsKey
    (Updatable) 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
    (Updatable) The tenancy's OCID
    environment string
    (Updatable) The service environment type.
    isOpcDryRun boolean
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    kmsKey ConfigurationKmsKey
    (Updatable) 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
    (Updatable) The tenancy's OCID
    environment str
    (Updatable) The service environment type.
    is_opc_dry_run bool
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    kms_key ConfigurationKmsKeyArgs
    (Updatable) 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
    (Updatable) The tenancy's OCID
    environment String
    (Updatable) The service environment type.
    isOpcDryRun Boolean
    (Updatable) If true, indicates that the request is a dry run. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
    kmsKey Property Map
    (Updatable) 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

    ConfigurationKmsKey, ConfigurationKmsKeyArgs

    Id string
    (Updatable) 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
    (Updatable) The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.
    KmsVaultId string
    (Updatable) 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
    (Updatable) The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    TimeUpdated string

    (Updatable) The timestamp of the last update to the encryption key status. RFC3339 formatted.

    ** IMPORTANT ** The configuration cannot be deleted.

    Id string
    (Updatable) 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
    (Updatable) The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.
    KmsVaultId string
    (Updatable) 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
    (Updatable) The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    TimeUpdated string

    (Updatable) The timestamp of the last update to the encryption key status. RFC3339 formatted.

    ** IMPORTANT ** The configuration cannot be deleted.

    id String
    (Updatable) 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
    (Updatable) The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.
    kmsVaultId String
    (Updatable) 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
    (Updatable) The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    timeUpdated String

    (Updatable) The timestamp of the last update to the encryption key status. RFC3339 formatted.

    ** IMPORTANT ** The configuration cannot be deleted.

    id string
    (Updatable) 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
    (Updatable) The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.
    kmsVaultId string
    (Updatable) 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
    (Updatable) The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    timeUpdated string

    (Updatable) The timestamp of the last update to the encryption key status. RFC3339 formatted.

    ** IMPORTANT ** The configuration cannot be deleted.

    id str
    (Updatable) 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
    (Updatable) 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
    (Updatable) 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
    (Updatable) The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    time_updated str

    (Updatable) The timestamp of the last update to the encryption key status. RFC3339 formatted.

    ** IMPORTANT ** The configuration cannot be deleted.

    id String
    (Updatable) 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
    (Updatable) The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.
    kmsVaultId String
    (Updatable) 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
    (Updatable) The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.
    timeUpdated String

    (Updatable) The timestamp of the last update to the encryption key status. RFC3339 formatted.

    ** IMPORTANT ** The configuration cannot be deleted.

    Import

    Configurations can be imported using the id, e.g.

    $ pulumi import oci:Nosql/configuration:Configuration test_configuration "configuration/compartmentId/{compartmentId}"

    To learn more about importing existing cloud resources, see Importing resources.

    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