Class Connection

Represents the metadata description of a connection used by deployments in the same compartment.

Inheritance
object
Connection
AmazonKinesisConnection
AmazonRedshiftConnection
AmazonS3Connection
AzureDataLakeStorageConnection
AzureSynapseConnection
Db2Connection
ElasticsearchConnection
GenericConnection
GoldenGateConnection
GoogleBigQueryConnection
GoogleCloudStorageConnection
HdfsConnection
JavaMessageServiceConnection
KafkaConnection
KafkaSchemaRegistryConnection
MicrosoftSqlserverConnection
MongoDbConnection
MysqlConnection
OciObjectStorageConnection
OracleConnection
OracleNosqlConnection
PostgresqlConnection
RedisConnection
SnowflakeConnection
Inherited Members
Namespace: Oci.GoldengateService.Models
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
[JsonConverter(typeof(ConnectionModelConverter))]
public class Connection

Properties

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

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

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

Id

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

The OCID of the connection being referenced.
Remarks

Required

IngressIps

Declaration
[JsonProperty(PropertyName = "ingressIps")]
public List<IngressIpDetails> IngressIps { get; set; }
Property Value
Type Description
List<IngressIpDetails>

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.

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.

LifecycleDetails

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

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.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Connection.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Connection.LifecycleStateEnum?

Possible lifecycle states for connection.
Remarks

Required

Locks

Declaration
[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }
Property Value
Type Description
List<ResourceLock>

Locks associated with this resource.

NsgIds

Declaration
[JsonProperty(PropertyName = "nsgIds")]
public List<string> NsgIds { get; set; }
Property Value
Type Description
List<string>

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

RoutingMethod

Declaration
[JsonProperty(PropertyName = "routingMethod")]
[JsonConverter(typeof(ResponseEnumConverter))]
public RoutingMethod? RoutingMethod { get; set; }
Property Value
Type Description
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.

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.

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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.
Example: {orcl-cloud: {free-tier-retain: true}}

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
Remarks

Required

TimeUpdated

Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
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.