createCluster method

Future<CreateClusterResponse> createCluster({ required String name, required VpcConfigRequest resourcesVpcConfig, required String roleArn, String? clientRequestToken, List<EncryptionConfig>? encryptionConfig, KubernetesNetworkConfigRequest? kubernetesNetworkConfig, Logging? logging, Map<String, String>? tags, String? version, })

Creates an Amazon EKS control plane.

The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its own set of Amazon EC2 instances.

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 worker nodes (for example, to support kubectl exec, logs, and proxy data flows).

Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.

You can use the endpointPublicAccess and endpointPrivateAccess 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. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

You can use the logging 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 Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide . Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide.

May throw ResourceInUseException. May throw ResourceLimitExceededException. May throw InvalidParameterException. May throw ClientException. May throw ServerException. May throw ServiceUnavailableException. May throw UnsupportedAvailabilityZoneException.

Parameter name : The unique name to give to your cluster.

Parameter resourcesVpcConfig : The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.

Parameter roleArn : The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

Parameter clientRequestToken : Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Parameter encryptionConfig : The encryption configuration for the cluster.

Parameter kubernetesNetworkConfig : The Kubernetes network configuration for the cluster.

Parameter logging : 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 Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

Parameter tags : The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.

Parameter version : The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

Implementation

Future<CreateClusterResponse> createCluster({
  required String name,
  required VpcConfigRequest resourcesVpcConfig,
  required String roleArn,
  String? clientRequestToken,
  List<EncryptionConfig>? encryptionConfig,
  KubernetesNetworkConfigRequest? kubernetesNetworkConfig,
  Logging? logging,
  Map<String, String>? tags,
  String? version,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    100,
    isRequired: true,
  );
  ArgumentError.checkNotNull(resourcesVpcConfig, 'resourcesVpcConfig');
  ArgumentError.checkNotNull(roleArn, 'roleArn');
  final $payload = <String, dynamic>{
    'name': name,
    'resourcesVpcConfig': resourcesVpcConfig,
    'roleArn': roleArn,
    'clientRequestToken': clientRequestToken ?? _s.generateIdempotencyToken(),
    if (encryptionConfig != null) 'encryptionConfig': encryptionConfig,
    if (kubernetesNetworkConfig != null)
      'kubernetesNetworkConfig': kubernetesNetworkConfig,
    if (logging != null) 'logging': logging,
    if (tags != null) 'tags': tags,
    if (version != null) 'version': version,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/clusters',
    exceptionFnMap: _exceptionFns,
  );
  return CreateClusterResponse.fromJson(response);
}