Show / Hide Table of Contents

Class ClusterSummary

The properties that define a cluster summary.

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

Properties

AvailableKubernetesUpgrades

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

Available Kubernetes versions to which the clusters masters may be upgraded.

ClusterPodNetworkOptions

Declaration
[JsonProperty(PropertyName = "clusterPodNetworkOptions")]
public List<ClusterPodNetworkOptionDetails> ClusterPodNetworkOptions { get; set; }
Property Value
Type Description
List<ClusterPodNetworkOptionDetails>

Available CNIs and network options for existing and new node pools of the cluster

CompartmentId

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

The OCID of the compartment in which the cluster exists.

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

EndpointConfig

Declaration
[JsonProperty(PropertyName = "endpointConfig")]
public ClusterEndpointConfig EndpointConfig { get; set; }
Property Value
Type Description
ClusterEndpointConfig

The network configuration for access to the Cluster control plane.

Endpoints

Declaration
[JsonProperty(PropertyName = "endpoints")]
public ClusterEndpoints Endpoints { get; set; }
Property Value
Type Description
ClusterEndpoints

Endpoints served up by the cluster masters.

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
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the cluster.

ImagePolicyConfig

Declaration
[JsonProperty(PropertyName = "imagePolicyConfig")]
public ImagePolicyConfig ImagePolicyConfig { get; set; }
Property Value
Type Description
ImagePolicyConfig

The image verification policy for signature validation.

KubernetesVersion

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

The version of Kubernetes running on the cluster masters.

LifecycleDetails

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

Details about the state of the cluster masters.

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ClusterLifecycleState? LifecycleState { get; set; }
Property Value
Type Description
ClusterLifecycleState?

The state of the cluster masters. For more information, see Monitoring Clusters

Metadata

Declaration
[JsonProperty(PropertyName = "metadata")]
public ClusterMetadata Metadata { get; set; }
Property Value
Type Description
ClusterMetadata

Metadata about the cluster.

Name

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

The name of the cluster.

Options

Declaration
[JsonProperty(PropertyName = "options")]
public ClusterCreateOptions Options { get; set; }
Property Value
Type Description
ClusterCreateOptions

Optional attributes for the cluster.

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

Type

Declaration
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ClusterType? Type { get; set; }
Property Value
Type Description
ClusterType?

Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see Cluster Types

VcnId

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

The OCID of the virtual cloud network (VCN) in which the cluster exists

In this article
Back to top