ClusterSummary

class oci.container_engine.models.ClusterSummary(**kwargs)

Bases: object

The properties that define a cluster summary.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a ClusterSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a ClusterSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a ClusterSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a ClusterSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a ClusterSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a ClusterSummary.

TYPE_BASIC_CLUSTER

A constant which can be used with the type property of a ClusterSummary.

TYPE_ENHANCED_CLUSTER

A constant which can be used with the type property of a ClusterSummary.

available_kubernetes_upgrades

Gets the available_kubernetes_upgrades of this ClusterSummary.

cluster_pod_network_options

Gets the cluster_pod_network_options of this ClusterSummary.

compartment_id

Gets the compartment_id of this ClusterSummary.

defined_tags

Gets the defined_tags of this ClusterSummary.

endpoint_config

Gets the endpoint_config of this ClusterSummary.

endpoints

Gets the endpoints of this ClusterSummary.

freeform_tags

Gets the freeform_tags of this ClusterSummary.

id

Gets the id of this ClusterSummary.

image_policy_config

Gets the image_policy_config of this ClusterSummary.

kubernetes_version

Gets the kubernetes_version of this ClusterSummary.

lifecycle_details

Gets the lifecycle_details of this ClusterSummary.

lifecycle_state

Gets the lifecycle_state of this ClusterSummary.

metadata

Gets the metadata of this ClusterSummary.

name

Gets the name of this ClusterSummary.

options

Gets the options of this ClusterSummary.

system_tags

Gets the system_tags of this ClusterSummary.

type

Gets the type of this ClusterSummary.

vcn_id

Gets the vcn_id of this ClusterSummary.

Methods:

__init__(**kwargs)

Initializes a new ClusterSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of “UPDATING”

TYPE_BASIC_CLUSTER = 'BASIC_CLUSTER'

A constant which can be used with the type property of a ClusterSummary. This constant has a value of “BASIC_CLUSTER”

TYPE_ENHANCED_CLUSTER = 'ENHANCED_CLUSTER'

A constant which can be used with the type property of a ClusterSummary. This constant has a value of “ENHANCED_CLUSTER”

__init__(**kwargs)

Initializes a new ClusterSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this ClusterSummary.

  • name (str) – The value to assign to the name property of this ClusterSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this ClusterSummary.

  • endpoint_config (oci.container_engine.models.ClusterEndpointConfig) – The value to assign to the endpoint_config property of this ClusterSummary.

  • vcn_id (str) – The value to assign to the vcn_id property of this ClusterSummary.

  • kubernetes_version (str) – The value to assign to the kubernetes_version property of this ClusterSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ClusterSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ClusterSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ClusterSummary.

  • options (oci.container_engine.models.ClusterCreateOptions) – The value to assign to the options property of this ClusterSummary.

  • metadata (oci.container_engine.models.ClusterMetadata) – The value to assign to the metadata property of this ClusterSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ClusterSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “FAILED”, “DELETING”, “DELETED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this ClusterSummary.

  • endpoints (oci.container_engine.models.ClusterEndpoints) – The value to assign to the endpoints property of this ClusterSummary.

  • available_kubernetes_upgrades (list[str]) – The value to assign to the available_kubernetes_upgrades property of this ClusterSummary.

  • image_policy_config (oci.container_engine.models.ImagePolicyConfig) – The value to assign to the image_policy_config property of this ClusterSummary.

  • cluster_pod_network_options (list[oci.container_engine.models.ClusterPodNetworkOptionDetails]) – The value to assign to the cluster_pod_network_options property of this ClusterSummary.

  • type (str) – The value to assign to the type property of this ClusterSummary. Allowed values for this property are: “BASIC_CLUSTER”, “ENHANCED_CLUSTER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property available_kubernetes_upgrades

Gets the available_kubernetes_upgrades of this ClusterSummary. Available Kubernetes versions to which the clusters masters may be upgraded.

Returns

The available_kubernetes_upgrades of this ClusterSummary.

Return type

list[str]

property cluster_pod_network_options

Gets the cluster_pod_network_options of this ClusterSummary. Available CNIs and network options for existing and new node pools of the cluster

Returns

The cluster_pod_network_options of this ClusterSummary.

Return type

list[oci.container_engine.models.ClusterPodNetworkOptionDetails]

property compartment_id

Gets the compartment_id of this ClusterSummary. The OCID of the compartment in which the cluster exists.

Returns

The compartment_id of this ClusterSummary.

Return type

str

property defined_tags

Gets the defined_tags of this ClusterSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this ClusterSummary.

Return type

dict(str, dict(str, object))

property endpoint_config

Gets the endpoint_config of this ClusterSummary. The network configuration for access to the Cluster control plane.

Returns

The endpoint_config of this ClusterSummary.

Return type

oci.container_engine.models.ClusterEndpointConfig

property endpoints

Gets the endpoints of this ClusterSummary. Endpoints served up by the cluster masters.

Returns

The endpoints of this ClusterSummary.

Return type

oci.container_engine.models.ClusterEndpoints

property freeform_tags

Gets the freeform_tags of this ClusterSummary. 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”}

Returns

The freeform_tags of this ClusterSummary.

Return type

dict(str, str)

property id

Gets the id of this ClusterSummary. The OCID of the cluster.

Returns

The id of this ClusterSummary.

Return type

str

property image_policy_config

Gets the image_policy_config of this ClusterSummary. The image verification policy for signature validation.

Returns

The image_policy_config of this ClusterSummary.

Return type

oci.container_engine.models.ImagePolicyConfig

property kubernetes_version

Gets the kubernetes_version of this ClusterSummary. The version of Kubernetes running on the cluster masters.

Returns

The kubernetes_version of this ClusterSummary.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this ClusterSummary. Details about the state of the cluster masters.

Returns

The lifecycle_details of this ClusterSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this ClusterSummary. The state of the cluster masters. For more information, see Monitoring Clusters

Allowed values for this property are: “CREATING”, “ACTIVE”, “FAILED”, “DELETING”, “DELETED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this ClusterSummary.

Return type

str

property metadata

Gets the metadata of this ClusterSummary. Metadata about the cluster.

Returns

The metadata of this ClusterSummary.

Return type

oci.container_engine.models.ClusterMetadata

property name

Gets the name of this ClusterSummary. The name of the cluster.

Returns

The name of this ClusterSummary.

Return type

str

property options

Gets the options of this ClusterSummary. Optional attributes for the cluster.

Returns

The options of this ClusterSummary.

Return type

oci.container_engine.models.ClusterCreateOptions

property system_tags

Gets the system_tags of this ClusterSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this ClusterSummary.

Return type

dict(str, dict(str, object))

property type

Gets the type of this ClusterSummary. Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see Cluster Types

Allowed values for this property are: “BASIC_CLUSTER”, “ENHANCED_CLUSTER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The type of this ClusterSummary.

Return type

str

property vcn_id

Gets the vcn_id of this ClusterSummary. The OCID of the virtual cloud network (VCN) in which the cluster exists

Returns

The vcn_id of this ClusterSummary.

Return type

str