CreateClusterDetails

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

Bases: object

The properties that define a request to create a cluster.

Methods

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

Attributes

compartment_id [Required] Gets the compartment_id of this CreateClusterDetails.
endpoint_config Gets the endpoint_config 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.
vcn_id [Required] Gets the vcn_id of this CreateClusterDetails.
__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.
  • 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.
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
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
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
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