Configuration

class oci.psql.models.Configuration(**kwargs)

Bases: object

PostgreSQL configuration for a database system.

Attributes:

CONFIG_TYPE_COPIED

A constant which can be used with the config_type property of a Configuration.

CONFIG_TYPE_CUSTOM

A constant which can be used with the config_type property of a Configuration.

CONFIG_TYPE_DEFAULT

A constant which can be used with the config_type property of a Configuration.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Configuration.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Configuration.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Configuration.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Configuration.

compartment_id

[Required] Gets the compartment_id of this Configuration.

compatible_shapes

[Required] Gets the compatible_shapes of this Configuration.

config_type

Gets the config_type of this Configuration.

configuration_details

[Required] Gets the configuration_details of this Configuration.

db_version

[Required] Gets the db_version of this Configuration.

default_config_id

[Required] Gets the default_config_id of this Configuration.

defined_tags

Gets the defined_tags of this Configuration.

description

Gets the description of this Configuration.

display_name

[Required] Gets the display_name of this Configuration.

freeform_tags

Gets the freeform_tags of this Configuration.

id

[Required] Gets the id of this Configuration.

instance_memory_size_in_gbs

[Required] Gets the instance_memory_size_in_gbs of this Configuration.

instance_ocpu_count

[Required] Gets the instance_ocpu_count of this Configuration.

is_flexible

Gets the is_flexible of this Configuration.

lifecycle_details

Gets the lifecycle_details of this Configuration.

lifecycle_state

[Required] Gets the lifecycle_state of this Configuration.

shape

[Required] Gets the shape of this Configuration.

system_tags

Gets the system_tags of this Configuration.

time_created

[Required] Gets the time_created of this Configuration.

Methods:

__init__(**kwargs)

Initializes a new Configuration object with values from keyword arguments.

CONFIG_TYPE_COPIED = 'COPIED'

A constant which can be used with the config_type property of a Configuration. This constant has a value of “COPIED”

CONFIG_TYPE_CUSTOM = 'CUSTOM'

A constant which can be used with the config_type property of a Configuration. This constant has a value of “CUSTOM”

CONFIG_TYPE_DEFAULT = 'DEFAULT'

A constant which can be used with the config_type property of a Configuration. This constant has a value of “DEFAULT”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Configuration. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Configuration. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Configuration. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Configuration. This constant has a value of “FAILED”

__init__(**kwargs)

Initializes a new Configuration object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this Configuration.

  • display_name (str) – The value to assign to the display_name property of this Configuration.

  • description (str) – The value to assign to the description property of this Configuration.

  • compartment_id (str) – The value to assign to the compartment_id property of this Configuration.

  • time_created (datetime) – The value to assign to the time_created property of this Configuration.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Configuration. Allowed values for this property are: “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Configuration.

  • db_version (str) – The value to assign to the db_version property of this Configuration.

  • config_type (str) – The value to assign to the config_type property of this Configuration. Allowed values for this property are: “DEFAULT”, “CUSTOM”, “COPIED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • shape (str) – The value to assign to the shape property of this Configuration.

  • is_flexible (bool) – The value to assign to the is_flexible property of this Configuration.

  • instance_ocpu_count (int) – The value to assign to the instance_ocpu_count property of this Configuration.

  • instance_memory_size_in_gbs (int) – The value to assign to the instance_memory_size_in_gbs property of this Configuration.

  • compatible_shapes (list[str]) – The value to assign to the compatible_shapes property of this Configuration.

  • default_config_id (str) – The value to assign to the default_config_id property of this Configuration.

  • configuration_details (oci.psql.models.ConfigurationDetails) – The value to assign to the configuration_details property of this Configuration.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Configuration.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Configuration.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Configuration.

property compartment_id

[Required] Gets the compartment_id of this Configuration. The OCID of the compartment that contains the configuration.

Returns

The compartment_id of this Configuration.

Return type

str

property compatible_shapes

[Required] Gets the compatible_shapes of this Configuration. Indicates the collection of compatible shapes for this configuration.

Returns

The compatible_shapes of this Configuration.

Return type

list[str]

property config_type

Gets the config_type of this Configuration. The type of configuration. Either user-created or a default configuration.

Allowed values for this property are: “DEFAULT”, “CUSTOM”, “COPIED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The config_type of this Configuration.

Return type

str

property configuration_details

[Required] Gets the configuration_details of this Configuration.

Returns

The configuration_details of this Configuration.

Return type

oci.psql.models.ConfigurationDetails

property db_version

[Required] Gets the db_version of this Configuration. Version of the PostgreSQL database.

Returns

The db_version of this Configuration.

Return type

str

property default_config_id

[Required] Gets the default_config_id of this Configuration. The Default configuration used for this configuration.

Returns

The default_config_id of this Configuration.

Return type

str

property defined_tags

Gets the defined_tags of this Configuration. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this Configuration.

Return type

dict(str, dict(str, object))

property description

Gets the description of this Configuration. A description for the configuration.

Returns

The description of this Configuration.

Return type

str

property display_name

[Required] Gets the display_name of this Configuration. A user-friendly display name for the configuration. Avoid entering confidential information.

Returns

The display_name of this Configuration.

Return type

str

property freeform_tags

Gets the freeform_tags of this Configuration. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this Configuration.

Return type

dict(str, str)

property id

[Required] Gets the id of this Configuration. A unique identifier for the configuration. Immutable on creation.

Returns

The id of this Configuration.

Return type

str

property instance_memory_size_in_gbs

[Required] Gets the instance_memory_size_in_gbs of this Configuration. Memory size in gigabytes with 1GB increment.

It’s value is set to 0 if configuration is for a flexible shape.

Returns

The instance_memory_size_in_gbs of this Configuration.

Return type

int

property instance_ocpu_count

[Required] Gets the instance_ocpu_count of this Configuration. CPU core count.

It’s value is set to 0 if configuration is for a flexible shape.

Returns

The instance_ocpu_count of this Configuration.

Return type

int

property is_flexible

Gets the is_flexible of this Configuration. Whether the configuration supports flexible shapes.

Returns

The is_flexible of this Configuration.

Return type

bool

property lifecycle_details

Gets the lifecycle_details of this Configuration. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns

The lifecycle_details of this Configuration.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this Configuration. The current state of the configuration.

Allowed values for this property are: “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Configuration.

Return type

str

property shape

[Required] Gets the shape of this Configuration. The name of the shape for the configuration.

For multi-shape enabled configurations, it is set to PostgreSQL. Please use compatibleShapes property to get list of supported shapes for such configurations.

Returns

The shape of this Configuration.

Return type

str

property system_tags

Gets the system_tags of this Configuration. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this Configuration.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this Configuration. The date and time that the configuration was created, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_created of this Configuration.

Return type

datetime