Class UpdateOciObjectStorageConnectionDetails
The information to update a OCI Object Storage Connection.
Inherited Members
Namespace: Oci.GoldengateService.Models
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
public class UpdateOciObjectStorageConnectionDetails : UpdateConnectionDetails
Properties
PrivateKeyFile
Declaration
[JsonProperty(PropertyName = "privateKeyFile")]
public string PrivateKeyFile { get; set; }
Property Value
Type | Description |
---|---|
string | The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026. |
PrivateKeyFileSecretId
Declaration
[JsonProperty(PropertyName = "privateKeyFileSecretId")]
public string PrivateKeyFileSecretId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided. |
PrivateKeyPassphrase
Declaration
[JsonProperty(PropertyName = "privateKeyPassphrase")]
public string PrivateKeyPassphrase { get; set; }
Property Value
Type | Description |
---|---|
string | The passphrase of the private key. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026. |
PrivateKeyPassphraseSecretId
Declaration
[JsonProperty(PropertyName = "privateKeyPassphraseSecretId")]
public string PrivateKeyPassphraseSecretId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided. |
PublicKeyFingerprint
Declaration
[JsonProperty(PropertyName = "publicKeyFingerprint")]
public string PublicKeyFingerprint { get; set; }
Property Value
Type | Description |
---|---|
string | The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm |
Region
Declaration
[JsonProperty(PropertyName = "region")]
public string Region { get; set; }
Property Value
Type | Description |
---|---|
string | The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region. |
ShouldUseResourcePrincipal
Declaration
[JsonProperty(PropertyName = "shouldUseResourcePrincipal")]
public bool? ShouldUseResourcePrincipal { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates that the user intents to connect to the instance through resource principal. |
TenancyId
Declaration
[JsonProperty(PropertyName = "tenancyId")]
public string TenancyId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the related OCI tenancy. |
UserId
Declaration
[JsonProperty(PropertyName = "userId")]
public string UserId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the OCI user who will access the Object Storage. The user must have write access to the bucket they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint. |