Cluster

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

Bases: object

A Kubernetes cluster. Avoid entering confidential information.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Cluster.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a Cluster.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Cluster.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a Cluster.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a Cluster.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a Cluster.
available_kubernetes_upgrades Gets the available_kubernetes_upgrades of this Cluster.
compartment_id Gets the compartment_id of this Cluster.
defined_tags Gets the defined_tags of this Cluster.
endpoint_config Gets the endpoint_config of this Cluster.
endpoints Gets the endpoints of this Cluster.
freeform_tags Gets the freeform_tags of this Cluster.
id Gets the id of this Cluster.
image_policy_config Gets the image_policy_config of this Cluster.
kms_key_id Gets the kms_key_id of this Cluster.
kubernetes_version Gets the kubernetes_version of this Cluster.
lifecycle_details Gets the lifecycle_details of this Cluster.
lifecycle_state Gets the lifecycle_state of this Cluster.
metadata Gets the metadata of this Cluster.
name Gets the name of this Cluster.
options Gets the options of this Cluster.
system_tags Gets the system_tags of this Cluster.
vcn_id Gets the vcn_id of this Cluster.

Methods

__init__(**kwargs) Initializes a new Cluster object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new Cluster 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 Cluster.
  • name (str) – The value to assign to the name property of this Cluster.
  • compartment_id (str) – The value to assign to the compartment_id property of this Cluster.
  • endpoint_config (oci.container_engine.models.ClusterEndpointConfig) – The value to assign to the endpoint_config property of this Cluster.
  • vcn_id (str) – The value to assign to the vcn_id property of this Cluster.
  • kubernetes_version (str) – The value to assign to the kubernetes_version property of this Cluster.
  • kms_key_id (str) – The value to assign to the kms_key_id property of this Cluster.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Cluster.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Cluster.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Cluster.
  • options (oci.container_engine.models.ClusterCreateOptions) – The value to assign to the options property of this Cluster.
  • metadata (oci.container_engine.models.ClusterMetadata) – The value to assign to the metadata property of this Cluster.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Cluster. 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 Cluster.
  • endpoints (oci.container_engine.models.ClusterEndpoints) – The value to assign to the endpoints property of this Cluster.
  • available_kubernetes_upgrades (list[str]) – The value to assign to the available_kubernetes_upgrades property of this Cluster.
  • image_policy_config (oci.container_engine.models.ImagePolicyConfig) – The value to assign to the image_policy_config property of this Cluster.
available_kubernetes_upgrades

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

Returns:The available_kubernetes_upgrades of this Cluster.
Return type:list[str]
compartment_id

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

Returns:The compartment_id of this Cluster.
Return type:str
defined_tags

Gets the defined_tags of this Cluster. 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 Cluster.
Return type:dict(str, dict(str, object))
endpoint_config

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

Returns:The endpoint_config of this Cluster.
Return type:oci.container_engine.models.ClusterEndpointConfig
endpoints

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

Returns:The endpoints of this Cluster.
Return type:oci.container_engine.models.ClusterEndpoints
freeform_tags

Gets the freeform_tags of this Cluster. 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 Cluster.
Return type:dict(str, str)
id

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

Returns:The id of this Cluster.
Return type:str
image_policy_config

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

Returns:The image_policy_config of this Cluster.
Return type:oci.container_engine.models.ImagePolicyConfig
kms_key_id

Gets the kms_key_id of this Cluster. The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.

Returns:The kms_key_id of this Cluster.
Return type:str
kubernetes_version

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

Returns:The kubernetes_version of this Cluster.
Return type:str
lifecycle_details

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

Returns:The lifecycle_details of this Cluster.
Return type:str
lifecycle_state

Gets the lifecycle_state of this Cluster. The state of the cluster masters.

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 Cluster.
Return type:str
metadata

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

Returns:The metadata of this Cluster.
Return type:oci.container_engine.models.ClusterMetadata
name

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

Returns:The name of this Cluster.
Return type:str
options

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

Returns:The options of this Cluster.
Return type:oci.container_engine.models.ClusterCreateOptions
system_tags

Gets the system_tags of this Cluster. 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 Cluster.
Return type:dict(str, dict(str, object))
vcn_id

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

Returns:The vcn_id of this Cluster.
Return type:str