1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Psql
  5. Configuration
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

oci.Psql.Configuration

Explore with Pulumi AI

This resource provides the Configuration resource in Oracle Cloud Infrastructure Psql service.

Creates a new configuration.

Example Usage

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

const testConfiguration = new oci.psql.Configuration("test_configuration", {
    compartmentId: compartmentId,
    dbConfigurationOverrides: {
        items: [{
            configKey: configurationDbConfigurationOverridesItemsConfigKey,
            overridenConfigValue: configurationDbConfigurationOverridesItemsOverridenConfigValue,
        }],
    },
    dbVersion: configurationDbVersion,
    displayName: configurationDisplayName,
    shape: configurationShape,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: configurationDescription,
    freeformTags: {
        "bar-key": "value",
    },
    instanceMemorySizeInGbs: configurationInstanceMemorySizeInGbs,
    instanceOcpuCount: configurationInstanceOcpuCount,
    isFlexible: configurationIsFlexible,
    systemTags: configurationSystemTags,
});
Copy
import pulumi
import pulumi_oci as oci

test_configuration = oci.psql.Configuration("test_configuration",
    compartment_id=compartment_id,
    db_configuration_overrides={
        "items": [{
            "config_key": configuration_db_configuration_overrides_items_config_key,
            "overriden_config_value": configuration_db_configuration_overrides_items_overriden_config_value,
        }],
    },
    db_version=configuration_db_version,
    display_name=configuration_display_name,
    shape=configuration_shape,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=configuration_description,
    freeform_tags={
        "bar-key": "value",
    },
    instance_memory_size_in_gbs=configuration_instance_memory_size_in_gbs,
    instance_ocpu_count=configuration_instance_ocpu_count,
    is_flexible=configuration_is_flexible,
    system_tags=configuration_system_tags)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := psql.NewConfiguration(ctx, "test_configuration", &psql.ConfigurationArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DbConfigurationOverrides: &psql.ConfigurationDbConfigurationOverridesArgs{
				Items: psql.ConfigurationDbConfigurationOverridesItemArray{
					&psql.ConfigurationDbConfigurationOverridesItemArgs{
						ConfigKey:            pulumi.Any(configurationDbConfigurationOverridesItemsConfigKey),
						OverridenConfigValue: pulumi.Any(configurationDbConfigurationOverridesItemsOverridenConfigValue),
					},
				},
			},
			DbVersion:   pulumi.Any(configurationDbVersion),
			DisplayName: pulumi.Any(configurationDisplayName),
			Shape:       pulumi.Any(configurationShape),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(configurationDescription),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			InstanceMemorySizeInGbs: pulumi.Any(configurationInstanceMemorySizeInGbs),
			InstanceOcpuCount:       pulumi.Any(configurationInstanceOcpuCount),
			IsFlexible:              pulumi.Any(configurationIsFlexible),
			SystemTags:              pulumi.Any(configurationSystemTags),
		})
		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 testConfiguration = new Oci.Psql.Configuration("test_configuration", new()
    {
        CompartmentId = compartmentId,
        DbConfigurationOverrides = new Oci.Psql.Inputs.ConfigurationDbConfigurationOverridesArgs
        {
            Items = new[]
            {
                new Oci.Psql.Inputs.ConfigurationDbConfigurationOverridesItemArgs
                {
                    ConfigKey = configurationDbConfigurationOverridesItemsConfigKey,
                    OverridenConfigValue = configurationDbConfigurationOverridesItemsOverridenConfigValue,
                },
            },
        },
        DbVersion = configurationDbVersion,
        DisplayName = configurationDisplayName,
        Shape = configurationShape,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = configurationDescription,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        InstanceMemorySizeInGbs = configurationInstanceMemorySizeInGbs,
        InstanceOcpuCount = configurationInstanceOcpuCount,
        IsFlexible = configurationIsFlexible,
        SystemTags = configurationSystemTags,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Psql.Configuration;
import com.pulumi.oci.Psql.ConfigurationArgs;
import com.pulumi.oci.Psql.inputs.ConfigurationDbConfigurationOverridesArgs;
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)
            .dbConfigurationOverrides(ConfigurationDbConfigurationOverridesArgs.builder()
                .items(ConfigurationDbConfigurationOverridesItemArgs.builder()
                    .configKey(configurationDbConfigurationOverridesItemsConfigKey)
                    .overridenConfigValue(configurationDbConfigurationOverridesItemsOverridenConfigValue)
                    .build())
                .build())
            .dbVersion(configurationDbVersion)
            .displayName(configurationDisplayName)
            .shape(configurationShape)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(configurationDescription)
            .freeformTags(Map.of("bar-key", "value"))
            .instanceMemorySizeInGbs(configurationInstanceMemorySizeInGbs)
            .instanceOcpuCount(configurationInstanceOcpuCount)
            .isFlexible(configurationIsFlexible)
            .systemTags(configurationSystemTags)
            .build());

    }
}
Copy
resources:
  testConfiguration:
    type: oci:Psql:Configuration
    name: test_configuration
    properties:
      compartmentId: ${compartmentId}
      dbConfigurationOverrides:
        items:
          - configKey: ${configurationDbConfigurationOverridesItemsConfigKey}
            overridenConfigValue: ${configurationDbConfigurationOverridesItemsOverridenConfigValue}
      dbVersion: ${configurationDbVersion}
      displayName: ${configurationDisplayName}
      shape: ${configurationShape}
      definedTags:
        foo-namespace.bar-key: value
      description: ${configurationDescription}
      freeformTags:
        bar-key: value
      instanceMemorySizeInGbs: ${configurationInstanceMemorySizeInGbs}
      instanceOcpuCount: ${configurationInstanceOcpuCount}
      isFlexible: ${configurationIsFlexible}
      systemTags: ${configurationSystemTags}
Copy

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,
                  db_configuration_overrides: Optional[_psql.ConfigurationDbConfigurationOverridesArgs] = None,
                  db_version: Optional[str] = None,
                  display_name: Optional[str] = None,
                  shape: Optional[str] = None,
                  defined_tags: Optional[Mapping[str, str]] = None,
                  description: Optional[str] = None,
                  freeform_tags: Optional[Mapping[str, str]] = None,
                  instance_memory_size_in_gbs: Optional[int] = None,
                  instance_ocpu_count: Optional[int] = None,
                  is_flexible: Optional[bool] = None,
                  system_tags: Optional[Mapping[str, str]] = 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:Psql:Configuration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 exampleconfigurationResourceResourceFromPsqlconfiguration = new Oci.Psql.Configuration("exampleconfigurationResourceResourceFromPsqlconfiguration", new()
{
    CompartmentId = "string",
    DbConfigurationOverrides = new Oci.Psql.Inputs.ConfigurationDbConfigurationOverridesArgs
    {
        Items = new[]
        {
            new Oci.Psql.Inputs.ConfigurationDbConfigurationOverridesItemArgs
            {
                ConfigKey = "string",
                OverridenConfigValue = "string",
            },
        },
    },
    DbVersion = "string",
    DisplayName = "string",
    Shape = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    InstanceMemorySizeInGbs = 0,
    InstanceOcpuCount = 0,
    IsFlexible = false,
    SystemTags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := psql.NewConfiguration(ctx, "exampleconfigurationResourceResourceFromPsqlconfiguration", &psql.ConfigurationArgs{
	CompartmentId: pulumi.String("string"),
	DbConfigurationOverrides: &psql.ConfigurationDbConfigurationOverridesArgs{
		Items: psql.ConfigurationDbConfigurationOverridesItemArray{
			&psql.ConfigurationDbConfigurationOverridesItemArgs{
				ConfigKey:            pulumi.String("string"),
				OverridenConfigValue: pulumi.String("string"),
			},
		},
	},
	DbVersion:   pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Shape:       pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	InstanceMemorySizeInGbs: pulumi.Int(0),
	InstanceOcpuCount:       pulumi.Int(0),
	IsFlexible:              pulumi.Bool(false),
	SystemTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampleconfigurationResourceResourceFromPsqlconfiguration = new com.pulumi.oci.Psql.Configuration("exampleconfigurationResourceResourceFromPsqlconfiguration", com.pulumi.oci.Psql.ConfigurationArgs.builder()
    .compartmentId("string")
    .dbConfigurationOverrides(ConfigurationDbConfigurationOverridesArgs.builder()
        .items(ConfigurationDbConfigurationOverridesItemArgs.builder()
            .configKey("string")
            .overridenConfigValue("string")
            .build())
        .build())
    .dbVersion("string")
    .displayName("string")
    .shape("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .instanceMemorySizeInGbs(0)
    .instanceOcpuCount(0)
    .isFlexible(false)
    .systemTags(Map.of("string", "string"))
    .build());
Copy
exampleconfiguration_resource_resource_from_psqlconfiguration = oci.psql.Configuration("exampleconfigurationResourceResourceFromPsqlconfiguration",
    compartment_id="string",
    db_configuration_overrides={
        "items": [{
            "config_key": "string",
            "overriden_config_value": "string",
        }],
    },
    db_version="string",
    display_name="string",
    shape="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    freeform_tags={
        "string": "string",
    },
    instance_memory_size_in_gbs=0,
    instance_ocpu_count=0,
    is_flexible=False,
    system_tags={
        "string": "string",
    })
Copy
const exampleconfigurationResourceResourceFromPsqlconfiguration = new oci.psql.Configuration("exampleconfigurationResourceResourceFromPsqlconfiguration", {
    compartmentId: "string",
    dbConfigurationOverrides: {
        items: [{
            configKey: "string",
            overridenConfigValue: "string",
        }],
    },
    dbVersion: "string",
    displayName: "string",
    shape: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    freeformTags: {
        string: "string",
    },
    instanceMemorySizeInGbs: 0,
    instanceOcpuCount: 0,
    isFlexible: false,
    systemTags: {
        string: "string",
    },
});
Copy
type: oci:Psql:Configuration
properties:
    compartmentId: string
    dbConfigurationOverrides:
        items:
            - configKey: string
              overridenConfigValue: string
    dbVersion: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    instanceMemorySizeInGbs: 0
    instanceOcpuCount: 0
    isFlexible: false
    shape: string
    systemTags:
        string: string
Copy

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 This property is required. string
(Updatable) The OCID of the compartment that contains the configuration.
DbConfigurationOverrides
This property is required.
Changes to this property will trigger replacement.
ConfigurationDbConfigurationOverrides
Configuration overrides for a PostgreSQL instance.
DbVersion
This property is required.
Changes to this property will trigger replacement.
string
Version of the PostgreSQL database.
DisplayName This property is required. string
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
Shape
This property is required.
Changes to this property will trigger replacement.
string
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string
(Updatable) Details about the configuration set.
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
InstanceMemorySizeInGbs Changes to this property will trigger replacement. int

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

InstanceOcpuCount Changes to this property will trigger replacement. int

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

IsFlexible Changes to this property will trigger replacement. bool
Whether the configuration supports flexible shapes.
SystemTags Changes to this property will trigger replacement. Dictionary<string, string>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CompartmentId This property is required. string
(Updatable) The OCID of the compartment that contains the configuration.
DbConfigurationOverrides
This property is required.
Changes to this property will trigger replacement.
ConfigurationDbConfigurationOverridesArgs
Configuration overrides for a PostgreSQL instance.
DbVersion
This property is required.
Changes to this property will trigger replacement.
string
Version of the PostgreSQL database.
DisplayName This property is required. string
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
Shape
This property is required.
Changes to this property will trigger replacement.
string
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string
(Updatable) Details about the configuration set.
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
InstanceMemorySizeInGbs Changes to this property will trigger replacement. int

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

InstanceOcpuCount Changes to this property will trigger replacement. int

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

IsFlexible Changes to this property will trigger replacement. bool
Whether the configuration supports flexible shapes.
SystemTags Changes to this property will trigger replacement. map[string]string

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. String
(Updatable) The OCID of the compartment that contains the configuration.
dbConfigurationOverrides
This property is required.
Changes to this property will trigger replacement.
ConfigurationDbConfigurationOverrides
Configuration overrides for a PostgreSQL instance.
dbVersion
This property is required.
Changes to this property will trigger replacement.
String
Version of the PostgreSQL database.
displayName This property is required. String
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
shape
This property is required.
Changes to this property will trigger replacement.
String
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
(Updatable) Details about the configuration set.
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
instanceMemorySizeInGbs Changes to this property will trigger replacement. Integer

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

instanceOcpuCount Changes to this property will trigger replacement. Integer

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

isFlexible Changes to this property will trigger replacement. Boolean
Whether the configuration supports flexible shapes.
systemTags Changes to this property will trigger replacement. Map<String,String>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. string
(Updatable) The OCID of the compartment that contains the configuration.
dbConfigurationOverrides
This property is required.
Changes to this property will trigger replacement.
ConfigurationDbConfigurationOverrides
Configuration overrides for a PostgreSQL instance.
dbVersion
This property is required.
Changes to this property will trigger replacement.
string
Version of the PostgreSQL database.
displayName This property is required. string
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
shape
This property is required.
Changes to this property will trigger replacement.
string
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string
(Updatable) Details about the configuration set.
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
instanceMemorySizeInGbs Changes to this property will trigger replacement. number

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

instanceOcpuCount Changes to this property will trigger replacement. number

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

isFlexible Changes to this property will trigger replacement. boolean
Whether the configuration supports flexible shapes.
systemTags Changes to this property will trigger replacement. {[key: string]: string}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartment_id This property is required. str
(Updatable) The OCID of the compartment that contains the configuration.
db_configuration_overrides
This property is required.
Changes to this property will trigger replacement.
psql.ConfigurationDbConfigurationOverridesArgs
Configuration overrides for a PostgreSQL instance.
db_version
This property is required.
Changes to this property will trigger replacement.
str
Version of the PostgreSQL database.
display_name This property is required. str
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
shape
This property is required.
Changes to this property will trigger replacement.
str
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str
(Updatable) Details about the configuration set.
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
instance_memory_size_in_gbs Changes to this property will trigger replacement. int

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

instance_ocpu_count Changes to this property will trigger replacement. int

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

is_flexible Changes to this property will trigger replacement. bool
Whether the configuration supports flexible shapes.
system_tags Changes to this property will trigger replacement. Mapping[str, str]

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. String
(Updatable) The OCID of the compartment that contains the configuration.
dbConfigurationOverrides
This property is required.
Changes to this property will trigger replacement.
Property Map
Configuration overrides for a PostgreSQL instance.
dbVersion
This property is required.
Changes to this property will trigger replacement.
String
Version of the PostgreSQL database.
displayName This property is required. String
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
shape
This property is required.
Changes to this property will trigger replacement.
String
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
(Updatable) Details about the configuration set.
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
instanceMemorySizeInGbs Changes to this property will trigger replacement. Number

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

instanceOcpuCount Changes to this property will trigger replacement. Number

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

isFlexible Changes to this property will trigger replacement. Boolean
Whether the configuration supports flexible shapes.
systemTags Changes to this property will trigger replacement. Map<String>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Outputs

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

ConfigType string
The type of configuration. Either user-created or a default configuration.
ConfigurationDetails List<ConfigurationConfigurationDetail>
List of configuration details.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
State string
The current state of the configuration.
TimeCreated string
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
ConfigType string
The type of configuration. Either user-created or a default configuration.
ConfigurationDetails []ConfigurationConfigurationDetail
List of configuration details.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
State string
The current state of the configuration.
TimeCreated string
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
configType String
The type of configuration. Either user-created or a default configuration.
configurationDetails List<ConfigurationConfigurationDetail>
List of configuration details.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state String
The current state of the configuration.
timeCreated String
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
configType string
The type of configuration. Either user-created or a default configuration.
configurationDetails ConfigurationConfigurationDetail[]
List of configuration details.
id string
The provider-assigned unique ID for this managed resource.
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state string
The current state of the configuration.
timeCreated string
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
config_type str
The type of configuration. Either user-created or a default configuration.
configuration_details Sequence[psql.ConfigurationConfigurationDetail]
List of configuration details.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state str
The current state of the configuration.
time_created str
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
configType String
The type of configuration. Either user-created or a default configuration.
configurationDetails List<Property Map>
List of configuration details.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state String
The current state of the configuration.
timeCreated String
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

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,
        config_type: Optional[str] = None,
        configuration_details: Optional[Sequence[_psql.ConfigurationConfigurationDetailArgs]] = None,
        db_configuration_overrides: Optional[_psql.ConfigurationDbConfigurationOverridesArgs] = None,
        db_version: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        instance_memory_size_in_gbs: Optional[int] = None,
        instance_ocpu_count: Optional[int] = None,
        is_flexible: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        shape: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = 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:Psql:Configuration    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 OCID of the compartment that contains the configuration.
ConfigType string
The type of configuration. Either user-created or a default configuration.
ConfigurationDetails List<ConfigurationConfigurationDetail>
List of configuration details.
DbConfigurationOverrides Changes to this property will trigger replacement. ConfigurationDbConfigurationOverrides
Configuration overrides for a PostgreSQL instance.
DbVersion Changes to this property will trigger replacement. string
Version of the PostgreSQL database.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string
(Updatable) Details about the configuration set.
DisplayName string
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
InstanceMemorySizeInGbs Changes to this property will trigger replacement. int

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

InstanceOcpuCount Changes to this property will trigger replacement. int

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

IsFlexible Changes to this property will trigger replacement. bool
Whether the configuration supports flexible shapes.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Shape Changes to this property will trigger replacement. string
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
State string
The current state of the configuration.
SystemTags Changes to this property will trigger replacement. Dictionary<string, string>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

TimeCreated string
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
CompartmentId string
(Updatable) The OCID of the compartment that contains the configuration.
ConfigType string
The type of configuration. Either user-created or a default configuration.
ConfigurationDetails []ConfigurationConfigurationDetailArgs
List of configuration details.
DbConfigurationOverrides Changes to this property will trigger replacement. ConfigurationDbConfigurationOverridesArgs
Configuration overrides for a PostgreSQL instance.
DbVersion Changes to this property will trigger replacement. string
Version of the PostgreSQL database.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string
(Updatable) Details about the configuration set.
DisplayName string
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
InstanceMemorySizeInGbs Changes to this property will trigger replacement. int

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

InstanceOcpuCount Changes to this property will trigger replacement. int

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

IsFlexible Changes to this property will trigger replacement. bool
Whether the configuration supports flexible shapes.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Shape Changes to this property will trigger replacement. string
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
State string
The current state of the configuration.
SystemTags Changes to this property will trigger replacement. map[string]string

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

TimeCreated string
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
compartmentId String
(Updatable) The OCID of the compartment that contains the configuration.
configType String
The type of configuration. Either user-created or a default configuration.
configurationDetails List<ConfigurationConfigurationDetail>
List of configuration details.
dbConfigurationOverrides Changes to this property will trigger replacement. ConfigurationDbConfigurationOverrides
Configuration overrides for a PostgreSQL instance.
dbVersion Changes to this property will trigger replacement. String
Version of the PostgreSQL database.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
(Updatable) Details about the configuration set.
displayName String
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
instanceMemorySizeInGbs Changes to this property will trigger replacement. Integer

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

instanceOcpuCount Changes to this property will trigger replacement. Integer

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

isFlexible Changes to this property will trigger replacement. Boolean
Whether the configuration supports flexible shapes.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
shape Changes to this property will trigger replacement. String
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
state String
The current state of the configuration.
systemTags Changes to this property will trigger replacement. Map<String,String>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

timeCreated String
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
compartmentId string
(Updatable) The OCID of the compartment that contains the configuration.
configType string
The type of configuration. Either user-created or a default configuration.
configurationDetails ConfigurationConfigurationDetail[]
List of configuration details.
dbConfigurationOverrides Changes to this property will trigger replacement. ConfigurationDbConfigurationOverrides
Configuration overrides for a PostgreSQL instance.
dbVersion Changes to this property will trigger replacement. string
Version of the PostgreSQL database.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string
(Updatable) Details about the configuration set.
displayName string
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
instanceMemorySizeInGbs Changes to this property will trigger replacement. number

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

instanceOcpuCount Changes to this property will trigger replacement. number

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

isFlexible Changes to this property will trigger replacement. boolean
Whether the configuration supports flexible shapes.
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
shape Changes to this property will trigger replacement. string
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
state string
The current state of the configuration.
systemTags Changes to this property will trigger replacement. {[key: string]: string}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

timeCreated string
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
compartment_id str
(Updatable) The OCID of the compartment that contains the configuration.
config_type str
The type of configuration. Either user-created or a default configuration.
configuration_details Sequence[psql.ConfigurationConfigurationDetailArgs]
List of configuration details.
db_configuration_overrides Changes to this property will trigger replacement. psql.ConfigurationDbConfigurationOverridesArgs
Configuration overrides for a PostgreSQL instance.
db_version Changes to this property will trigger replacement. str
Version of the PostgreSQL database.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str
(Updatable) Details about the configuration set.
display_name str
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
instance_memory_size_in_gbs Changes to this property will trigger replacement. int

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

instance_ocpu_count Changes to this property will trigger replacement. int

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

is_flexible Changes to this property will trigger replacement. bool
Whether the configuration supports flexible shapes.
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
shape Changes to this property will trigger replacement. str
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
state str
The current state of the configuration.
system_tags Changes to this property will trigger replacement. Mapping[str, str]

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

time_created str
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
compartmentId String
(Updatable) The OCID of the compartment that contains the configuration.
configType String
The type of configuration. Either user-created or a default configuration.
configurationDetails List<Property Map>
List of configuration details.
dbConfigurationOverrides Changes to this property will trigger replacement. Property Map
Configuration overrides for a PostgreSQL instance.
dbVersion Changes to this property will trigger replacement. String
Version of the PostgreSQL database.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
(Updatable) Details about the configuration set.
displayName String
(Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
instanceMemorySizeInGbs Changes to this property will trigger replacement. Number

Memory size in gigabytes with 1GB increment.

Skip or set it's value to 0 if configuration is for a flexible shape.

instanceOcpuCount Changes to this property will trigger replacement. Number

CPU core count.

Skip or set it's value to 0 if configuration is for a flexible shape.

isFlexible Changes to this property will trigger replacement. Boolean
Whether the configuration supports flexible shapes.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
shape Changes to this property will trigger replacement. String
The name of the shape for the configuration. Example: VM.Standard.E4.Flex
state String
The current state of the configuration.
systemTags Changes to this property will trigger replacement. Map<String>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

timeCreated String
The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

Supporting Types

ConfigurationConfigurationDetail
, ConfigurationConfigurationDetailArgs

items List<Property Map>
List of ConfigParms object.

ConfigurationConfigurationDetailItem
, ConfigurationConfigurationDetailItemArgs

AllowedValues string
Range or list of allowed values.
ConfigKey string
The configuration variable name.
DataType string
Data type of the variable.
DefaultConfigValue string
Default value for the configuration variable.
Description string
(Updatable) Details about the configuration set.
IsOverridable bool
Whether the value can be overridden or not.
IsRestartRequired bool
If true, modifying this configuration value will require a restart of the database.
OverridenConfigValue string
User-selected configuration variable value.
AllowedValues string
Range or list of allowed values.
ConfigKey string
The configuration variable name.
DataType string
Data type of the variable.
DefaultConfigValue string
Default value for the configuration variable.
Description string
(Updatable) Details about the configuration set.
IsOverridable bool
Whether the value can be overridden or not.
IsRestartRequired bool
If true, modifying this configuration value will require a restart of the database.
OverridenConfigValue string
User-selected configuration variable value.
allowedValues String
Range or list of allowed values.
configKey String
The configuration variable name.
dataType String
Data type of the variable.
defaultConfigValue String
Default value for the configuration variable.
description String
(Updatable) Details about the configuration set.
isOverridable Boolean
Whether the value can be overridden or not.
isRestartRequired Boolean
If true, modifying this configuration value will require a restart of the database.
overridenConfigValue String
User-selected configuration variable value.
allowedValues string
Range or list of allowed values.
configKey string
The configuration variable name.
dataType string
Data type of the variable.
defaultConfigValue string
Default value for the configuration variable.
description string
(Updatable) Details about the configuration set.
isOverridable boolean
Whether the value can be overridden or not.
isRestartRequired boolean
If true, modifying this configuration value will require a restart of the database.
overridenConfigValue string
User-selected configuration variable value.
allowed_values str
Range or list of allowed values.
config_key str
The configuration variable name.
data_type str
Data type of the variable.
default_config_value str
Default value for the configuration variable.
description str
(Updatable) Details about the configuration set.
is_overridable bool
Whether the value can be overridden or not.
is_restart_required bool
If true, modifying this configuration value will require a restart of the database.
overriden_config_value str
User-selected configuration variable value.
allowedValues String
Range or list of allowed values.
configKey String
The configuration variable name.
dataType String
Data type of the variable.
defaultConfigValue String
Default value for the configuration variable.
description String
(Updatable) Details about the configuration set.
isOverridable Boolean
Whether the value can be overridden or not.
isRestartRequired Boolean
If true, modifying this configuration value will require a restart of the database.
overridenConfigValue String
User-selected configuration variable value.

ConfigurationDbConfigurationOverrides
, ConfigurationDbConfigurationOverridesArgs

Items
This property is required.
Changes to this property will trigger replacement.
List<ConfigurationDbConfigurationOverridesItem>
List of configuration overridden values.
Items
This property is required.
Changes to this property will trigger replacement.
[]ConfigurationDbConfigurationOverridesItem
List of configuration overridden values.
items
This property is required.
Changes to this property will trigger replacement.
List<ConfigurationDbConfigurationOverridesItem>
List of configuration overridden values.
items
This property is required.
Changes to this property will trigger replacement.
ConfigurationDbConfigurationOverridesItem[]
List of configuration overridden values.
items
This property is required.
Changes to this property will trigger replacement.
Sequence[psql.ConfigurationDbConfigurationOverridesItem]
List of configuration overridden values.
items
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
List of configuration overridden values.

ConfigurationDbConfigurationOverridesItem
, ConfigurationDbConfigurationOverridesItemArgs

ConfigKey
This property is required.
Changes to this property will trigger replacement.
string
Configuration variable name.
OverridenConfigValue
This property is required.
Changes to this property will trigger replacement.
string
User-selected variable value.
ConfigKey
This property is required.
Changes to this property will trigger replacement.
string
Configuration variable name.
OverridenConfigValue
This property is required.
Changes to this property will trigger replacement.
string
User-selected variable value.
configKey
This property is required.
Changes to this property will trigger replacement.
String
Configuration variable name.
overridenConfigValue
This property is required.
Changes to this property will trigger replacement.
String
User-selected variable value.
configKey
This property is required.
Changes to this property will trigger replacement.
string
Configuration variable name.
overridenConfigValue
This property is required.
Changes to this property will trigger replacement.
string
User-selected variable value.
config_key
This property is required.
Changes to this property will trigger replacement.
str
Configuration variable name.
overriden_config_value
This property is required.
Changes to this property will trigger replacement.
str
User-selected variable value.
configKey
This property is required.
Changes to this property will trigger replacement.
String
Configuration variable name.
overridenConfigValue
This property is required.
Changes to this property will trigger replacement.
String
User-selected variable value.

Import

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

$ pulumi import oci:Psql/configuration:Configuration test_configuration "id"
Copy

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.