Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Connection

Represents the common details required for creating a new connection.

Properties

compartmentId

compartmentId: string

The OCID of the compartment.

connectionType

connectionType: string

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

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

displayName

displayName: string

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

Optional freeformTags

freeformTags: undefined | object

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

id: string

The OCID of the connection being referenced.

Optional ingressIps

ingressIps: Array<IngressIpDetails>

List of ingress IP addresses from where to connect to this connection's privateIp.

Optional keyId

keyId: undefined | string

The OCID of the key used in cryptographic operations.

Optional lifecycleDetails

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

lifecycleState: LifecycleState

The Connection's current lifecycle state.

Optional nsgIds

nsgIds: Array<string>

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

Optional password

password: undefined | string

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

Optional privateEndpointId

privateEndpointId: undefined | string

The OCID of the resource being referenced.

Optional replicationPassword

replicationPassword: undefined | string

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

Optional replicationUsername

replicationUsername: undefined | string

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

Optional secretId

secretId: undefined | string

The OCID of the resource being referenced.

Optional subnetId

subnetId: undefined | string

OCI resource ID.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

timeCreated

timeCreated: Date

The time when this resource was created. An RFC3339 formatted datetime string such as {@code 2016-08-25T21:10:29.600Z}.

timeUpdated

timeUpdated: Date

The time when this resource was updated. An RFC3339 formatted datetime string such as {@code 2016-08-25T21:10:29.600Z}.

username

username: string

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

Optional vaultId

vaultId: undefined | string

OCI resource ID.

Functions

getDeserializedJsonObj

getJsonObj