create_cluster ¶

def create_cluster(
    self,
    name: "capo_eks.types.cluster_name.ClusterName",
    role_arn: "capo_eks.types.string.String",
    resources_vpc_config: "capo_eks.types.vpc_config_request.VpcConfigRequest",
    *,
    config_overrides: Optional[EKSClientConfig] = None,
    version: Optional["capo_eks.types.string.String"] = None,
    kubernetes_network_config: Optional[
        "capo_eks.types.kubernetes_network_config_request.KubernetesNetworkConfigRequest"
    ] = None,
    logging: Optional["capo_eks.types.logging.Logging"] = None,
    client_request_token: Optional["capo_eks.types.string.String"] = None,
    tags: Optional["capo_eks.types.tag_map.TagMap"] = None,
    encryption_config: Optional[
        "capo_eks.types.encryption_config_list.EncryptionConfigList"
    ] = None,
    outpost_config: Optional[
        "capo_eks.types.outpost_config_request.OutpostConfigRequest"
    ] = None,
    access_config: Optional[
        "capo_eks.types.create_access_config_request.CreateAccessConfigRequest"
    ] = None,
    bootstrap_self_managed_addons: Optional[
        "capo_eks.types.boxed_boolean.BoxedBoolean"
    ] = None,
    upgrade_policy: Optional[
        "capo_eks.types.upgrade_policy_request.UpgradePolicyRequest"
    ] = None,
    zonal_shift_config: Optional[
        "capo_eks.types.zonal_shift_config_request.ZonalShiftConfigRequest"
    ] = None,
    remote_network_config: Optional[
        "capo_eks.types.remote_network_config_request.RemoteNetworkConfigRequest"
    ] = None,
    compute_config: Optional[
        "capo_eks.types.compute_config_request.ComputeConfigRequest"
    ] = None,
    storage_config: Optional[
        "capo_eks.types.storage_config_request.StorageConfigRequest"
    ] = None,
    deletion_protection: Optional[
        "capo_eks.types.boxed_boolean.BoxedBoolean"
    ] = None,
    control_plane_scaling_config: Optional[
        "capo_eks.types.control_plane_scaling_config.ControlPlaneScalingConfig"
    ] = None,
    kube_api_server_config: Optional[
        "capo_eks.types.kube_api_server_config_request.KubeApiServerConfigRequest"
    ] = None,
    kube_scheduler_config: Optional[
        "capo_eks.types.kube_scheduler_config_request.KubeSchedulerConfigRequest"
    ] = None,
    kube_controller_manager_config: Optional[
        "capo_eks.types.kube_controller_manager_config_request.KubeControllerManagerConfigRequest"
    ] = None,
) -> "capo_eks.types.create_cluster_response.CreateClusterResponse":
    """<p>Creates an Amazon EKS control plane.</p> <p>The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as <code>etcd</code> and the API server. The control plane runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances.</p> <p>The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support <code>kubectl exec</code>, <code>logs</code>, and <code>proxy</code> data flows).</p> <p>Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.</p> <p>You can use the <code>endpointPublicAccess</code> and <code>endpointPrivateAccess</code> parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. The endpoint domain name and IP address family depends on the value of the <code>ipFamily</code> for the cluster. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>. </p> <p>You can use the <code>logging</code> parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html">Amazon EKS Cluster Control Plane Logs</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p> <note> <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see <a href="http://aws.amazon.com/cloudwatch/pricing/">CloudWatch Pricing</a>.</p> </note> <p>In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/cluster-auth.html">Allowing users to access your cluster</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html">Launching Amazon EKS nodes</a> in the <i>Amazon EKS User Guide</i>.</p>

    Args:
        name: <p>The unique name to give to your cluster. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the cluster in.</p>
        version: <p>The desired Kubernetes version for your cluster. If you don't specify a value here, the default version available in Amazon EKS is used.</p> <note> <p>The default version might not be the latest version available.</p> </note>
        role_arn: <p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html">Amazon EKS Service IAM Role</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>
        resources_vpc_config: <p>The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html">Cluster VPC Considerations</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html">Cluster Security Group Considerations</a> in the <i>Amazon EKS User Guide</i>. You must specify at least two subnets. You can specify up to five security groups. However, we recommend that you use a dedicated security group for your cluster control plane.</p>
        kubernetes_network_config: <p>The Kubernetes network configuration for the cluster.</p>
        logging: <p>Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs . By default, cluster control plane logs aren't exported to CloudWatch Logs . For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html">Amazon EKS Cluster control plane logs</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p> <note> <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see <a href="http://aws.amazon.com/cloudwatch/pricing/">CloudWatch Pricing</a>.</p> </note>
        client_request_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
        tags: <p>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</p>
        encryption_config: <p>The encryption configuration for the cluster.</p>
        outpost_config: <p>An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-overview.html">Local clusters for Amazon EKS on Amazon Web Services Outposts</a> in the <i>Amazon EKS User Guide</i>. This object isn't available for creating Amazon EKS clusters on the Amazon Web Services cloud.</p>
        access_config: <p>The access configuration for the cluster.</p>
        bootstrap_self_managed_addons: <p>If you set this value to <code>False</code> when creating a cluster, the default networking add-ons will not be installed.</p> <p>The default networking add-ons include <code>vpc-cni</code>, <code>coredns</code>, and <code>kube-proxy</code>.</p> <p>Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.</p>
        upgrade_policy: <p>New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to <code>STANDARD</code>.</p>
        zonal_shift_config: <p>Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.</p> <p>Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary.</p> <p>You can start a zonal shift for an Amazon EKS cluster, or you can allow Amazon Web Services to do it for you by enabling <i>zonal autoshift</i>. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your Amazon EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/zone-shift.html">Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>
        remote_network_config: <p>The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.</p>
        compute_config: <p>Enable or disable the compute capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account</p>
        storage_config: <p>Enable or disable the block storage capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.</p>
        deletion_protection: <p>Indicates whether to enable deletion protection for the cluster. When enabled, the cluster cannot be deleted unless deletion protection is first disabled. This helps prevent accidental cluster deletion. Default value is <code>false</code>.</p>
        control_plane_scaling_config: <p>The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.</p>
        kube_api_server_config: <p>The Kubernetes API server configuration for the new cluster.</p>
        kube_scheduler_config: <p>The Kubernetes scheduler configuration for the new cluster.</p>
        kube_controller_manager_config: <p>The Kubernetes controller manager configuration for the new cluster.</p>

    Raises:
        capo_eks.errors.client_exception.ClientException: <p>These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html">IAM principal</a> that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.</p>
        capo_eks.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
        capo_eks.errors.resource_in_use_exception.ResourceInUseException: <p>The specified resource is in use.</p>
        capo_eks.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>You have encountered a service limit on the specified resource.</p>
        capo_eks.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
        capo_eks.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is unavailable. Back off and retry the operation.</p>
        capo_eks.errors.unsupported_availability_zone_exception.UnsupportedAvailabilityZoneException: <p>At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.</p>
        capo_eks.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To create a new cluster
        The following example creates an Amazon EKS cluster called prod.

        >>> client.create_cluster(name='prod', version='1.10', role_arn='arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI', resources_vpc_config={'subnetIds': ['subnet-6782e71e', 'subnet-e7e761ac'], 'securityGroupIds': ['sg-6979fe18']}, client_request_token='1d2129a1-3d38-460a-9756-e5b91fddb951')
    """

    def _handler(
        req: "OperationRequest[capo_eks.types.create_cluster_request.CreateClusterRequest]",
    ) -> OperationResponse[
        "capo_eks.types.create_cluster_response.CreateClusterResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.create_cluster

        output, http_response = (
            capo_eks._operations.aws_wesley_frontend.create_cluster.create_cluster(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateCluster")
    )
    input_: capo_eks.types.create_cluster_request.CreateClusterRequest = {
        "name": name,
        "role_arn": role_arn,
        "resources_vpc_config": resources_vpc_config,
    }
    if version is not None:
        input_["version"] = version
    if kubernetes_network_config is not None:
        input_["kubernetes_network_config"] = kubernetes_network_config
    if logging is not None:
        input_["logging"] = logging
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if tags is not None:
        input_["tags"] = tags
    if encryption_config is not None:
        input_["encryption_config"] = encryption_config
    if outpost_config is not None:
        input_["outpost_config"] = outpost_config
    if access_config is not None:
        input_["access_config"] = access_config
    if bootstrap_self_managed_addons is not None:
        input_["bootstrap_self_managed_addons"] = bootstrap_self_managed_addons
    if upgrade_policy is not None:
        input_["upgrade_policy"] = upgrade_policy
    if zonal_shift_config is not None:
        input_["zonal_shift_config"] = zonal_shift_config
    if remote_network_config is not None:
        input_["remote_network_config"] = remote_network_config
    if compute_config is not None:
        input_["compute_config"] = compute_config
    if storage_config is not None:
        input_["storage_config"] = storage_config
    if deletion_protection is not None:
        input_["deletion_protection"] = deletion_protection
    if control_plane_scaling_config is not None:
        input_["control_plane_scaling_config"] = control_plane_scaling_config
    if kube_api_server_config is not None:
        input_["kube_api_server_config"] = kube_api_server_config
    if kube_scheduler_config is not None:
        input_["kube_scheduler_config"] = kube_scheduler_config
    if kube_controller_manager_config is not None:
        input_["kube_controller_manager_config"] = kube_controller_manager_config

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output