CreateDatabaseRegistrationDetails¶

class oci.golden_gate.models.CreateDatabaseRegistrationDetails(**kwargs)¶

Bases: object

The information about a new DatabaseRegistration.

Attributes

`SESSION_MODE_DIRECT`	A constant which can be used with the session_mode property of a CreateDatabaseRegistrationDetails.
`SESSION_MODE_REDIRECT`	A constant which can be used with the session_mode property of a CreateDatabaseRegistrationDetails.
`alias_name`	[Required] Gets the alias_name of this CreateDatabaseRegistrationDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateDatabaseRegistrationDetails.
`connection_string`	Gets the connection_string of this CreateDatabaseRegistrationDetails.
`database_id`	Gets the database_id of this CreateDatabaseRegistrationDetails.
`defined_tags`	Gets the defined_tags of this CreateDatabaseRegistrationDetails.
`description`	Gets the description of this CreateDatabaseRegistrationDetails.
`display_name`	[Required] Gets the display_name of this CreateDatabaseRegistrationDetails.
`fqdn`	[Required] Gets the fqdn of this CreateDatabaseRegistrationDetails.
`freeform_tags`	Gets the freeform_tags of this CreateDatabaseRegistrationDetails.
`ip_address`	Gets the ip_address of this CreateDatabaseRegistrationDetails.
`key_id`	Gets the key_id of this CreateDatabaseRegistrationDetails.
`password`	[Required] Gets the password of this CreateDatabaseRegistrationDetails.
`secret_compartment_id`	Gets the secret_compartment_id of this CreateDatabaseRegistrationDetails.
`session_mode`	Gets the session_mode of this CreateDatabaseRegistrationDetails.
`subnet_id`	Gets the subnet_id of this CreateDatabaseRegistrationDetails.
`username`	[Required] Gets the username of this CreateDatabaseRegistrationDetails.
`vault_id`	Gets the vault_id of this CreateDatabaseRegistrationDetails.
`wallet`	Gets the wallet of this CreateDatabaseRegistrationDetails.

Methods

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

SESSION_MODE_DIRECT = 'DIRECT'¶: A constant which can be used with the session_mode property of a CreateDatabaseRegistrationDetails. This constant has a value of “DIRECT”

SESSION_MODE_REDIRECT = 'REDIRECT'¶: A constant which can be used with the session_mode property of a CreateDatabaseRegistrationDetails. This constant has a value of “REDIRECT”

__init__(**kwargs)¶

Initializes a new CreateDatabaseRegistrationDetails object with values from keyword arguments. 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 CreateDatabaseRegistrationDetails.
description (str) – The value to assign to the description property of this CreateDatabaseRegistrationDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateDatabaseRegistrationDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDatabaseRegistrationDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDatabaseRegistrationDetails.
fqdn (str) – The value to assign to the fqdn property of this CreateDatabaseRegistrationDetails.
ip_address (str) – The value to assign to the ip_address property of this CreateDatabaseRegistrationDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateDatabaseRegistrationDetails.
database_id (str) – The value to assign to the database_id property of this CreateDatabaseRegistrationDetails.
username (str) – The value to assign to the username property of this CreateDatabaseRegistrationDetails.
password (str) – The value to assign to the password property of this CreateDatabaseRegistrationDetails.
connection_string (str) – The value to assign to the connection_string property of this CreateDatabaseRegistrationDetails.
session_mode (str) – The value to assign to the session_mode property of this CreateDatabaseRegistrationDetails. Allowed values for this property are: “DIRECT”, “REDIRECT”
wallet (str) – The value to assign to the wallet property of this CreateDatabaseRegistrationDetails.
alias_name (str) – The value to assign to the alias_name property of this CreateDatabaseRegistrationDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateDatabaseRegistrationDetails.
key_id (str) – The value to assign to the key_id property of this CreateDatabaseRegistrationDetails.
secret_compartment_id (str) – The value to assign to the secret_compartment_id property of this CreateDatabaseRegistrationDetails.

alias_name¶

[Required] Gets the alias_name of this CreateDatabaseRegistrationDetails. Credential store alias.

Returns:	The alias_name of this CreateDatabaseRegistrationDetails.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this CreateDatabaseRegistrationDetails. The OCID of the compartment being referenced.

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

connection_string¶

Gets the connection_string of this CreateDatabaseRegistrationDetails. Connect descriptor or Easy Connect Naming method used to connect to a database.

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

database_id¶

Gets the database_id of this CreateDatabaseRegistrationDetails. The OCID of the database being referenced.

Returns:	The database_id of this CreateDatabaseRegistrationDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateDatabaseRegistrationDetails. Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateDatabaseRegistrationDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this CreateDatabaseRegistrationDetails. Metadata about this specific object.

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

display_name¶

[Required] Gets the display_name of this CreateDatabaseRegistrationDetails. An object’s Display Name.

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

fqdn¶

[Required] Gets the fqdn of this CreateDatabaseRegistrationDetails. A three-label Fully Qualified Domain Name (FQDN) for a resource.

Returns:	The fqdn of this CreateDatabaseRegistrationDetails.
Return type:	str

freeform_tags¶

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

ip_address¶

Gets the ip_address of this CreateDatabaseRegistrationDetails. The private IP address in the customer’s VCN of the customer’s endpoint, typically a database.

Returns:	The ip_address of this CreateDatabaseRegistrationDetails.
Return type:	str

key_id¶

Gets the key_id of this CreateDatabaseRegistrationDetails. Refers to the customer’s master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

Returns:	The key_id of this CreateDatabaseRegistrationDetails.
Return type:	str

password¶

[Required] Gets the password of this CreateDatabaseRegistrationDetails. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on.

Returns:	The password of this CreateDatabaseRegistrationDetails.
Return type:	str

secret_compartment_id¶

Gets the secret_compartment_id of this CreateDatabaseRegistrationDetails. The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

Returns:	The secret_compartment_id of this CreateDatabaseRegistrationDetails.
Return type:	str

session_mode¶

Gets the session_mode of this CreateDatabaseRegistrationDetails. The mode of the database connection session to be established by the data client. ‘REDIRECT’ - for a RAC database, ‘DIRECT’ - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

Allowed values for this property are: “DIRECT”, “REDIRECT”

Returns:	The session_mode of this CreateDatabaseRegistrationDetails.
Return type:	str

subnet_id¶

Gets the subnet_id of this CreateDatabaseRegistrationDetails. The OCID of the target subnet of the dedicated connection.

Returns:	The subnet_id of this CreateDatabaseRegistrationDetails.
Return type:	str

username¶

[Required] Gets the username of this CreateDatabaseRegistrationDetails. The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.

Returns:	The username of this CreateDatabaseRegistrationDetails.
Return type:	str

vault_id¶

Gets the vault_id of this CreateDatabaseRegistrationDetails. Refers to the customer’s vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

Returns:	The vault_id of this CreateDatabaseRegistrationDetails.
Return type:	str

wallet¶

Gets the wallet of this CreateDatabaseRegistrationDetails. The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

Returns:	The wallet of this CreateDatabaseRegistrationDetails.
Return type:	str