Class CreateDb2ConnectionDetails

The information about a new DB2 Connection.

Inheritance

object

CreateConnectionDetails

CreateDb2ConnectionDetails

Inherited Members

CreateConnectionDetails.DisplayName

CreateConnectionDetails.Description

CreateConnectionDetails.CompartmentId

CreateConnectionDetails.FreeformTags

CreateConnectionDetails.DefinedTags

CreateConnectionDetails.Locks

CreateConnectionDetails.VaultId

CreateConnectionDetails.KeyId

CreateConnectionDetails.NsgIds

CreateConnectionDetails.SubnetId

CreateConnectionDetails.RoutingMethod

CreateConnectionDetails.DoesUseSecretIds

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GoldengateService.Models

Assembly: OCI.DotNetSDK.Goldengate.dll

Syntax

public class CreateDb2ConnectionDetails : CreateConnectionDetails

Properties

AdditionalAttributes

Declaration

[JsonProperty(PropertyName = "additionalAttributes")]
public List<NameValuePair> AdditionalAttributes { get; set; }

Property Value

Type	Description
List<NameValuePair>	An array of name-value pair attribute entries. Used as additional parameters in connection string.

DatabaseName

Declaration

[Required(ErrorMessage = "DatabaseName is required.")]
[JsonProperty(PropertyName = "databaseName")]
public string DatabaseName { get; set; }

Property Value

Type	Description
string	The name of the database.

Remarks

Required

Host

Declaration

[Required(ErrorMessage = "Host is required.")]
[JsonProperty(PropertyName = "host")]
public string Host { get; set; }

Property Value

Type	Description
string	The name or address of a host.

Remarks

Required

Password

Declaration

[JsonProperty(PropertyName = "password")]
public string Password { get; set; }

Property Value

Type	Description
string	The password Oracle GoldenGate uses to connect the associated DB2 database. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

PasswordSecretId

Declaration

[JsonProperty(PropertyName = "passwordSecretId")]
public string PasswordSecretId { get; set; }

Property Value

Type	Description
string	The OCID of the Secret where the password is stored, that Oracle GoldenGate uses to connect the associated DB2 database. Note: When provided, 'password' field must not be provided.

Port

Declaration

[Required(ErrorMessage = "Port is required.")]
[JsonProperty(PropertyName = "port")]
public int? Port { get; set; }

Property Value

Type	Description
int?	The port of an endpoint usually specified for a connection.

Remarks

Required

SecurityProtocol

Declaration

[Required(ErrorMessage = "SecurityProtocol is required.")]
[JsonProperty(PropertyName = "securityProtocol")]
[JsonConverter(typeof(StringEnumConverter))]
public Db2Connection.SecurityProtocolEnum? SecurityProtocol { get; set; }

Property Value

Type	Description
Db2Connection.SecurityProtocolEnum?	Security protocol for the DB2 database.

Remarks

Required

SslClientKeystash

Declaration

[JsonProperty(PropertyName = "sslClientKeystash")]
public string SslClientKeystash { get; set; }

Property Value

Type	Description
string	The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.

SslClientKeystashSecretId

Declaration

[JsonProperty(PropertyName = "sslClientKeystashSecretId")]
public string SslClientKeystashSecretId { get; set; }

Property Value

Type	Description
string	The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available. Note: When provided, 'sslClientKeystash' field must not be provided.

SslClientKeystoredb

Declaration

[JsonProperty(PropertyName = "sslClientKeystoredb")]
public string SslClientKeystoredb { get; set; }

Property Value

Type	Description
string	The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. This property is not supported for IBM Db2 for i, as client TLS mode is not available. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.

SslClientKeystoredbSecretId

Declaration

[JsonProperty(PropertyName = "sslClientKeystoredbSecretId")]
public string SslClientKeystoredbSecretId { get; set; }

Property Value

Type	Description
string	The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. This property is not supported for IBM Db2 for i, as client TLS mode is not available. Note: When provided, 'sslClientKeystoredb' field must not be provided.

SslServerCertificate

Declaration

[JsonProperty(PropertyName = "sslServerCertificate")]
public string SslServerCertificate { get; set; }

Property Value

Type	Description
string	The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate. It is not included in GET responses if the view=COMPACT query parameter is specified.

TechnologyType

Declaration

[Required(ErrorMessage = "TechnologyType is required.")]
[JsonProperty(PropertyName = "technologyType")]
[JsonConverter(typeof(StringEnumConverter))]
public Db2Connection.TechnologyTypeEnum? TechnologyType { get; set; }

Property Value

Type	Description
Db2Connection.TechnologyTypeEnum?	The DB2 technology type.

Remarks

Required

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 to the DB2 database. This username must already exist and be available by the DB2 to be connected to.

Remarks

Required