DbSystem¶

class oci.psql.models.DbSystem(**kwargs)¶

Bases: object

Information about a database system.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DbSystem.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DbSystem.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DbSystem.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DbSystem.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DbSystem.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DbSystem.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a DbSystem.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DbSystem.
`SYSTEM_TYPE_OCI_OPTIMIZED_STORAGE`	A constant which can be used with the system_type property of a DbSystem.
`admin_username`	Gets the admin_username of this DbSystem.
`compartment_id`	[Required] Gets the compartment_id of this DbSystem.
`config_id`	Gets the config_id of this DbSystem.
`db_version`	[Required] Gets the db_version of this DbSystem.
`defined_tags`	Gets the defined_tags of this DbSystem.
`description`	Gets the description of this DbSystem.
`display_name`	[Required] Gets the display_name of this DbSystem.
`freeform_tags`	Gets the freeform_tags of this DbSystem.
`id`	[Required] Gets the id of this DbSystem.
`instance_count`	Gets the instance_count of this DbSystem.
`instance_memory_size_in_gbs`	[Required] Gets the instance_memory_size_in_gbs of this DbSystem.
`instance_ocpu_count`	[Required] Gets the instance_ocpu_count of this DbSystem.
`instances`	Gets the instances of this DbSystem.
`lifecycle_details`	Gets the lifecycle_details of this DbSystem.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DbSystem.
`management_policy`	[Required] Gets the management_policy of this DbSystem.
`network_details`	[Required] Gets the network_details of this DbSystem.
`shape`	[Required] Gets the shape of this DbSystem.
`source`	Gets the source of this DbSystem.
`storage_details`	[Required] Gets the storage_details of this DbSystem.
`system_tags`	Gets the system_tags of this DbSystem.
`system_type`	[Required] Gets the system_type of this DbSystem.
`time_created`	[Required] Gets the time_created of this DbSystem.
`time_updated`	Gets the time_updated of this DbSystem.

Methods

__init__(**kwargs) Initializes a new DbSystem object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “UPDATING”

SYSTEM_TYPE_OCI_OPTIMIZED_STORAGE = 'OCI_OPTIMIZED_STORAGE'¶: A constant which can be used with the system_type property of a DbSystem. This constant has a value of “OCI_OPTIMIZED_STORAGE”

__init__(**kwargs)¶

Initializes a new DbSystem 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 DbSystem.
display_name (str) – The value to assign to the display_name property of this DbSystem.
description (str) – The value to assign to the description property of this DbSystem.
compartment_id (str) – The value to assign to the compartment_id property of this DbSystem.
time_created (datetime) – The value to assign to the time_created property of this DbSystem.
time_updated (datetime) – The value to assign to the time_updated property of this DbSystem.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DbSystem. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘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 DbSystem.
admin_username (str) – The value to assign to the admin_username property of this DbSystem.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DbSystem.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DbSystem.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DbSystem.
system_type (str) – The value to assign to the system_type property of this DbSystem. Allowed values for this property are: “OCI_OPTIMIZED_STORAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
db_version (str) – The value to assign to the db_version property of this DbSystem.
config_id (str) – The value to assign to the config_id property of this DbSystem.
shape (str) – The value to assign to the shape property of this DbSystem.
instance_ocpu_count (int) – The value to assign to the instance_ocpu_count property of this DbSystem.
instance_memory_size_in_gbs (int) – The value to assign to the instance_memory_size_in_gbs property of this DbSystem.
instance_count (int) – The value to assign to the instance_count property of this DbSystem.
instances (list[oci.psql.models.DbInstance]) – The value to assign to the instances property of this DbSystem.
storage_details (oci.psql.models.StorageDetails) – The value to assign to the storage_details property of this DbSystem.
network_details (oci.psql.models.NetworkDetails) – The value to assign to the network_details property of this DbSystem.
management_policy (oci.psql.models.ManagementPolicy) – The value to assign to the management_policy property of this DbSystem.
source (oci.psql.models.SourceDetails) – The value to assign to the source property of this DbSystem.

admin_username¶

Gets the admin_username of this DbSystem. The database system administrator username.

Returns:	The admin_username of this DbSystem.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this DbSystem. The OCID of the compartment that contains the database system.

Returns:	The compartment_id of this DbSystem.
Return type:	str

config_id¶

Gets the config_id of this DbSystem. The OCID of the configuration associated with the database system.

Returns:	The config_id of this DbSystem.
Return type:	str

db_version¶

[Required] Gets the db_version of this DbSystem. The major and minor versions of the database system software.

Returns:	The db_version of this DbSystem.
Return type:	str

defined_tags¶

Gets the defined_tags of this DbSystem. 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 DbSystem.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this DbSystem. A description of the database system.

Returns:	The description of this DbSystem.
Return type:	str

display_name¶

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

Returns:	The display_name of this DbSystem.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this DbSystem. 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 DbSystem.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this DbSystem. A unique identifier for the database system. Immutable on creation.

Returns:	The id of this DbSystem.
Return type:	str

instance_count¶

Gets the instance_count of this DbSystem. Count of instances, or nodes, in the database system.

Returns:	The instance_count of this DbSystem.
Return type:	int

instance_memory_size_in_gbs¶

[Required] Gets the instance_memory_size_in_gbs of this DbSystem. The total amount of memory available to each database instance node, in gigabytes.

Returns:	The instance_memory_size_in_gbs of this DbSystem.
Return type:	int

instance_ocpu_count¶

[Required] Gets the instance_ocpu_count of this DbSystem. The total number of OCPUs available to each database instance node.

Returns:	The instance_ocpu_count of this DbSystem.
Return type:	int

instances¶

Gets the instances of this DbSystem. The list of instances, or nodes, in the database system.

Returns:	The instances of this DbSystem.
Return type:	list[oci.psql.models.DbInstance]

lifecycle_details¶

Gets the lifecycle_details of this DbSystem. 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 DbSystem.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DbSystem. The current state of the database system.

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

Returns:	The lifecycle_state of this DbSystem.
Return type:	str

management_policy¶

[Required] Gets the management_policy of this DbSystem.

Returns:	The management_policy of this DbSystem.
Return type:	oci.psql.models.ManagementPolicy

network_details¶

[Required] Gets the network_details of this DbSystem.

Returns:	The network_details of this DbSystem.
Return type:	oci.psql.models.NetworkDetails

shape¶

[Required] Gets the shape of this DbSystem. The name of the shape for the database instance. Example: VM.Standard.E4.Flex

Returns:	The shape of this DbSystem.
Return type:	str

source¶

Gets the source of this DbSystem.

Returns:	The source of this DbSystem.
Return type:	oci.psql.models.SourceDetails

storage_details¶

[Required] Gets the storage_details of this DbSystem.

Returns:	The storage_details of this DbSystem.
Return type:	oci.psql.models.StorageDetails

system_tags¶

Gets the system_tags of this DbSystem. 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 DbSystem.
Return type:	dict(str, dict(str, object))

system_type¶

[Required] Gets the system_type of this DbSystem. Type of the database system.

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

Returns:	The system_type of this DbSystem.
Return type:	str

time_created¶

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

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

Returns:	The time_created of this DbSystem.
Return type:	datetime

time_updated¶

Gets the time_updated of this DbSystem. The date and time that the database system was updated, expressed in RFC 3339 timestamp format.

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

Returns:	The time_updated of this DbSystem.
Return type:	datetime