Class DatabaseRegistration

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

Inheritance
object
DatabaseRegistration
Inherited Members
Namespace: Oci.GoldengateService.Models
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
public class DatabaseRegistration

Properties

AliasName

Declaration
[Required(ErrorMessage = "AliasName is required.")]
[JsonProperty(PropertyName = "aliasName")]
public string AliasName { get; set; }
Property Value
Type Description
string

Credential store alias.
Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment being referenced.
Remarks

Required

ConnectionString

Declaration
[JsonProperty(PropertyName = "connectionString")]
public string ConnectionString { get; set; }
Property Value
Type Description
string

Connect descriptor or Easy Connect Naming method used to connect to a database.

DatabaseId

Declaration
[JsonProperty(PropertyName = "databaseId")]
public string DatabaseId { get; set; }
Property Value
Type Description
string

The OCID of the database being referenced.

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: {"foo-namespace": {"bar-key": "value"}}

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Metadata about this specific object.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

An object's Display Name.
Remarks

Required

Fqdn

Declaration
[Required(ErrorMessage = "Fqdn is required.")]
[JsonProperty(PropertyName = "fqdn")]
public string Fqdn { get; set; }
Property Value
Type Description
string

A three-label Fully Qualified Domain Name (FQDN) for a resource.
Remarks

Required

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: {"bar-key": "value"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the databaseRegistration being referenced.
Remarks

Required

IpAddress

Declaration
[Required(ErrorMessage = "IpAddress is required.")]
[JsonProperty(PropertyName = "ipAddress")]
public string IpAddress { get; set; }
Property Value
Type Description
string

The private IP address in the customer's VCN of the customer's endpoint, typically a database.
Remarks

Required

KeyId

Declaration
[JsonProperty(PropertyName = "keyId")]
public string KeyId { get; set; }
Property Value
Type Description
string

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.

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

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.

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type Description
LifecycleState?

Possible lifecycle states.

RcePrivateIp

Declaration
[JsonProperty(PropertyName = "rcePrivateIp")]
public string RcePrivateIp { get; set; }
Property Value
Type Description
string

A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.

SecretCompartmentId

Declaration
[JsonProperty(PropertyName = "secretCompartmentId")]
public string SecretCompartmentId { get; set; }
Property Value
Type Description
string

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.

SecretId

Declaration
[JsonProperty(PropertyName = "secretId")]
public string SecretId { get; set; }
Property Value
Type Description
string

The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.

SessionMode

Declaration
[JsonProperty(PropertyName = "sessionMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseRegistration.SessionModeEnum? SessionMode { get; set; }
Property Value
Type Description
DatabaseRegistration.SessionModeEnum?

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.

SubnetId

Declaration
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }
Property Value
Type Description
string

The OCID of the target subnet of the dedicated connection.

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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}}

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

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

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

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

Username

Declaration
[Required(ErrorMessage = "Username is required.")]
[JsonProperty(PropertyName = "username")]
public string Username { get; set; }
Property Value
Type Description
string

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.
Remarks

Required

VaultId

Declaration
[JsonProperty(PropertyName = "vaultId")]
public string VaultId { get; set; }
Property Value
Type Description
string

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.