/** * GoldenGate API * Use the Oracle Cloud Infrastructure GoldenGate APIs to perform data replication operations. * OpenAPI spec version: 20200407 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * Represents the metadata description of a connection used by deployments in the same compartment. * */ export interface Connection { /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being * referenced. * */ "id": string; /** * An object's Display Name. * */ "displayName": string; /** * Metadata about this specific object. * */ "description"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced. * */ "compartmentId": string; /** * 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\"}} * */ "freeformTags"?: { [key: string]: string; }; /** * Tags defined for this resource. Each key is predefined and scoped to a namespace. *

Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}} * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *

Example: {@code {orcl-cloud: {free-tier-retain: true}}} * */ "systemTags"?: { [key: string]: { [key: string]: any; }; }; /** * Possible lifecycle states for connection. * */ "lifecycleState": Connection.LifecycleState; /** * 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. * */ "lifecycleDetails"?: string; /** * The time the resource was created. The format is defined by * [RFC3339](https://tools.ietf.org/html/rfc3339), such as {@code 2016-08-25T21:10:29.600Z}. * */ "timeCreated": Date; /** * The time the resource was last updated. The format is defined by * [RFC3339](https://tools.ietf.org/html/rfc3339), such as {@code 2016-08-25T21:10:29.600Z}. * */ "timeUpdated": Date; /** * Locks associated with this resource. */ "locks"?: Array; /** * 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. * */ "vaultId"?: 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. * */ "keyId"?: string; /** * List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. * Customers may optionally set up ingress security rules to restrict traffic from these IP addresses. * */ "ingressIps"?: Array; /** * An array of Network Security Group OCIDs used to define network access for either Deployments or Connections. * */ "nsgIds"?: Array; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection. * */ "subnetId"?: string; /** * 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. * */ "routingMethod"?: model.RoutingMethod; /** * Indicates that sensitive attributes are provided via Secrets. * */ "doesUseSecretIds"?: boolean; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ "subscriptionId"?: string; /** * The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. * Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud * subscription id is provided. Otherwise the cluster placement group must not be provided. * */ "clusterPlacementGroupId"?: string; /** * Security attributes for this resource. Each key is predefined and scoped to a namespace. * For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *

Example: {@code {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}} * */ "securityAttributes"?: { [key: string]: { [key: string]: any; }; }; "connectionType": string; } export declare namespace Connection { enum LifecycleState { Creating = "CREATING", Updating = "UPDATING", Active = "ACTIVE", Deleting = "DELETING", Deleted = "DELETED", Failed = "FAILED", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: Connection): object; function getDeserializedJsonObj(obj: Connection): object; }