Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateOciObjectStorageConnectionDetails

The information to update a OCI Object Storage Connection.

Properties

Const connectionType

connectionType: string = "OCI_OBJECT_STORAGE"

Optional definedTags

definedTags: undefined | object

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}

Optional description

description: undefined | string

Metadata about this specific object.

Optional displayName

displayName: undefined | string

An object's Display Name.

Optional freeformTags

freeformTags: undefined | object

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {@code {\"bar-key\": \"value\"}}

Optional keyId

keyId: undefined | 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.

Optional nsgIds

nsgIds: Array<string>

An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Optional privateKeyFile

privateKeyFile: undefined | 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

Optional privateKeyPassphrase

privateKeyPassphrase: undefined | string

The passphrase of the private key.

Optional publicKeyFingerprint

publicKeyFingerprint: undefined | 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

Optional region

region: undefined | string

The name of the region. e.g.: us-ashburn-1

Optional routingMethod

routingMethod: model.RoutingMethod

Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

Optional subnetId

subnetId: undefined | string

The OCID of the target subnet of the dedicated connection.

Optional tenancyId

tenancyId: undefined | string

The OCID of the related OCI tenancy.

Optional userId

userId: undefined | 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.

Optional vaultId

vaultId: undefined | 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.

Methods

getDeserializedJsonObj

getJsonObj