Cluster¶
- class oci.container_engine.models.Cluster(**kwargs)¶
Bases:
objectA Kubernetes cluster. Avoid entering confidential information.
Attributes:
A constant which can be used with the lifecycle_state property of a Cluster.
A constant which can be used with the lifecycle_state property of a Cluster.
A constant which can be used with the lifecycle_state property of a Cluster.
A constant which can be used with the lifecycle_state property of a Cluster.
A constant which can be used with the lifecycle_state property of a Cluster.
A constant which can be used with the lifecycle_state property of a Cluster.
A constant which can be used with the type property of a Cluster.
A constant which can be used with the type property of a Cluster.
Gets the available_kubernetes_upgrades of this Cluster.
Gets the cluster_pod_network_options of this Cluster.
Gets the compartment_id of this Cluster.
Gets the defined_tags of this Cluster.
Gets the endpoint_config of this Cluster.
Gets the endpoints of this Cluster.
Gets the freeform_tags of this Cluster.
Gets the id of this Cluster.
Gets the image_policy_config of this Cluster.
Gets the kms_key_id of this Cluster.
Gets the kubernetes_version of this Cluster.
Gets the lifecycle_details of this Cluster.
Gets the lifecycle_state of this Cluster.
Gets the metadata of this Cluster.
Gets the name of this Cluster.
Gets the open_id_connect_discovery_endpoint of this Cluster.
Gets the open_id_connect_discovery_key of this Cluster.
Gets the options of this Cluster.
Gets the system_tags of this Cluster.
Gets the type of this Cluster.
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”
- TYPE_BASIC_CLUSTER = 'BASIC_CLUSTER'¶
A constant which can be used with the type property of a Cluster. 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 Cluster. This constant has a value of “ENHANCED_CLUSTER”
- __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.
cluster_pod_network_options (list[oci.container_engine.models.ClusterPodNetworkOptionDetails]) – The value to assign to the cluster_pod_network_options property of this Cluster.
type (str) – The value to assign to the type property of this Cluster. 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’.
open_id_connect_discovery_endpoint (str) – The value to assign to the open_id_connect_discovery_endpoint property of this Cluster.
open_id_connect_discovery_key (str) – The value to assign to the open_id_connect_discovery_key property of this Cluster.
- property 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]
- property cluster_pod_network_options¶
Gets the cluster_pod_network_options of this Cluster. Available CNIs and network options for existing and new node pools of the cluster
- Returns
The cluster_pod_network_options of this Cluster.
- Return type
list[oci.container_engine.models.ClusterPodNetworkOptionDetails]
- property 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
- property 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))
- property 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
- property endpoints¶
Gets the endpoints of this Cluster. Endpoints served up by the cluster masters.
- Returns
The endpoints of this Cluster.
- Return type
- property 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)
- property id¶
Gets the id of this Cluster. The OCID of the cluster.
- Returns
The id of this Cluster.
- Return type
str
- property 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
- property 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
- property 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
- property 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
- property lifecycle_state¶
Gets the lifecycle_state of this Cluster. 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 Cluster.
- Return type
str
- property metadata¶
Gets the metadata of this Cluster. Metadata about the cluster.
- Returns
The metadata of this Cluster.
- Return type
- property name¶
Gets the name of this Cluster. The name of the cluster.
- Returns
The name of this Cluster.
- Return type
str
- property open_id_connect_discovery_endpoint¶
Gets the open_id_connect_discovery_endpoint of this Cluster. The cluster-specific OpenID Connect Discovery endpoint
- Returns
The open_id_connect_discovery_endpoint of this Cluster.
- Return type
str
- property open_id_connect_discovery_key¶
Gets the open_id_connect_discovery_key of this Cluster. The cluster-specific OpenID Connect Discovery Key to derive the DiscoveryEndpoint
- Returns
The open_id_connect_discovery_key of this Cluster.
- Return type
str
- property options¶
Gets the options of this Cluster. Optional attributes for the cluster.
- Returns
The options of this Cluster.
- Return type
- property 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))
- property type¶
Gets the type of this Cluster. Type of cluster
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 Cluster.
- Return type
str
- property 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