Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Psql
  5. Configuration
Oracle Cloud Infrastructure v2.4.0 published on Thursday, Jul 25, 2024 by Pulumi
pulumi/pulumi-oci

oci.Psql.Configuration

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.4.0 published on Thursday, Jul 25, 2024 by Pulumi
pulumi/pulumi-oci

    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,
    instanceMemorySizeInGbs: configurationInstanceMemorySizeInGbs,
    instanceOcpuCount: configurationInstanceOcpuCount,
    shape: configurationShape,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: configurationDescription,
    freeformTags: {
        "bar-key": "value",
    },
    systemTags: configurationSystemTags,
});

    import pulumi
import pulumi_oci as oci

test_configuration = oci.psql.Configuration("test_configuration",
    compartment_id=compartment_id,
    db_configuration_overrides=oci.psql.ConfigurationDbConfigurationOverridesArgs(
        items=[oci.psql.ConfigurationDbConfigurationOverridesItemArgs(
            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,
    instance_memory_size_in_gbs=configuration_instance_memory_size_in_gbs,
    instance_ocpu_count=configuration_instance_ocpu_count,
    shape=configuration_shape,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=configuration_description,
    freeform_tags={
        "bar-key": "value",
    },
    system_tags=configuration_system_tags)

    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),
			InstanceMemorySizeInGbs: pulumi.Any(configurationInstanceMemorySizeInGbs),
			InstanceOcpuCount:       pulumi.Any(configurationInstanceOcpuCount),
			Shape:                   pulumi.Any(configurationShape),
			DefinedTags: pulumi.Map{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			Description: pulumi.Any(configurationDescription),
			FreeformTags: pulumi.Map{
				"bar-key": pulumi.Any("value"),
			},
			SystemTags: pulumi.Any(configurationSystemTags),
		})
		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.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,
        InstanceMemorySizeInGbs = configurationInstanceMemorySizeInGbs,
        InstanceOcpuCount = configurationInstanceOcpuCount,
        Shape = configurationShape,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = configurationDescription,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        SystemTags = configurationSystemTags,
    });

});

    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)
            .instanceMemorySizeInGbs(configurationInstanceMemorySizeInGbs)
            .instanceOcpuCount(configurationInstanceOcpuCount)
            .shape(configurationShape)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(configurationDescription)
            .freeformTags(Map.of("bar-key", "value"))
            .systemTags(configurationSystemTags)
            .build());

    }
}

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

    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,
                  instance_memory_size_in_gbs: Optional[int] = None,
                  instance_ocpu_count: Optional[int] = None,
                  shape: Optional[str] = None,
                  defined_tags: Optional[Mapping[str, Any]] = None,
                  description: Optional[str] = None,
                  freeform_tags: Optional[Mapping[str, Any]] = None,
                  system_tags: Optional[Mapping[str, Any]] = 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 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 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",
    InstanceMemorySizeInGbs = 0,
    InstanceOcpuCount = 0,
    Shape = "string",
    DefinedTags = 
    {
        { "string", "any" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "any" },
    },
    SystemTags = 
    {
        { "string", "any" },
    },
});

    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"),
	InstanceMemorySizeInGbs: pulumi.Int(0),
	InstanceOcpuCount:       pulumi.Int(0),
	Shape:                   pulumi.String("string"),
	DefinedTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	Description: pulumi.String("string"),
	FreeformTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	SystemTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
})

    var exampleconfigurationResourceResourceFromPsqlconfiguration = new Configuration("exampleconfigurationResourceResourceFromPsqlconfiguration", ConfigurationArgs.builder()
    .compartmentId("string")
    .dbConfigurationOverrides(ConfigurationDbConfigurationOverridesArgs.builder()
        .items(ConfigurationDbConfigurationOverridesItemArgs.builder()
            .configKey("string")
            .overridenConfigValue("string")
            .build())
        .build())
    .dbVersion("string")
    .displayName("string")
    .instanceMemorySizeInGbs(0)
    .instanceOcpuCount(0)
    .shape("string")
    .definedTags(Map.of("string", "any"))
    .description("string")
    .freeformTags(Map.of("string", "any"))
    .systemTags(Map.of("string", "any"))
    .build());

    exampleconfiguration_resource_resource_from_psqlconfiguration = oci.psql.Configuration("exampleconfigurationResourceResourceFromPsqlconfiguration",
    compartment_id="string",
    db_configuration_overrides=oci.psql.ConfigurationDbConfigurationOverridesArgs(
        items=[oci.psql.ConfigurationDbConfigurationOverridesItemArgs(
            config_key="string",
            overriden_config_value="string",
        )],
    ),
    db_version="string",
    display_name="string",
    instance_memory_size_in_gbs=0,
    instance_ocpu_count=0,
    shape="string",
    defined_tags={
        "string": "any",
    },
    description="string",
    freeform_tags={
        "string": "any",
    },
    system_tags={
        "string": "any",
    })

    const exampleconfigurationResourceResourceFromPsqlconfiguration = new oci.psql.Configuration("exampleconfigurationResourceResourceFromPsqlconfiguration", {
    compartmentId: "string",
    dbConfigurationOverrides: {
        items: [{
            configKey: "string",
            overridenConfigValue: "string",
        }],
    },
    dbVersion: "string",
    displayName: "string",
    instanceMemorySizeInGbs: 0,
    instanceOcpuCount: 0,
    shape: "string",
    definedTags: {
        string: "any",
    },
    description: "string",
    freeformTags: {
        string: "any",
    },
    systemTags: {
        string: "any",
    },
});

    type: oci:Psql:Configuration
properties:
    compartmentId: string
    dbConfigurationOverrides:
        items:
            - configKey: string
              overridenConfigValue: string
    dbVersion: string
    definedTags:
        string: any
    description: string
    displayName: string
    freeformTags:
        string: any
    instanceMemorySizeInGbs: 0
    instanceOcpuCount: 0
    shape: string
    systemTags:
        string: any

    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

    The Configuration resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment that contains the configuration.
    DbConfigurationOverrides ConfigurationDbConfigurationOverrides
    Configuration overrides for a PostgreSQL instance.
    DbVersion string
    Version of the PostgreSQL database.
    DisplayName string
    (Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
    InstanceMemorySizeInGbs int
    Memory size in gigabytes with 1GB increment.
    InstanceOcpuCount int
    CPU core count.
    Shape string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    DefinedTags Dictionary<string, object>
    (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, object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    SystemTags Dictionary<string, object>

    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 string
    (Updatable) The OCID of the compartment that contains the configuration.
    DbConfigurationOverrides ConfigurationDbConfigurationOverridesArgs
    Configuration overrides for a PostgreSQL instance.
    DbVersion string
    Version of the PostgreSQL database.
    DisplayName string
    (Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
    InstanceMemorySizeInGbs int
    Memory size in gigabytes with 1GB increment.
    InstanceOcpuCount int
    CPU core count.
    Shape string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    DefinedTags map[string]interface{}
    (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]interface{}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    SystemTags map[string]interface{}

    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 String
    (Updatable) The OCID of the compartment that contains the configuration.
    dbConfigurationOverrides ConfigurationDbConfigurationOverrides
    Configuration overrides for a PostgreSQL instance.
    dbVersion String
    Version of the PostgreSQL database.
    displayName String
    (Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
    instanceMemorySizeInGbs Integer
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount Integer
    CPU core count.
    shape String
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    definedTags Map<String,Object>
    (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,Object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    systemTags Map<String,Object>

    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 string
    (Updatable) The OCID of the compartment that contains the configuration.
    dbConfigurationOverrides ConfigurationDbConfigurationOverrides
    Configuration overrides for a PostgreSQL instance.
    dbVersion string
    Version of the PostgreSQL database.
    displayName string
    (Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
    instanceMemorySizeInGbs number
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount number
    CPU core count.
    shape string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    definedTags {[key: string]: any}
    (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]: any}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    systemTags {[key: string]: any}

    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 str
    (Updatable) The OCID of the compartment that contains the configuration.
    db_configuration_overrides psql.ConfigurationDbConfigurationOverridesArgs
    Configuration overrides for a PostgreSQL instance.
    db_version str
    Version of the PostgreSQL database.
    display_name str
    (Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
    instance_memory_size_in_gbs int
    Memory size in gigabytes with 1GB increment.
    instance_ocpu_count int
    CPU core count.
    shape str
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    defined_tags Mapping[str, Any]
    (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, Any]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    system_tags Mapping[str, Any]

    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 String
    (Updatable) The OCID of the compartment that contains the configuration.
    dbConfigurationOverrides Property Map
    Configuration overrides for a PostgreSQL instance.
    dbVersion String
    Version of the PostgreSQL database.
    displayName String
    (Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
    instanceMemorySizeInGbs Number
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount Number
    CPU core count.
    shape String
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    definedTags Map<Any>
    (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<Any>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    systemTags Map<Any>

    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:

    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
    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
    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
    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
    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
    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,
        configuration_details: Optional[Sequence[_psql.ConfigurationConfigurationDetailArgs]] = None,
        db_configuration_overrides: Optional[_psql.ConfigurationDbConfigurationOverridesArgs] = None,
        db_version: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        instance_memory_size_in_gbs: Optional[int] = None,
        instance_ocpu_count: Optional[int] = None,
        lifecycle_details: Optional[str] = None,
        shape: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = 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)
    Resource lookup is not supported in YAML
    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 OCID of the compartment that contains the configuration.
    ConfigurationDetails List<ConfigurationConfigurationDetail>
    List of configuration details.
    DbConfigurationOverrides ConfigurationDbConfigurationOverrides
    Configuration overrides for a PostgreSQL instance.
    DbVersion string
    Version of the PostgreSQL database.
    DefinedTags Dictionary<string, object>
    (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, object>
    (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 int
    Memory size in gigabytes with 1GB increment.
    InstanceOcpuCount int
    CPU core count.
    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 string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    State string
    The current state of the configuration.
    SystemTags Dictionary<string, object>

    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.
    ConfigurationDetails []ConfigurationConfigurationDetailArgs
    List of configuration details.
    DbConfigurationOverrides ConfigurationDbConfigurationOverridesArgs
    Configuration overrides for a PostgreSQL instance.
    DbVersion string
    Version of the PostgreSQL database.
    DefinedTags map[string]interface{}
    (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]interface{}
    (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 int
    Memory size in gigabytes with 1GB increment.
    InstanceOcpuCount int
    CPU core count.
    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 string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    State string
    The current state of the configuration.
    SystemTags map[string]interface{}

    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.
    configurationDetails List<ConfigurationConfigurationDetail>
    List of configuration details.
    dbConfigurationOverrides ConfigurationDbConfigurationOverrides
    Configuration overrides for a PostgreSQL instance.
    dbVersion String
    Version of the PostgreSQL database.
    definedTags Map<String,Object>
    (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,Object>
    (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 Integer
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount Integer
    CPU core count.
    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 String
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state String
    The current state of the configuration.
    systemTags Map<String,Object>

    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.
    configurationDetails ConfigurationConfigurationDetail[]
    List of configuration details.
    dbConfigurationOverrides ConfigurationDbConfigurationOverrides
    Configuration overrides for a PostgreSQL instance.
    dbVersion string
    Version of the PostgreSQL database.
    definedTags {[key: string]: any}
    (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]: any}
    (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 number
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount number
    CPU core count.
    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 string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state string
    The current state of the configuration.
    systemTags {[key: string]: any}

    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.
    configuration_details Sequence[psql.ConfigurationConfigurationDetailArgs]
    List of configuration details.
    db_configuration_overrides psql.ConfigurationDbConfigurationOverridesArgs
    Configuration overrides for a PostgreSQL instance.
    db_version str
    Version of the PostgreSQL database.
    defined_tags Mapping[str, Any]
    (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, Any]
    (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 int
    Memory size in gigabytes with 1GB increment.
    instance_ocpu_count int
    CPU core count.
    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 str
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state str
    The current state of the configuration.
    system_tags Mapping[str, Any]

    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.
    configurationDetails List<Property Map>
    List of configuration details.
    dbConfigurationOverrides Property Map
    Configuration overrides for a PostgreSQL instance.
    dbVersion String
    Version of the PostgreSQL database.
    definedTags Map<Any>
    (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<Any>
    (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 Number
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount Number
    CPU core count.
    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 String
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state String
    The current state of the configuration.
    systemTags Map<Any>

    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 List<ConfigurationDbConfigurationOverridesItem>
    List of configuration overridden values.
    Items []ConfigurationDbConfigurationOverridesItem
    List of configuration overridden values.
    items List<ConfigurationDbConfigurationOverridesItem>
    List of configuration overridden values.
    items ConfigurationDbConfigurationOverridesItem[]
    List of configuration overridden values.
    items Sequence[psql.ConfigurationDbConfigurationOverridesItem]
    List of configuration overridden values.
    items List<Property Map>
    List of configuration overridden values.

    ConfigurationDbConfigurationOverridesItem, ConfigurationDbConfigurationOverridesItemArgs

    ConfigKey string
    Configuration variable name.
    OverridenConfigValue string
    User-selected variable value.
    ConfigKey string
    Configuration variable name.
    OverridenConfigValue string
    User-selected variable value.
    configKey String
    Configuration variable name.
    overridenConfigValue String
    User-selected variable value.
    configKey string
    Configuration variable name.
    overridenConfigValue string
    User-selected variable value.
    config_key str
    Configuration variable name.
    overriden_config_value str
    User-selected variable value.
    configKey String
    Configuration variable name.
    overridenConfigValue String
    User-selected variable value.

    Import

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

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

    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 v2.4.0 published on Thursday, Jul 25, 2024 by Pulumi
    pulumi/pulumi-oci