1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Psql
  5. getDefaultConfigurations
Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi

oci.Psql.getDefaultConfigurations

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi

    This data source provides the list of Default Configurations in Oracle Cloud Infrastructure Psql service.

    Returns a list of default configurations.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDefaultConfigurations = oci.Psql.getDefaultConfigurations({
        configurationId: testConfiguration.id,
        dbVersion: defaultConfigurationDbVersion,
        displayName: defaultConfigurationDisplayName,
        shape: defaultConfigurationShape,
        state: defaultConfigurationState,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_default_configurations = oci.Psql.get_default_configurations(configuration_id=test_configuration["id"],
        db_version=default_configuration_db_version,
        display_name=default_configuration_display_name,
        shape=default_configuration_shape,
        state=default_configuration_state)
    
    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.GetDefaultConfigurations(ctx, &psql.GetDefaultConfigurationsArgs{
    			ConfigurationId: pulumi.StringRef(testConfiguration.Id),
    			DbVersion:       pulumi.StringRef(defaultConfigurationDbVersion),
    			DisplayName:     pulumi.StringRef(defaultConfigurationDisplayName),
    			Shape:           pulumi.StringRef(defaultConfigurationShape),
    			State:           pulumi.StringRef(defaultConfigurationState),
    		}, 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 testDefaultConfigurations = Oci.Psql.GetDefaultConfigurations.Invoke(new()
        {
            ConfigurationId = testConfiguration.Id,
            DbVersion = defaultConfigurationDbVersion,
            DisplayName = defaultConfigurationDisplayName,
            Shape = defaultConfigurationShape,
            State = defaultConfigurationState,
        });
    
    });
    
    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.GetDefaultConfigurationsArgs;
    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 testDefaultConfigurations = PsqlFunctions.getDefaultConfigurations(GetDefaultConfigurationsArgs.builder()
                .configurationId(testConfiguration.id())
                .dbVersion(defaultConfigurationDbVersion)
                .displayName(defaultConfigurationDisplayName)
                .shape(defaultConfigurationShape)
                .state(defaultConfigurationState)
                .build());
    
        }
    }
    
    variables:
      testDefaultConfigurations:
        fn::invoke:
          Function: oci:Psql:getDefaultConfigurations
          Arguments:
            configurationId: ${testConfiguration.id}
            dbVersion: ${defaultConfigurationDbVersion}
            displayName: ${defaultConfigurationDisplayName}
            shape: ${defaultConfigurationShape}
            state: ${defaultConfigurationState}
    

    Using getDefaultConfigurations

    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 getDefaultConfigurations(args: GetDefaultConfigurationsArgs, opts?: InvokeOptions): Promise<GetDefaultConfigurationsResult>
    function getDefaultConfigurationsOutput(args: GetDefaultConfigurationsOutputArgs, opts?: InvokeOptions): Output<GetDefaultConfigurationsResult>
    def get_default_configurations(configuration_id: Optional[str] = None,
                                   db_version: Optional[str] = None,
                                   display_name: Optional[str] = None,
                                   filters: Optional[Sequence[_psql.GetDefaultConfigurationsFilter]] = None,
                                   shape: Optional[str] = None,
                                   state: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetDefaultConfigurationsResult
    def get_default_configurations_output(configuration_id: Optional[pulumi.Input[str]] = None,
                                   db_version: Optional[pulumi.Input[str]] = None,
                                   display_name: Optional[pulumi.Input[str]] = None,
                                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[_psql.GetDefaultConfigurationsFilterArgs]]]] = None,
                                   shape: Optional[pulumi.Input[str]] = None,
                                   state: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetDefaultConfigurationsResult]
    func GetDefaultConfigurations(ctx *Context, args *GetDefaultConfigurationsArgs, opts ...InvokeOption) (*GetDefaultConfigurationsResult, error)
    func GetDefaultConfigurationsOutput(ctx *Context, args *GetDefaultConfigurationsOutputArgs, opts ...InvokeOption) GetDefaultConfigurationsResultOutput

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

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

    The following arguments are supported:

    ConfigurationId string
    A unique identifier for the configuration.
    DbVersion string
    Version of the PostgreSQL database, such as 14.9.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters List<GetDefaultConfigurationsFilter>
    Shape string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    State string
    A filter to return only resources if their lifecycleState matches the given lifecycleState.
    ConfigurationId string
    A unique identifier for the configuration.
    DbVersion string
    Version of the PostgreSQL database, such as 14.9.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters []GetDefaultConfigurationsFilter
    Shape string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    State string
    A filter to return only resources if their lifecycleState matches the given lifecycleState.
    configurationId String
    A unique identifier for the configuration.
    dbVersion String
    Version of the PostgreSQL database, such as 14.9.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<GetDefaultConfigurationsFilter>
    shape String
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state String
    A filter to return only resources if their lifecycleState matches the given lifecycleState.
    configurationId string
    A unique identifier for the configuration.
    dbVersion string
    Version of the PostgreSQL database, such as 14.9.
    displayName string
    A filter to return only resources that match the entire display name given.
    filters GetDefaultConfigurationsFilter[]
    shape string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state string
    A filter to return only resources if their lifecycleState matches the given lifecycleState.
    configuration_id str
    A unique identifier for the configuration.
    db_version str
    Version of the PostgreSQL database, such as 14.9.
    display_name str
    A filter to return only resources that match the entire display name given.
    filters Sequence[psql.GetDefaultConfigurationsFilter]
    shape str
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state str
    A filter to return only resources if their lifecycleState matches the given lifecycleState.
    configurationId String
    A unique identifier for the configuration.
    dbVersion String
    Version of the PostgreSQL database, such as 14.9.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<Property Map>
    shape String
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state String
    A filter to return only resources if their lifecycleState matches the given lifecycleState.

    getDefaultConfigurations Result

    The following output properties are available:

    DefaultConfigurationCollections List<GetDefaultConfigurationsDefaultConfigurationCollection>
    The list of default_configuration_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    ConfigurationId string
    DbVersion string
    Version of the PostgreSQL database.
    DisplayName string
    A user-friendly display name for the configuration.
    Filters List<GetDefaultConfigurationsFilter>
    Shape string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    State string
    The current state of the configuration.
    DefaultConfigurationCollections []GetDefaultConfigurationsDefaultConfigurationCollection
    The list of default_configuration_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    ConfigurationId string
    DbVersion string
    Version of the PostgreSQL database.
    DisplayName string
    A user-friendly display name for the configuration.
    Filters []GetDefaultConfigurationsFilter
    Shape string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    State string
    The current state of the configuration.
    defaultConfigurationCollections List<GetDefaultConfigurationsDefaultConfigurationCollection>
    The list of default_configuration_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    configurationId String
    dbVersion String
    Version of the PostgreSQL database.
    displayName String
    A user-friendly display name for the configuration.
    filters List<GetDefaultConfigurationsFilter>
    shape String
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state String
    The current state of the configuration.
    defaultConfigurationCollections GetDefaultConfigurationsDefaultConfigurationCollection[]
    The list of default_configuration_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    configurationId string
    dbVersion string
    Version of the PostgreSQL database.
    displayName string
    A user-friendly display name for the configuration.
    filters GetDefaultConfigurationsFilter[]
    shape string
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state string
    The current state of the configuration.
    default_configuration_collections Sequence[psql.GetDefaultConfigurationsDefaultConfigurationCollection]
    The list of default_configuration_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    configuration_id str
    db_version str
    Version of the PostgreSQL database.
    display_name str
    A user-friendly display name for the configuration.
    filters Sequence[psql.GetDefaultConfigurationsFilter]
    shape str
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state str
    The current state of the configuration.
    defaultConfigurationCollections List<Property Map>
    The list of default_configuration_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    configurationId String
    dbVersion String
    Version of the PostgreSQL database.
    displayName String
    A user-friendly display name for the configuration.
    filters List<Property Map>
    shape String
    The name of the shape for the configuration. Example: VM.Standard.E4.Flex
    state String
    The current state of the configuration.

    Supporting Types

    GetDefaultConfigurationsDefaultConfigurationCollection

    items List<Property Map>
    List of ConfigParms object.

    GetDefaultConfigurationsDefaultConfigurationCollectionItem

    ConfigurationDetails List<GetDefaultConfigurationsDefaultConfigurationCollectionItemConfigurationDetail>
    List of default configuration values for databases.
    DbVersion string
    Version of the PostgreSQL database, such as 14.9.
    Description string
    A description for the configuration.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Id string
    A unique identifier for the configuration.
    InstanceMemorySizeInGbs int
    Memory size in gigabytes with 1GB increment.
    InstanceOcpuCount int
    CPU core count.
    IsFlexible bool
    True if the configuration supports flexible shapes, false otherwise.
    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
    A filter to return only resources if their lifecycleState matches the given lifecycleState.
    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 []GetDefaultConfigurationsDefaultConfigurationCollectionItemConfigurationDetail
    List of default configuration values for databases.
    DbVersion string
    Version of the PostgreSQL database, such as 14.9.
    Description string
    A description for the configuration.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Id string
    A unique identifier for the configuration.
    InstanceMemorySizeInGbs int
    Memory size in gigabytes with 1GB increment.
    InstanceOcpuCount int
    CPU core count.
    IsFlexible bool
    True if the configuration supports flexible shapes, false otherwise.
    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
    A filter to return only resources if their lifecycleState matches the given lifecycleState.
    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<GetDefaultConfigurationsDefaultConfigurationCollectionItemConfigurationDetail>
    List of default configuration values for databases.
    dbVersion String
    Version of the PostgreSQL database, such as 14.9.
    description String
    A description for the configuration.
    displayName String
    A filter to return only resources that match the entire display name given.
    id String
    A unique identifier for the configuration.
    instanceMemorySizeInGbs Integer
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount Integer
    CPU core count.
    isFlexible Boolean
    True if the configuration supports flexible shapes, false otherwise.
    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
    A filter to return only resources if their lifecycleState matches the given lifecycleState.
    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 GetDefaultConfigurationsDefaultConfigurationCollectionItemConfigurationDetail[]
    List of default configuration values for databases.
    dbVersion string
    Version of the PostgreSQL database, such as 14.9.
    description string
    A description for the configuration.
    displayName string
    A filter to return only resources that match the entire display name given.
    id string
    A unique identifier for the configuration.
    instanceMemorySizeInGbs number
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount number
    CPU core count.
    isFlexible boolean
    True if the configuration supports flexible shapes, false otherwise.
    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
    A filter to return only resources if their lifecycleState matches the given lifecycleState.
    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.GetDefaultConfigurationsDefaultConfigurationCollectionItemConfigurationDetail]
    List of default configuration values for databases.
    db_version str
    Version of the PostgreSQL database, such as 14.9.
    description str
    A description for the configuration.
    display_name str
    A filter to return only resources that match the entire display name given.
    id str
    A unique identifier for the configuration.
    instance_memory_size_in_gbs int
    Memory size in gigabytes with 1GB increment.
    instance_ocpu_count int
    CPU core count.
    is_flexible bool
    True if the configuration supports flexible shapes, false otherwise.
    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
    A filter to return only resources if their lifecycleState matches the given lifecycleState.
    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 default configuration values for databases.
    dbVersion String
    Version of the PostgreSQL database, such as 14.9.
    description String
    A description for the configuration.
    displayName String
    A filter to return only resources that match the entire display name given.
    id String
    A unique identifier for the configuration.
    instanceMemorySizeInGbs Number
    Memory size in gigabytes with 1GB increment.
    instanceOcpuCount Number
    CPU core count.
    isFlexible Boolean
    True if the configuration supports flexible shapes, false otherwise.
    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
    A filter to return only resources if their lifecycleState matches the given lifecycleState.
    timeCreated String
    The date and time that the configuration was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

    GetDefaultConfigurationsDefaultConfigurationCollectionItemConfigurationDetail

    items List<Property Map>
    List of ConfigParms object.

    GetDefaultConfigurationsDefaultConfigurationCollectionItemConfigurationDetailItem

    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 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.
    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 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.
    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 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.
    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 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.
    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 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.
    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 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.

    GetDefaultConfigurationsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    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.18.0 published on Friday, Nov 22, 2024 by Pulumi