Class Connection

Represents the common details required for creating a new connection.

Inheritance

object

Connection

MysqlConnection

OracleConnection

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatabasemigrationService.Models

Assembly: OCI.DotNetSDK.Databasemigration.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.

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>>	Defined tags 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	A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

DisplayName

Declaration

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

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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 to connect to this connection's privateIp.

KeyId

Declaration

[JsonProperty(PropertyName = "keyId")]
public string KeyId { get; set; }

Property Value

Type	Description
string	The OCID of the key used in cryptographic operations.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection 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?	The Connection's current lifecycle state.

Remarks

Required

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 Connections.

Password

Declaration

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

Property Value

Type	Description
string	The password (credential) used when creating or updating this resource.

PrivateEndpointId

Declaration

[JsonProperty(PropertyName = "privateEndpointId")]
public string PrivateEndpointId { get; set; }

Property Value

Type	Description
string	The OCID of the resource being referenced.

ReplicationPassword

Declaration

[JsonProperty(PropertyName = "replicationPassword")]
public string ReplicationPassword { get; set; }

Property Value

Type	Description
string	The password (credential) used when creating or updating this resource.

ReplicationUsername

Declaration

[JsonProperty(PropertyName = "replicationUsername")]
public string ReplicationUsername { get; set; }

Property Value

Type	Description
string	The username (credential) used when creating or updating this resource.

SecretId

Declaration

[JsonProperty(PropertyName = "secretId")]
public string SecretId { get; set; }

Property Value

Type	Description
string	The OCID of the resource being referenced.

SubnetId

Declaration

[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }

Property Value

Type	Description
string	OCI resource ID.

SystemTags

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	The time when this resource was created. An RFC3339 formatted datetime string 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 when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

Remarks

Required

Username

Declaration

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

Property Value

Type	Description
string	The username (credential) used when creating or updating this resource.

Remarks

Required

VaultId

Declaration

[JsonProperty(PropertyName = "vaultId")]
public string VaultId { get; set; }

Property Value

Type	Description
string	OCI resource ID.