CreateDatabaseToolsConnectionPostgresqlDetails¶

class oci.database_tools.models.CreateDatabaseToolsConnectionPostgresqlDetails(**kwargs)¶

Bases: oci.database_tools.models.create_database_tools_connection_details.CreateDatabaseToolsConnectionDetails

Details of the new Database Tools connection for a PostgreSQL Server.

Attributes

`RUNTIME_IDENTITY_AUTHENTICATED_PRINCIPAL`	str(object=’’) -> str
`RUNTIME_IDENTITY_RESOURCE_PRINCIPAL`	str(object=’’) -> str
`RUNTIME_SUPPORT_SUPPORTED`	str(object=’’) -> str
`RUNTIME_SUPPORT_UNSUPPORTED`	str(object=’’) -> str
`TYPE_GENERIC_JDBC`	str(object=’’) -> str
`TYPE_MYSQL`	str(object=’’) -> str
`TYPE_ORACLE_DATABASE`	str(object=’’) -> str
`TYPE_POSTGRESQL`	str(object=’’) -> str
`advanced_properties`	Gets the advanced_properties of this CreateDatabaseToolsConnectionPostgresqlDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateDatabaseToolsConnectionDetails.
`connection_string`	[Required] Gets the connection_string of this CreateDatabaseToolsConnectionPostgresqlDetails.
`defined_tags`	Gets the defined_tags of this CreateDatabaseToolsConnectionDetails.
`display_name`	[Required] Gets the display_name of this CreateDatabaseToolsConnectionDetails.
`freeform_tags`	Gets the freeform_tags of this CreateDatabaseToolsConnectionDetails.
`key_stores`	Gets the key_stores of this CreateDatabaseToolsConnectionPostgresqlDetails.
`locks`	Gets the locks of this CreateDatabaseToolsConnectionDetails.
`private_endpoint_id`	Gets the private_endpoint_id of this CreateDatabaseToolsConnectionPostgresqlDetails.
`related_resource`	Gets the related_resource of this CreateDatabaseToolsConnectionPostgresqlDetails.
`runtime_identity`	Gets the runtime_identity of this CreateDatabaseToolsConnectionDetails.
`runtime_support`	Gets the runtime_support of this CreateDatabaseToolsConnectionDetails.
`type`	[Required] Gets the type of this CreateDatabaseToolsConnectionDetails.
`user_name`	[Required] Gets the user_name of this CreateDatabaseToolsConnectionPostgresqlDetails.
`user_password`	[Required] Gets the user_password of this CreateDatabaseToolsConnectionPostgresqlDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateDatabaseToolsConnectionPostgresqlDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

RUNTIME_IDENTITY_AUTHENTICATED_PRINCIPAL = 'AUTHENTICATED_PRINCIPAL'¶

RUNTIME_IDENTITY_RESOURCE_PRINCIPAL = 'RESOURCE_PRINCIPAL'¶

RUNTIME_SUPPORT_SUPPORTED = 'SUPPORTED'¶

RUNTIME_SUPPORT_UNSUPPORTED = 'UNSUPPORTED'¶

TYPE_GENERIC_JDBC = 'GENERIC_JDBC'¶

TYPE_MYSQL = 'MYSQL'¶

TYPE_ORACLE_DATABASE = 'ORACLE_DATABASE'¶

TYPE_POSTGRESQL = 'POSTGRESQL'¶

__init__(**kwargs)¶

Initializes a new CreateDatabaseToolsConnectionPostgresqlDetails object with values from keyword arguments. The default value of the type attribute of this class is POSTGRESQL and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateDatabaseToolsConnectionPostgresqlDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateDatabaseToolsConnectionPostgresqlDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDatabaseToolsConnectionPostgresqlDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDatabaseToolsConnectionPostgresqlDetails.
locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this CreateDatabaseToolsConnectionPostgresqlDetails.
type (str) – The value to assign to the type property of this CreateDatabaseToolsConnectionPostgresqlDetails. Allowed values for this property are: “ORACLE_DATABASE”, “MYSQL”, “POSTGRESQL”, “GENERIC_JDBC”
runtime_support (str) – The value to assign to the runtime_support property of this CreateDatabaseToolsConnectionPostgresqlDetails. Allowed values for this property are: “SUPPORTED”, “UNSUPPORTED”
runtime_identity (str) – The value to assign to the runtime_identity property of this CreateDatabaseToolsConnectionPostgresqlDetails. Allowed values for this property are: “AUTHENTICATED_PRINCIPAL”, “RESOURCE_PRINCIPAL”
related_resource (oci.database_tools.models.CreateDatabaseToolsRelatedResourcePostgresqlDetails) – The value to assign to the related_resource property of this CreateDatabaseToolsConnectionPostgresqlDetails.
connection_string (str) – The value to assign to the connection_string property of this CreateDatabaseToolsConnectionPostgresqlDetails.
user_name (str) – The value to assign to the user_name property of this CreateDatabaseToolsConnectionPostgresqlDetails.
user_password (oci.database_tools.models.DatabaseToolsUserPasswordDetails) – The value to assign to the user_password property of this CreateDatabaseToolsConnectionPostgresqlDetails.
advanced_properties (dict(str, str)) – The value to assign to the advanced_properties property of this CreateDatabaseToolsConnectionPostgresqlDetails.
key_stores (list[oci.database_tools.models.DatabaseToolsKeyStorePostgresqlDetails]) – The value to assign to the key_stores property of this CreateDatabaseToolsConnectionPostgresqlDetails.
private_endpoint_id (str) – The value to assign to the private_endpoint_id property of this CreateDatabaseToolsConnectionPostgresqlDetails.

advanced_properties¶

Gets the advanced_properties of this CreateDatabaseToolsConnectionPostgresqlDetails. The advanced connection properties key-value pair (e.g., sslMode).

Returns:	The advanced_properties of this CreateDatabaseToolsConnectionPostgresqlDetails.
Return type:	dict(str, str)

compartment_id¶

[Required] Gets the compartment_id of this CreateDatabaseToolsConnectionDetails. The OCID of the compartment containing the Database Tools connection.

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

connection_string¶

[Required] Gets the connection_string of this CreateDatabaseToolsConnectionPostgresqlDetails. The connection string used to connect to the PostgreSQL Server.

Returns:	The connection_string of this CreateDatabaseToolsConnectionPostgresqlDetails.
Return type:	str

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this CreateDatabaseToolsConnectionDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

freeform_tags¶

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

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

key_stores¶

Gets the key_stores of this CreateDatabaseToolsConnectionPostgresqlDetails. The CA certificate to verify the server’s certificate and the client private key and associated certificate required for client authentication.

Returns:	The key_stores of this CreateDatabaseToolsConnectionPostgresqlDetails.
Return type:	list[oci.database_tools.models.DatabaseToolsKeyStorePostgresqlDetails]

locks¶

Gets the locks of this CreateDatabaseToolsConnectionDetails. Locks associated with this resource.

Returns:	The locks of this CreateDatabaseToolsConnectionDetails.
Return type:	list[oci.database_tools.models.ResourceLock]

private_endpoint_id¶

Gets the private_endpoint_id of this CreateDatabaseToolsConnectionPostgresqlDetails. The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

Returns:	The private_endpoint_id of this CreateDatabaseToolsConnectionPostgresqlDetails.
Return type:	str

related_resource¶

Gets the related_resource of this CreateDatabaseToolsConnectionPostgresqlDetails.

Returns:	The related_resource of this CreateDatabaseToolsConnectionPostgresqlDetails.
Return type:	oci.database_tools.models.CreateDatabaseToolsRelatedResourcePostgresqlDetails

runtime_identity¶

Gets the runtime_identity of this CreateDatabaseToolsConnectionDetails. Specifies the identity used by the Database Tools service to issue requests to other OCI services (e.g., Secrets in Vault).

Allowed values for this property are: “AUTHENTICATED_PRINCIPAL”, “RESOURCE_PRINCIPAL”

Returns:	The runtime_identity of this CreateDatabaseToolsConnectionDetails.
Return type:	str

runtime_support¶

Gets the runtime_support of this CreateDatabaseToolsConnectionDetails. Specifies whether this connection is supported by the Database Tools Runtime.

Allowed values for this property are: “SUPPORTED”, “UNSUPPORTED”

Returns:	The runtime_support of this CreateDatabaseToolsConnectionDetails.
Return type:	str

type¶

[Required] Gets the type of this CreateDatabaseToolsConnectionDetails. The Database Tools connection type.

Allowed values for this property are: “ORACLE_DATABASE”, “MYSQL”, “POSTGRESQL”, “GENERIC_JDBC”

Returns:	The type of this CreateDatabaseToolsConnectionDetails.
Return type:	str

user_name¶

[Required] Gets the user_name of this CreateDatabaseToolsConnectionPostgresqlDetails. The database user name.

Returns:	The user_name of this CreateDatabaseToolsConnectionPostgresqlDetails.
Return type:	str

user_password¶

[Required] Gets the user_password of this CreateDatabaseToolsConnectionPostgresqlDetails.

Returns:	The user_password of this CreateDatabaseToolsConnectionPostgresqlDetails.
Return type:	oci.database_tools.models.DatabaseToolsUserPasswordDetails