Show / Hide Table of Contents

Class ExternalClusterInstance

The details of an external cluster instance.

Inheritance
object
ExternalClusterInstance
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DatabasemanagementService.Models
Assembly: OCI.DotNetSDK.Databasemanagement.dll
Syntax
public class ExternalClusterInstance

Properties

AdrHomeDirectory

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

The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.

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

ComponentName

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

The name of the external cluster instance.

Remarks

Required

CrsBaseDirectory

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

The Oracle base location of Cluster Ready Services (CRS).

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. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

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

The user-friendly name for the cluster instance. The name does not have to be unique.

Remarks

Required

ExternalClusterId

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

The OCID of the external cluster that the cluster instance belongs to.

Remarks

Required

ExternalConnectorId

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

The OCID of the external connector.

ExternalDbNodeId

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

The OCID of the external DB node.

ExternalDbSystemId

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

The OCID of the external DB system that the cluster instance is a part of.

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

HostName

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

The name of the host on which the cluster instance is running.

Id

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

The OCID of the external cluster instance.

Remarks

Required

LifecycleDetails

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

Additional information about the current lifecycle state.

LifecycleState

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

The current lifecycle state of the external cluster instance.

Remarks

Required

NodeRole

Declaration
[JsonProperty(PropertyName = "nodeRole")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ExternalClusterInstance.NodeRoleEnum? NodeRole { get; set; }
Property Value
Type Description
ExternalClusterInstance.NodeRoleEnum?

The role of the cluster node.

SystemTags

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

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

The date and time the external cluster instance was created.

TimeUpdated

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

The date and time the external cluster instance was last updated.

In this article
Back to top