Class CreateDatabaseRegistrationDetails

The information about a new DatabaseRegistration.

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

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

IpAddress

Declaration
[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.

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.

Password

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

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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Remarks

Required

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.

SessionMode

Declaration
[JsonProperty(PropertyName = "sessionMode")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateDatabaseRegistrationDetails.SessionModeEnum? SessionMode { get; set; }
Property Value
Type Description
CreateDatabaseRegistrationDetails.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.

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.

Wallet

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

The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.