CreateClusterDetails¶

class oci.container_engine.models.CreateClusterDetails(**kwargs)¶

Bases: object

The properties that define a request to create a cluster.

Attributes

`TYPE_BASIC_CLUSTER`	A constant which can be used with the type property of a CreateClusterDetails.
`TYPE_ENHANCED_CLUSTER`	A constant which can be used with the type property of a CreateClusterDetails.
`cluster_pod_network_options`	Gets the cluster_pod_network_options of this CreateClusterDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateClusterDetails.
`defined_tags`	Gets the defined_tags of this CreateClusterDetails.
`endpoint_config`	Gets the endpoint_config of this CreateClusterDetails.
`freeform_tags`	Gets the freeform_tags of this CreateClusterDetails.
`image_policy_config`	Gets the image_policy_config of this CreateClusterDetails.
`kms_key_id`	Gets the kms_key_id of this CreateClusterDetails.
`kubernetes_version`	[Required] Gets the kubernetes_version of this CreateClusterDetails.
`name`	[Required] Gets the name of this CreateClusterDetails.
`options`	Gets the options of this CreateClusterDetails.
`type`	Gets the type of this CreateClusterDetails.
`vcn_id`	[Required] Gets the vcn_id of this CreateClusterDetails.

Methods

__init__(**kwargs) Initializes a new CreateClusterDetails object with values from keyword arguments.

TYPE_BASIC_CLUSTER = 'BASIC_CLUSTER'¶: A constant which can be used with the type property of a CreateClusterDetails. 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 CreateClusterDetails. This constant has a value of “ENHANCED_CLUSTER”

__init__(**kwargs)¶

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

Parameters:

name (str) – The value to assign to the name property of this CreateClusterDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateClusterDetails.
endpoint_config (oci.container_engine.models.CreateClusterEndpointConfigDetails) – The value to assign to the endpoint_config property of this CreateClusterDetails.
vcn_id (str) – The value to assign to the vcn_id property of this CreateClusterDetails.
kubernetes_version (str) – The value to assign to the kubernetes_version property of this CreateClusterDetails.
kms_key_id (str) – The value to assign to the kms_key_id property of this CreateClusterDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateClusterDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateClusterDetails.
options (oci.container_engine.models.ClusterCreateOptions) – The value to assign to the options property of this CreateClusterDetails.
image_policy_config (oci.container_engine.models.CreateImagePolicyConfigDetails) – The value to assign to the image_policy_config property of this CreateClusterDetails.
cluster_pod_network_options (list[oci.container_engine.models.ClusterPodNetworkOptionDetails]) – The value to assign to the cluster_pod_network_options property of this CreateClusterDetails.
type (str) – The value to assign to the type property of this CreateClusterDetails. Allowed values for this property are: “BASIC_CLUSTER”, “ENHANCED_CLUSTER”

cluster_pod_network_options¶

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

Returns:	The cluster_pod_network_options of this CreateClusterDetails.
Return type:	list[oci.container_engine.models.ClusterPodNetworkOptionDetails]

compartment_id¶

[Required] Gets the compartment_id of this CreateClusterDetails. The OCID of the compartment in which to create the cluster.

Returns:	The compartment_id of this CreateClusterDetails.
Return type:	str

defined_tags¶

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

endpoint_config¶

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

Returns:	The endpoint_config of this CreateClusterDetails.
Return type:	oci.container_engine.models.CreateClusterEndpointConfigDetails

freeform_tags¶

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

image_policy_config¶

Gets the image_policy_config of this CreateClusterDetails. The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.

Returns:	The image_policy_config of this CreateClusterDetails.
Return type:	oci.container_engine.models.CreateImagePolicyConfigDetails

kms_key_id¶

Gets the kms_key_id of this CreateClusterDetails. The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.

Returns:	The kms_key_id of this CreateClusterDetails.
Return type:	str

kubernetes_version¶

[Required] Gets the kubernetes_version of this CreateClusterDetails. The version of Kubernetes to install into the cluster masters.

Returns:	The kubernetes_version of this CreateClusterDetails.
Return type:	str

name¶

[Required] Gets the name of this CreateClusterDetails. The name of the cluster. Avoid entering confidential information.

Returns:	The name of this CreateClusterDetails.
Return type:	str

options¶

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

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

type¶

Gets the type of this CreateClusterDetails. Type of cluster

Allowed values for this property are: “BASIC_CLUSTER”, “ENHANCED_CLUSTER”

Returns:	The type of this CreateClusterDetails.
Return type:	str

vcn_id¶

[Required] Gets the vcn_id of this CreateClusterDetails. The OCID of the virtual cloud network (VCN) in which to create the cluster.

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