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,
});
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)
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
})
}
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,
});
});
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());
}
}
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}
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" },
},
});
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"),
},
})
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());
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",
})
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",
},
});
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
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:
- Compartment
Id This property is required. string - (Updatable) The OCID of the compartment that contains the configuration.
- Db
Configuration Overrides This property is required. Changes to this property will trigger replacement.
Db Configuration Overrides - Configuration overrides for a PostgreSQL instance.
- Db
Version This property is required. Changes to this property will trigger replacement.
- Version of the PostgreSQL database.
- Display
Name 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- 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.
- 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"}
- Instance
Memory Size In Gbs Changes to this property will trigger replacement.
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.
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.
- Whether the configuration supports flexible shapes.
Changes to this property will trigger replacement.
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. string - (Updatable) The OCID of the compartment that contains the configuration.
- Db
Configuration Overrides This property is required. Changes to this property will trigger replacement.
Db Configuration Overrides Args - Configuration overrides for a PostgreSQL instance.
- Db
Version This property is required. Changes to this property will trigger replacement.
- Version of the PostgreSQL database.
- Display
Name 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- 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.
- 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"}
- Instance
Memory Size In Gbs Changes to this property will trigger replacement.
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.
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.
- Whether the configuration supports flexible shapes.
Changes to this property will trigger replacement.
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. String - (Updatable) The OCID of the compartment that contains the configuration.
- db
Configuration Overrides This property is required. Changes to this property will trigger replacement.
Db Configuration Overrides - Configuration overrides for a PostgreSQL instance.
- db
Version This property is required. Changes to this property will trigger replacement.
- Version of the PostgreSQL database.
- display
Name 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- 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.
- 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"}
- instance
Memory Size In Gbs Changes to this property will trigger replacement.
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.
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.
- Whether the configuration supports flexible shapes.
Changes to this property will trigger replacement.
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. string - (Updatable) The OCID of the compartment that contains the configuration.
- db
Configuration Overrides This property is required. Changes to this property will trigger replacement.
Db Configuration Overrides - Configuration overrides for a PostgreSQL instance.
- db
Version This property is required. Changes to this property will trigger replacement.
- Version of the PostgreSQL database.
- display
Name 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- {[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.
- {[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"}
- instance
Memory Size In Gbs Changes to this property will trigger replacement.
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.
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.
- Whether the configuration supports flexible shapes.
Changes to this property will trigger replacement.
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.
Configuration Db Configuration Overrides Args - Configuration overrides for a PostgreSQL instance.
- db_
version This property is required. Changes to this property will trigger replacement.
- 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- 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.
- 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.
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.
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.
- Whether the configuration supports flexible shapes.
Changes to this property will trigger replacement.
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. String - (Updatable) The OCID of the compartment that contains the configuration.
- db
Configuration Overrides This property is required. Changes to this property will trigger replacement.
- Configuration overrides for a PostgreSQL instance.
- db
Version This property is required. Changes to this property will trigger replacement.
- Version of the PostgreSQL database.
- display
Name 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- 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.
- 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"}
- instance
Memory Size In Gbs Changes to this property will trigger replacement.
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.
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.
- Whether the configuration supports flexible shapes.
Changes to this property will trigger replacement.
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:
- Config
Type string - The type of configuration. Either user-created or a default configuration.
- Configuration
Details List<ConfigurationConfiguration Detail> - List of configuration details.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details 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.
- Time
Created 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 string - The type of configuration. Either user-created or a default configuration.
- Configuration
Details []ConfigurationConfiguration Detail - List of configuration details.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details 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.
- Time
Created 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 String - The type of configuration. Either user-created or a default configuration.
- configuration
Details List<ConfigurationConfiguration Detail> - List of configuration details.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- time
Created 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 string - The type of configuration. Either user-created or a default configuration.
- configuration
Details ConfigurationConfiguration Detail[] - List of configuration details.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- time
Created 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.Configuration Configuration Detail] - 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
- config
Type String - The type of configuration. Either user-created or a default configuration.
- configuration
Details List<Property Map> - List of configuration details.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- time
Created 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.
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the configuration.
- Config
Type string - The type of configuration. Either user-created or a default configuration.
- Configuration
Details List<ConfigurationConfiguration Detail> - List of configuration details.
- Db
Configuration Overrides Changes to this property will trigger replacement.
Db Configuration Overrides - Configuration overrides for a PostgreSQL instance.
- Db
Version Changes to this property will trigger replacement.
- Version of the PostgreSQL database.
- 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.
- Display
Name string - (Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
- 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"}
- Instance
Memory Size In Gbs Changes to this property will trigger replacement.
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.
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.
- Whether the configuration supports flexible shapes.
- Lifecycle
Details 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- State string
- The current state of the configuration.
Changes to this property will trigger replacement.
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 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 string - (Updatable) The OCID of the compartment that contains the configuration.
- Config
Type string - The type of configuration. Either user-created or a default configuration.
- Configuration
Details []ConfigurationConfiguration Detail Args - List of configuration details.
- Db
Configuration Overrides Changes to this property will trigger replacement.
Db Configuration Overrides Args - Configuration overrides for a PostgreSQL instance.
- Db
Version Changes to this property will trigger replacement.
- Version of the PostgreSQL database.
- 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.
- Display
Name string - (Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
- 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"}
- Instance
Memory Size In Gbs Changes to this property will trigger replacement.
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.
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.
- Whether the configuration supports flexible shapes.
- Lifecycle
Details 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- State string
- The current state of the configuration.
Changes to this property will trigger replacement.
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 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 String - (Updatable) The OCID of the compartment that contains the configuration.
- config
Type String - The type of configuration. Either user-created or a default configuration.
- configuration
Details List<ConfigurationConfiguration Detail> - List of configuration details.
- db
Configuration Overrides Changes to this property will trigger replacement.
Db Configuration Overrides - Configuration overrides for a PostgreSQL instance.
- db
Version Changes to this property will trigger replacement.
- Version of the PostgreSQL database.
- 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.
- display
Name String - (Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
- 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"}
- instance
Memory Size In Gbs Changes to this property will trigger replacement.
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.
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.
- Whether the configuration supports flexible shapes.
- lifecycle
Details 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- state String
- The current state of the configuration.
Changes to this property will trigger replacement.
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 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 string - (Updatable) The OCID of the compartment that contains the configuration.
- config
Type string - The type of configuration. Either user-created or a default configuration.
- configuration
Details ConfigurationConfiguration Detail[] - List of configuration details.
- db
Configuration Overrides Changes to this property will trigger replacement.
Db Configuration Overrides - Configuration overrides for a PostgreSQL instance.
- db
Version Changes to this property will trigger replacement.
- Version of the PostgreSQL database.
- {[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.
- display
Name string - (Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
- {[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"}
- instance
Memory Size In Gbs Changes to this property will trigger replacement.
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.
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.
- Whether the configuration supports flexible shapes.
- lifecycle
Details 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- state string
- The current state of the configuration.
Changes to this property will trigger replacement.
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 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.Configuration Configuration Detail Args] - List of configuration details.
- db_
configuration_ overrides Changes to this property will trigger replacement.
Configuration Db Configuration Overrides Args - Configuration overrides for a PostgreSQL instance.
- db_
version Changes to this property will trigger replacement.
- Version of the PostgreSQL database.
- 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.
- 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.
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.
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.
- 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- state str
- The current state of the configuration.
Changes to this property will trigger replacement.
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
- compartment
Id String - (Updatable) The OCID of the compartment that contains the configuration.
- config
Type String - The type of configuration. Either user-created or a default configuration.
- configuration
Details List<Property Map> - List of configuration details.
- db
Configuration Overrides Changes to this property will trigger replacement.
- Configuration overrides for a PostgreSQL instance.
- db
Version Changes to this property will trigger replacement.
- Version of the PostgreSQL database.
- 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.
- display
Name String - (Updatable) A user-friendly display name for the configuration. Avoid entering confidential information.
- 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"}
- instance
Memory Size In Gbs Changes to this property will trigger replacement.
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.
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.
- Whether the configuration supports flexible shapes.
- lifecycle
Details 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.
- The name of the shape for the configuration. Example:
VM.Standard.E4.Flex
- state String
- The current state of the configuration.
Changes to this property will trigger replacement.
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 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<Configuration
Configuration Detail Item> - List of ConfigParms object.
- Items
[]Configuration
Configuration Detail Item - List of ConfigParms object.
- items
List<Configuration
Configuration Detail Item> - List of ConfigParms object.
- items
Configuration
Configuration Detail Item[] - List of ConfigParms object.
- items
Sequence[psql.
Configuration Configuration Detail Item] - List of ConfigParms object.
- items List<Property Map>
- List of ConfigParms object.
ConfigurationConfigurationDetailItem, ConfigurationConfigurationDetailItemArgs
- Allowed
Values string - Range or list of allowed values.
- Config
Key string - The configuration variable name.
- Data
Type string - Data type of the variable.
- Default
Config stringValue - Default value for the configuration variable.
- Description string
- (Updatable) Details about the configuration set.
- Is
Overridable bool - Whether the value can be overridden or not.
- Is
Restart boolRequired - If true, modifying this configuration value will require a restart of the database.
- Overriden
Config stringValue - User-selected configuration variable value.
- Allowed
Values string - Range or list of allowed values.
- Config
Key string - The configuration variable name.
- Data
Type string - Data type of the variable.
- Default
Config stringValue - Default value for the configuration variable.
- Description string
- (Updatable) Details about the configuration set.
- Is
Overridable bool - Whether the value can be overridden or not.
- Is
Restart boolRequired - If true, modifying this configuration value will require a restart of the database.
- Overriden
Config stringValue - User-selected configuration variable value.
- allowed
Values String - Range or list of allowed values.
- config
Key String - The configuration variable name.
- data
Type String - Data type of the variable.
- default
Config StringValue - Default value for the configuration variable.
- description String
- (Updatable) Details about the configuration set.
- is
Overridable Boolean - Whether the value can be overridden or not.
- is
Restart BooleanRequired - If true, modifying this configuration value will require a restart of the database.
- overriden
Config StringValue - User-selected configuration variable value.
- allowed
Values string - Range or list of allowed values.
- config
Key string - The configuration variable name.
- data
Type string - Data type of the variable.
- default
Config stringValue - Default value for the configuration variable.
- description string
- (Updatable) Details about the configuration set.
- is
Overridable boolean - Whether the value can be overridden or not.
- is
Restart booleanRequired - If true, modifying this configuration value will require a restart of the database.
- overriden
Config stringValue - 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_ strvalue - 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_ boolrequired - If true, modifying this configuration value will require a restart of the database.
- overriden_
config_ strvalue - User-selected configuration variable value.
- allowed
Values String - Range or list of allowed values.
- config
Key String - The configuration variable name.
- data
Type String - Data type of the variable.
- default
Config StringValue - Default value for the configuration variable.
- description String
- (Updatable) Details about the configuration set.
- is
Overridable Boolean - Whether the value can be overridden or not.
- is
Restart BooleanRequired - If true, modifying this configuration value will require a restart of the database.
- overriden
Config StringValue - User-selected configuration variable value.
ConfigurationDbConfigurationOverrides, ConfigurationDbConfigurationOverridesArgs
- Items
This property is required. Changes to this property will trigger replacement.
Db Configuration Overrides Item> - List of configuration overridden values.
- Items
This property is required. Changes to this property will trigger replacement.
Db Configuration Overrides Item - List of configuration overridden values.
- items
This property is required. Changes to this property will trigger replacement.
Db Configuration Overrides Item> - List of configuration overridden values.
- items
This property is required. Changes to this property will trigger replacement.
Db Configuration Overrides Item[] - List of configuration overridden values.
- items
This property is required. Changes to this property will trigger replacement.
Configuration Db Configuration Overrides Item] - List of configuration overridden values.
- items
This property is required. Changes to this property will trigger replacement.
- List of configuration overridden values.
ConfigurationDbConfigurationOverridesItem, ConfigurationDbConfigurationOverridesItemArgs
- Config
Key This property is required. Changes to this property will trigger replacement.
- Configuration variable name.
- Overriden
Config Value This property is required. Changes to this property will trigger replacement.
- User-selected variable value.
- Config
Key This property is required. Changes to this property will trigger replacement.
- Configuration variable name.
- Overriden
Config Value This property is required. Changes to this property will trigger replacement.
- User-selected variable value.
- config
Key This property is required. Changes to this property will trigger replacement.
- Configuration variable name.
- overriden
Config Value This property is required. Changes to this property will trigger replacement.
- User-selected variable value.
- config
Key This property is required. Changes to this property will trigger replacement.
- Configuration variable name.
- overriden
Config Value This property is required. Changes to this property will trigger replacement.
- User-selected variable value.
- config_
key This property is required. Changes to this property will trigger replacement.
- Configuration variable name.
- overriden_
config_ value This property is required. Changes to this property will trigger replacement.
- User-selected variable value.
- config
Key This property is required. Changes to this property will trigger replacement.
- Configuration variable name.
- overriden
Config Value This property is required. Changes to this property will trigger replacement.
- 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.