DatabaseRegistration

class oci.golden_gate.models.DatabaseRegistration(**kwargs)

Bases: object

Represents the metadata description of a database used by deployments in the same compartment.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a DatabaseRegistration.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a DatabaseRegistration.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a DatabaseRegistration.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a DatabaseRegistration.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a DatabaseRegistration.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a DatabaseRegistration.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a DatabaseRegistration.
alias_name [Required] Gets the alias_name of this DatabaseRegistration.
compartment_id [Required] Gets the compartment_id of this DatabaseRegistration.
connection_string Gets the connection_string of this DatabaseRegistration.
database_id Gets the database_id of this DatabaseRegistration.
defined_tags Gets the defined_tags of this DatabaseRegistration.
description Gets the description of this DatabaseRegistration.
display_name [Required] Gets the display_name of this DatabaseRegistration.
fqdn [Required] Gets the fqdn of this DatabaseRegistration.
freeform_tags Gets the freeform_tags of this DatabaseRegistration.
id [Required] Gets the id of this DatabaseRegistration.
ip_address [Required] Gets the ip_address of this DatabaseRegistration.
key_id Gets the key_id of this DatabaseRegistration.
lifecycle_details Gets the lifecycle_details of this DatabaseRegistration.
lifecycle_state Gets the lifecycle_state of this DatabaseRegistration.
rce_private_ip Gets the rce_private_ip of this DatabaseRegistration.
secret_compartment_id Gets the secret_compartment_id of this DatabaseRegistration.
secret_id Gets the secret_id of this DatabaseRegistration.
subnet_id Gets the subnet_id of this DatabaseRegistration.
system_tags Gets the system_tags of this DatabaseRegistration.
time_created Gets the time_created of this DatabaseRegistration.
time_updated Gets the time_updated of this DatabaseRegistration.
username [Required] Gets the username of this DatabaseRegistration.
vault_id Gets the vault_id of this DatabaseRegistration.

Methods

__init__(**kwargs) Initializes a new DatabaseRegistration object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new DatabaseRegistration 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 DatabaseRegistration.
  • display_name (str) – The value to assign to the display_name property of this DatabaseRegistration.
  • description (str) – The value to assign to the description property of this DatabaseRegistration.
  • compartment_id (str) – The value to assign to the compartment_id property of this DatabaseRegistration.
  • time_created (datetime) – The value to assign to the time_created property of this DatabaseRegistration.
  • time_updated (datetime) – The value to assign to the time_updated property of this DatabaseRegistration.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseRegistration. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 DatabaseRegistration.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseRegistration.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseRegistration.
  • fqdn (str) – The value to assign to the fqdn property of this DatabaseRegistration.
  • ip_address (str) – The value to assign to the ip_address property of this DatabaseRegistration.
  • subnet_id (str) – The value to assign to the subnet_id property of this DatabaseRegistration.
  • database_id (str) – The value to assign to the database_id property of this DatabaseRegistration.
  • rce_private_ip (str) – The value to assign to the rce_private_ip property of this DatabaseRegistration.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseRegistration.
  • username (str) – The value to assign to the username property of this DatabaseRegistration.
  • connection_string (str) – The value to assign to the connection_string property of this DatabaseRegistration.
  • alias_name (str) – The value to assign to the alias_name property of this DatabaseRegistration.
  • vault_id (str) – The value to assign to the vault_id property of this DatabaseRegistration.
  • key_id (str) – The value to assign to the key_id property of this DatabaseRegistration.
  • secret_compartment_id (str) – The value to assign to the secret_compartment_id property of this DatabaseRegistration.
  • secret_id (str) – The value to assign to the secret_id property of this DatabaseRegistration.
alias_name

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

Returns:The alias_name of this DatabaseRegistration.
Return type:str
compartment_id

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

Returns:The compartment_id of this DatabaseRegistration.
Return type:str
connection_string

Gets the connection_string of this DatabaseRegistration. Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a database.

Returns:The connection_string of this DatabaseRegistration.
Return type:str
database_id

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

Returns:The database_id of this DatabaseRegistration.
Return type:str
defined_tags

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

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

Returns:The description of this DatabaseRegistration.
Return type:str
display_name

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

Returns:The display_name of this DatabaseRegistration.
Return type:str
fqdn

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

Returns:The fqdn of this DatabaseRegistration.
Return type:str
freeform_tags

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

[Required] Gets the id of this DatabaseRegistration. The OCID of the databaseRegistration being referenced.

Returns:The id of this DatabaseRegistration.
Return type:str
ip_address

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

Returns:The ip_address of this DatabaseRegistration.
Return type:str
key_id

Gets the key_id of this DatabaseRegistration. The OCID of the customer “Master” key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

Returns:The key_id of this DatabaseRegistration.
Return type:str
lifecycle_details

Gets the lifecycle_details of this DatabaseRegistration. Describes the object’s current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

Returns:The lifecycle_details of this DatabaseRegistration.
Return type:str
lifecycle_state

Gets the lifecycle_state of this DatabaseRegistration. Possible lifecycle states.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 DatabaseRegistration.
Return type:str
rce_private_ip

Gets the rce_private_ip of this DatabaseRegistration. A Private Endpoint IP Address created in the customer’s subnet. A customer database can expect network traffic initiated by GGS from this IP address and send network traffic to this IP address, typically in response to requests from GGS (OGG). The customer may utilize this IP address in Security Lists or Network Security Groups (NSG) as needed.

Returns:The rce_private_ip of this DatabaseRegistration.
Return type:str
secret_compartment_id

Gets the secret_compartment_id of this DatabaseRegistration. The OCID of the compartment where the the GGS Secret will be created. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Compartment in which to create a Secret.

Returns:The secret_compartment_id of this DatabaseRegistration.
Return type:str
secret_id

Gets the secret_id of this DatabaseRegistration. The OCID of the customer GGS Secret being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Secret

Returns:The secret_id of this DatabaseRegistration.
Return type:str
subnet_id

Gets the subnet_id of this DatabaseRegistration. The OCID of the subnet being referenced.

Returns:The subnet_id of this DatabaseRegistration.
Return type:str
system_tags

Gets the system_tags of this DatabaseRegistration. The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:The system_tags of this DatabaseRegistration.
Return type:dict(str, dict(str, object))
time_created

Gets the time_created of this DatabaseRegistration. The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:The time_created of this DatabaseRegistration.
Return type:datetime
time_updated

Gets the time_updated of this DatabaseRegistration. The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:The time_updated of this DatabaseRegistration.
Return type:datetime
username

[Required] Gets the username of this DatabaseRegistration. The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

Returns:The username of this DatabaseRegistration.
Return type:str
vault_id

Gets the vault_id of this DatabaseRegistration. The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

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