EKS / Client / create_cluster

create_cluster#

EKS.Client.create_cluster(**kwargs)#

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 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.

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 kubectl exec, logs, and proxy data flows).

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.

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 .

Note

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.

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 Managing Cluster Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.

Request Syntax

response = client.create_cluster(
    name='string',
    version='string',
    roleArn='string',
    resourcesVpcConfig={
        'subnetIds': [
            'string',
        ],
        'securityGroupIds': [
            'string',
        ],
        'endpointPublicAccess': True|False,
        'endpointPrivateAccess': True|False,
        'publicAccessCidrs': [
            'string',
        ]
    },
    kubernetesNetworkConfig={
        'serviceIpv4Cidr': 'string',
        'ipFamily': 'ipv4'|'ipv6'
    },
    logging={
        'clusterLogging': [
            {
                'types': [
                    'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
                ],
                'enabled': True|False
            },
        ]
    },
    clientRequestToken='string',
    tags={
        'string': 'string'
    },
    encryptionConfig=[
        {
            'resources': [
                'string',
            ],
            'provider': {
                'keyArn': 'string'
            }
        },
    ],
    outpostConfig={
        'outpostArns': [
            'string',
        ],
        'controlPlaneInstanceType': 'string',
        'controlPlanePlacement': {
            'groupName': 'string'
        }
    },
    accessConfig={
        'bootstrapClusterCreatorAdminPermissions': True|False,
        'authenticationMode': 'API'|'API_AND_CONFIG_MAP'|'CONFIG_MAP'
    }
)

Parameters:

name (string) –
[REQUIRED]

The unique name to give to your cluster.
version (string) –
The desired Kubernetes version for your cluster. If you don’t specify a value here, the default version available in Amazon EKS is used.

Note
The default version might not be the latest version available.
roleArn (string) –
[REQUIRED]

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 Amazon EKS Service IAM Role in the Amazon EKS User Guide .
resourcesVpcConfig (dict) –
[REQUIRED]

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 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. However, we recommend that you use a dedicated security group for your cluster control plane.
- subnetIds (list) –
  
  Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
  - (string) –
- securityGroupIds (list) –
  
  Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane. If you don’t specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes. For more information, see Amazon EKS security group considerations in the Amazon EKS User Guide .
  - (string) –
- endpointPublicAccess (boolean) –
  
  Set this value to false to disable public access to your cluster’s Kubernetes API server endpoint. If you disable public access, your cluster’s Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
- endpointPrivateAccess (boolean) –
  
  Set this value to true to enable private access for your cluster’s Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster’s VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
- publicAccessCidrs (list) –
  
  The CIDR blocks that are allowed access to your cluster’s public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you’ve disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate Pod in the cluster. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
  - (string) –
kubernetesNetworkConfig (dict) –
The Kubernetes network configuration for the cluster.
- serviceIpv4Cidr (string) –
  
  Don’t specify a value if you select ipv6 for ipFamily. The CIDR block to assign Kubernetes service IP addresses from. If you don’t specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. The block must meet the following requirements:
  - Within one of the following private IP address blocks: 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16.
  - Doesn’t overlap with any CIDR block assigned to the VPC that you selected for VPC.
  - Between /24 and /12.
  Warning
  You can only specify a custom CIDR block when you create a cluster. You can’t change this value after the cluster is created.
- ipFamily (string) –
  
  Specify which IP family is used to assign Kubernetes pod and service IP addresses. If you don’t specify a value, ipv4 is used by default. You can only specify an IP family when you create a cluster and can’t change this value once the cluster is created. If you specify ipv6, the VPC and subnets that you specify for cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them. You can’t specify ipv6 for clusters in China Regions.
  
  You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on. If you specify ipv6, then ensure that your VPC meets the requirements listed in the considerations listed in Assigning IPv6 addresses to pods and services in the Amazon EKS User Guide. Kubernetes assigns services IPv6 addresses from the unique local address range (fc00::/7). You can’t specify a custom IPv6 CIDR block. Pod addresses are assigned from the subnet’s IPv6 CIDR.
logging (dict) –
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 .

Note
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
- clusterLogging (list) –
  
  The cluster control plane logging configuration for your cluster.
  - (dict) –
    
    An object representing the enabled or disabled Kubernetes control plane logs for your cluster.
    - types (list) –
      
      The available cluster control plane log types.
      - (string) –
    - enabled (boolean) –
      
      If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn’t enabled, that log type doesn’t export its control plane logs. Each individual log type can be enabled or disabled independently.
clientRequestToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.
tags (dict) –
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.
- (string) –
  
  One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
  - (string) –
    
    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
encryptionConfig (list) –
The encryption configuration for the cluster.
- (dict) –
  
  The encryption configuration for the cluster.
  - resources (list) –
    
    Specifies the resources to be encrypted. The only supported value is secrets.
    - (string) –
  - provider (dict) –
    
    Key Management Service (KMS) key. Either the ARN or the alias can be used.
    - keyArn (string) –
      
      Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide.
outpostConfig (dict) –
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 Local clusters for Amazon EKS on Amazon Web Services Outposts in the Amazon EKS User Guide. This object isn’t available for creating Amazon EKS clusters on the Amazon Web Services cloud.
- outpostArns (list) – [REQUIRED]
  
  The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts. Only a single Outpost ARN is supported.
  - (string) –
- controlPlaneInstanceType (string) – [REQUIRED]
  
  The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. Choose an instance type based on the number of nodes that your cluster will have. For more information, see Capacity considerations in the Amazon EKS User Guide.
  
  The instance type that you specify is used for all Kubernetes control plane instances. The instance type can’t be changed after cluster creation. The control plane is not automatically scaled by Amazon EKS.
- controlPlanePlacement (dict) –
  
  An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
  - groupName (string) –
    
    The name of the placement group for the Kubernetes control plane instances. This setting can’t be changed after cluster creation.
accessConfig (dict) –
The access configuration for the cluster.
- bootstrapClusterCreatorAdminPermissions (boolean) –
  
  Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time. The default value is true.
- authenticationMode (string) –
  
  The desired authentication mode for the cluster. If you create a cluster by using the EKS API, Amazon Web Services SDKs, or CloudFormation, the default is CONFIG_MAP. If you create the cluster by using the Amazon Web Services Management Console, the default value is API_AND_CONFIG_MAP.

Return type:

dict

Returns:

Response Syntax

{
    'cluster': {
        'name': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'version': 'string',
        'endpoint': 'string',
        'roleArn': 'string',
        'resourcesVpcConfig': {
            'subnetIds': [
                'string',
            ],
            'securityGroupIds': [
                'string',
            ],
            'clusterSecurityGroupId': 'string',
            'vpcId': 'string',
            'endpointPublicAccess': True|False,
            'endpointPrivateAccess': True|False,
            'publicAccessCidrs': [
                'string',
            ]
        },
        'kubernetesNetworkConfig': {
            'serviceIpv4Cidr': 'string',
            'serviceIpv6Cidr': 'string',
            'ipFamily': 'ipv4'|'ipv6'
        },
        'logging': {
            'clusterLogging': [
                {
                    'types': [
                        'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
                    ],
                    'enabled': True|False
                },
            ]
        },
        'identity': {
            'oidc': {
                'issuer': 'string'
            }
        },
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'PENDING',
        'certificateAuthority': {
            'data': 'string'
        },
        'clientRequestToken': 'string',
        'platformVersion': 'string',
        'tags': {
            'string': 'string'
        },
        'encryptionConfig': [
            {
                'resources': [
                    'string',
                ],
                'provider': {
                    'keyArn': 'string'
                }
            },
        ],
        'connectorConfig': {
            'activationId': 'string',
            'activationCode': 'string',
            'activationExpiry': datetime(2015, 1, 1),
            'provider': 'string',
            'roleArn': 'string'
        },
        'id': 'string',
        'health': {
            'issues': [
                {
                    'code': 'AccessDenied'|'ClusterUnreachable'|'ConfigurationConflict'|'InternalFailure'|'ResourceLimitExceeded'|'ResourceNotFound'|'IamRoleNotFound'|'VpcNotFound'|'InsufficientFreeAddresses'|'Ec2ServiceNotSubscribed'|'Ec2SubnetNotFound'|'Ec2SecurityGroupNotFound'|'KmsGrantRevoked'|'KmsKeyNotFound'|'KmsKeyMarkedForDeletion'|'KmsKeyDisabled'|'StsRegionalEndpointDisabled'|'UnsupportedVersion'|'Other',
                    'message': 'string',
                    'resourceIds': [
                        'string',
                    ]
                },
            ]
        },
        'outpostConfig': {
            'outpostArns': [
                'string',
            ],
            'controlPlaneInstanceType': 'string',
            'controlPlanePlacement': {
                'groupName': 'string'
            }
        },
        'accessConfig': {
            'bootstrapClusterCreatorAdminPermissions': True|False,
            'authenticationMode': 'API'|'API_AND_CONFIG_MAP'|'CONFIG_MAP'
        }
    }
}

Response Structure

(dict) –
- cluster (dict) –
  
  The full description of your new cluster.
  - name (string) –
    
    The name of your cluster.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the cluster.
  - createdAt (datetime) –
    
    The Unix epoch timestamp at object creation.
  - version (string) –
    
    The Kubernetes server version for the cluster.
  - endpoint (string) –
    
    The endpoint for your Kubernetes API server.
  - roleArn (string) –
    
    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.
  - resourcesVpcConfig (dict) –
    
    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.
    - subnetIds (list) –
      
      The subnets associated with your cluster.
      - (string) –
    - securityGroupIds (list) –
      
      The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.
      - (string) –
    - clusterSecurityGroupId (string) –
      
      The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.
    - vpcId (string) –
      
      The VPC associated with your cluster.
    - endpointPublicAccess (boolean) –
      
      Whether the public API server endpoint is enabled.
    - endpointPrivateAccess (boolean) –
      
      This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster’s VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
    - publicAccessCidrs (list) –
      
      The CIDR blocks that are allowed access to your cluster’s public Kubernetes API server endpoint.
      - (string) –
  - kubernetesNetworkConfig (dict) –
    
    The Kubernetes network configuration for the cluster.
    - serviceIpv4Cidr (string) –
      
      The CIDR block that Kubernetes Pod and Service object IP addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. If you didn’t specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it can’t be changed.
    - serviceIpv6Cidr (string) –
      
      The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns service addresses from the unique local address range ( fc00::/7) because you can’t specify a custom IPv6 CIDR block when you create the cluster.
    - ipFamily (string) –
      
      The IP family used to assign Kubernetes Pod and Service objects IP addresses. The IP family is always ipv4, unless you have a 1.21 or later cluster running version 1.10.1 or later of the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.
  - logging (dict) –
    
    The logging configuration for your cluster.
    - clusterLogging (list) –
      
      The cluster control plane logging configuration for your cluster.
      - (dict) –
        
        An object representing the enabled or disabled Kubernetes control plane logs for your cluster.
        
        types (list) –
        
        The available cluster control plane log types.
        
        (string) –
        
        enabled (boolean) –
        
        If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn’t enabled, that log type doesn’t export its control plane logs. Each individual log type can be enabled or disabled independently.
  - identity (dict) –
    
    The identity provider information for the cluster.
    - oidc (dict) –
      
      An object representing the OpenID Connect identity provider information.
      - issuer (string) –
        
        The issuer URL for the OIDC identity provider.
  - status (string) –
    
    The current status of the cluster.
  - certificateAuthority (dict) –
    
    The certificate-authority-data for your cluster.
    - data (string) –
      
      The Base64-encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.
  - clientRequestToken (string) –
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - platformVersion (string) –
    
    The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
  - tags (dict) –
    
    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.
    - (string) –
      
      One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
      - (string) –
        
        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
  - encryptionConfig (list) –
    
    The encryption configuration for the cluster.
    - (dict) –
      
      The encryption configuration for the cluster.
      - resources (list) –
        
        Specifies the resources to be encrypted. The only supported value is secrets.
        
        (string) –
      - provider (dict) –
        
        Key Management Service (KMS) key. Either the ARN or the alias can be used.
        
        keyArn (string) –
        
        Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide.
  - connectorConfig (dict) –
    
    The configuration used to connect to a cluster for registration.
    - activationId (string) –
      
      A unique ID associated with the cluster for registration purposes.
    - activationCode (string) –
      
      A unique code associated with the cluster for registration purposes.
    - activationExpiry (datetime) –
      
      The expiration time of the connected cluster. The cluster’s YAML file must be applied through the native provider.
    - provider (string) –
      
      The cluster’s cloud service provider.
    - roleArn (string) –
      
      The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.
  - id (string) –
    
    The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn’t available for an Amazon EKS cluster on the Amazon Web Services cloud.
  - health (dict) –
    
    An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn’t available for clusters on the Amazon Web Services cloud.
    - issues (list) –
      
      An object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.
      - (dict) –
        
        An issue with your local Amazon EKS cluster on an Amazon Web Services Outpost. You can’t use this API with an Amazon EKS cluster on the Amazon Web Services cloud.
        
        code (string) –
        
        The error code of the issue.
        
        message (string) –
        
        A description of the issue.
        
        resourceIds (list) –
        
        The resource IDs that the issue relates to.
        
        (string) –
  - outpostConfig (dict) –
    
    An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn’t available for clusters on the Amazon Web Services cloud.
    - outpostArns (list) –
      
      The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.
      - (string) –
    - controlPlaneInstanceType (string) –
      
      The Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances.
    - controlPlanePlacement (dict) –
      
      An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
      - groupName (string) –
        
        The name of the placement group for the Kubernetes control plane instances.
  - accessConfig (dict) –
    
    The access configuration for the cluster.
    - bootstrapClusterCreatorAdminPermissions (boolean) –
      
      Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.
    - authenticationMode (string) –
      
      The current authentication mode of the cluster.

Exceptions

EKS.Client.exceptions.ResourceInUseException
EKS.Client.exceptions.ResourceLimitExceededException
EKS.Client.exceptions.InvalidParameterException
EKS.Client.exceptions.ClientException
EKS.Client.exceptions.ServerException
EKS.Client.exceptions.ServiceUnavailableException
EKS.Client.exceptions.UnsupportedAvailabilityZoneException

Examples

The following example creates an Amazon EKS cluster called prod.

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

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

create_cluster#

Note

Request Syntax

Note

Warning

Note

Response Syntax

Response Structure

Exceptions

Examples