1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Psql
  5. getConfiguration
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

oci.Psql.getConfiguration

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

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

    Gets a configuration by identifier.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testConfiguration = oci.Psql.getConfiguration({
        configurationId: testConfigurationOciPsqlConfiguration.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_configuration = oci.Psql.get_configuration(configuration_id=test_configuration_oci_psql_configuration["id"])
    
    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.GetConfiguration(ctx, &psql.GetConfigurationArgs{
    			ConfigurationId: testConfigurationOciPsqlConfiguration.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testConfiguration = Oci.Psql.GetConfiguration.Invoke(new()
        {
            ConfigurationId = testConfigurationOciPsqlConfiguration.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Psql.PsqlFunctions;
    import com.pulumi.oci.Psql.inputs.GetConfigurationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testConfiguration = PsqlFunctions.getConfiguration(GetConfigurationArgs.builder()
                .configurationId(testConfigurationOciPsqlConfiguration.id())
                .build());
    
        }
    }
    
    variables:
      testConfiguration:
        fn::invoke:
          Function: oci:Psql:getConfiguration
          Arguments:
            configurationId: ${testConfigurationOciPsqlConfiguration.id}
    

    Using getConfiguration

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConfiguration(args: GetConfigurationArgs, opts?: InvokeOptions): Promise<GetConfigurationResult>
    function getConfigurationOutput(args: GetConfigurationOutputArgs, opts?: InvokeOptions): Output<GetConfigurationResult>
    def get_configuration(configuration_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetConfigurationResult
    def get_configuration_output(configuration_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetConfigurationResult]
    func GetConfiguration(ctx *Context, args *GetConfigurationArgs, opts ...InvokeOption) (*GetConfigurationResult, error)
    func GetConfigurationOutput(ctx *Context, args *GetConfigurationOutputArgs, opts ...InvokeOption) GetConfigurationResultOutput

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

    public static class GetConfiguration 
    {
        public static Task<GetConfigurationResult> InvokeAsync(GetConfigurationArgs args, InvokeOptions? opts = null)
        public static Output<GetConfigurationResult> Invoke(GetConfigurationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConfigurationResult> getConfiguration(GetConfigurationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Psql/getConfiguration:getConfiguration
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ConfigurationId string
    A unique identifier for the configuration.
    ConfigurationId string
    A unique identifier for the configuration.
    configurationId String
    A unique identifier for the configuration.
    configurationId string
    A unique identifier for the configuration.
    configuration_id str
    A unique identifier for the configuration.
    configurationId String
    A unique identifier for the configuration.

    getConfiguration Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment that contains the configuration.
    ConfigType string
    The type of configuration. Either user-created or a default configuration.
    ConfigurationDetails List<GetConfigurationConfigurationDetail>
    List of configuration details.
    ConfigurationId string
    DbConfigurationOverrides List<GetConfigurationDbConfigurationOverride>
    DbVersion string
    Version of the PostgreSQL database.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    A description for the configuration.
    DisplayName string
    A user-friendly display name for the configuration. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    A unique identifier for the configuration. Immutable on creation.
    InstanceMemorySizeInGbs int
    Memory size in gigabytes with 1GB increment.
    InstanceOcpuCount int
    CPU core count.
    IsFlexible bool
    Whether the configuration supports flexible shapes.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    Shape 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, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    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
    The OCID of the compartment that contains the configuration.
    ConfigType string
    The type of configuration. Either user-created or a default configuration.
    ConfigurationDetails []GetConfigurationConfigurationDetail
    List of configuration details.
    ConfigurationId string
    DbConfigurationOverrides []GetConfigurationDbConfigurationOverride
    DbVersion string
    Version of the PostgreSQL database.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    A description for the configuration.
    DisplayName string
    A user-friendly display name for the configuration. Avoid entering confidential information.
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    A unique identifier for the configuration. Immutable on creation.
    InstanceMemorySizeInGbs int
    Memory size in gigabytes with 1GB increment.
    InstanceOcpuCount int
    CPU core count.
    IsFlexible bool
    Whether the configuration supports flexible shapes.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    Shape 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]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    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
    The OCID of the compartment that contains the configuration.
    configType String
    The type of configuration. Either user-created or a default configuration.
    configurationDetails List<GetConfigurationConfigurationDetail>
    List of configuration details.
    configurationId String
    dbConfigurationOverrides List<GetConfigurationDbConfigurationOverride>
    dbVersion String
    Version of the PostgreSQL database.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    A description for the configuration.
    displayName String
    A user-friendly display name for the configuration. Avoid entering confidential information.
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    A unique identifier for the configuration. Immutable on creation.
    instanceMemorySizeInGbs Integer
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount Integer
    CPU core count.
    isFlexible Boolean
    Whether the configuration supports flexible shapes.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    shape 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,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    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
    The OCID of the compartment that contains the configuration.
    configType string
    The type of configuration. Either user-created or a default configuration.
    configurationDetails GetConfigurationConfigurationDetail[]
    List of configuration details.
    configurationId string
    dbConfigurationOverrides GetConfigurationDbConfigurationOverride[]
    dbVersion string
    Version of the PostgreSQL database.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    A description for the configuration.
    displayName string
    A user-friendly display name for the configuration. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    A unique identifier for the configuration. Immutable on creation.
    instanceMemorySizeInGbs number
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount number
    CPU core count.
    isFlexible boolean
    Whether the configuration supports flexible shapes.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    shape 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]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    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
    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.GetConfigurationConfigurationDetail]
    List of configuration details.
    configuration_id str
    db_configuration_overrides Sequence[psql.GetConfigurationDbConfigurationOverride]
    db_version str
    Version of the PostgreSQL database.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    A description for the configuration.
    display_name str
    A user-friendly display name for the configuration. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    A unique identifier for the configuration. Immutable on creation.
    instance_memory_size_in_gbs int
    Memory size in gigabytes with 1GB increment.
    instance_ocpu_count int
    CPU core count.
    is_flexible bool
    Whether the configuration supports flexible shapes.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    shape 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, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    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
    The OCID of the compartment that contains the configuration.
    configType String
    The type of configuration. Either user-created or a default configuration.
    configurationDetails List<Property Map>
    List of configuration details.
    configurationId String
    dbConfigurationOverrides List<Property Map>
    dbVersion String
    Version of the PostgreSQL database.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    A description for the configuration.
    displayName String
    A user-friendly display name for the configuration. Avoid entering confidential information.
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    A unique identifier for the configuration. Immutable on creation.
    instanceMemorySizeInGbs Number
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount Number
    CPU core count.
    isFlexible Boolean
    Whether the configuration supports flexible shapes.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    shape 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>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    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

    GetConfigurationConfigurationDetail

    items List<Property Map>
    List of ConfigParms object.

    GetConfigurationConfigurationDetailItem

    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
    A description for the configuration.
    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
    A description for the configuration.
    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
    A description for the configuration.
    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
    A description for the configuration.
    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
    A description for the configuration.
    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
    A description for the configuration.
    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.

    GetConfigurationDbConfigurationOverride

    items List<Property Map>
    List of ConfigParms object.

    GetConfigurationDbConfigurationOverrideItem

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

    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.11.0 published on Thursday, Sep 19, 2024 by Pulumi