EKS *** Client ====== class EKS.Client A low-level client representing Amazon Elastic Kubernetes Service (EKS) Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services without needing to setup or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications. Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required. import boto3 client = boto3.client('eks') These are the available methods: * associate_access_policy * associate_encryption_config * associate_identity_provider_config * can_paginate * close * create_access_entry * create_addon * create_cluster * create_eks_anywhere_subscription * create_fargate_profile * create_nodegroup * create_pod_identity_association * delete_access_entry * delete_addon * delete_cluster * delete_eks_anywhere_subscription * delete_fargate_profile * delete_nodegroup * delete_pod_identity_association * deregister_cluster * describe_access_entry * describe_addon * describe_addon_configuration * describe_addon_versions * describe_cluster * describe_cluster_versions * describe_eks_anywhere_subscription * describe_fargate_profile * describe_identity_provider_config * describe_insight * describe_nodegroup * describe_pod_identity_association * describe_update * disassociate_access_policy * disassociate_identity_provider_config * get_paginator * get_waiter * list_access_entries * list_access_policies * list_addons * list_associated_access_policies * list_clusters * list_eks_anywhere_subscriptions * list_fargate_profiles * list_identity_provider_configs * list_insights * list_nodegroups * list_pod_identity_associations * list_tags_for_resource * list_updates * register_cluster * tag_resource * untag_resource * update_access_entry * update_addon * update_cluster_config * update_cluster_version * update_eks_anywhere_subscription * update_nodegroup_config * update_nodegroup_version * update_pod_identity_association Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * DescribeAddonVersions * DescribeClusterVersions * ListAccessEntries * ListAccessPolicies * ListAddons * ListAssociatedAccessPolicies * ListClusters * ListEksAnywhereSubscriptions * ListFargateProfiles * ListIdentityProviderConfigs * ListInsights * ListNodegroups * ListPodIdentityAssociations * ListUpdates Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * AddonActive * AddonDeleted * ClusterActive * ClusterDeleted * FargateProfileActive * FargateProfileDeleted * NodegroupActive * NodegroupDeleted EKS / Waiter / AddonDeleted AddonDeleted ************ class EKS.Waiter.AddonDeleted waiter = client.get_waiter('addon_deleted') wait(**kwargs) Polls "EKS.Client.describe_addon()" every 10 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( clusterName='string', addonName='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **addonName** (*string*) -- **[REQUIRED]** The name of the add-on. The name must match one of the names returned by ListAddons. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None EKS / Waiter / NodegroupActive NodegroupActive *************** class EKS.Waiter.NodegroupActive waiter = client.get_waiter('nodegroup_active') wait(**kwargs) Polls "EKS.Client.describe_nodegroup()" every 30 seconds until a successful state is reached. An error is raised after 80 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( clusterName='string', nodegroupName='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **nodegroupName** (*string*) -- **[REQUIRED]** The name of the node group to describe. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 80 Returns: None EKS / Waiter / AddonActive AddonActive *********** class EKS.Waiter.AddonActive waiter = client.get_waiter('addon_active') wait(**kwargs) Polls "EKS.Client.describe_addon()" every 10 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( clusterName='string', addonName='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **addonName** (*string*) -- **[REQUIRED]** The name of the add-on. The name must match one of the names returned by ListAddons. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None EKS / Waiter / ClusterDeleted ClusterDeleted ************** class EKS.Waiter.ClusterDeleted waiter = client.get_waiter('cluster_deleted') wait(**kwargs) Polls "EKS.Client.describe_cluster()" every 30 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( name='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of your cluster. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EKS / Waiter / FargateProfileActive FargateProfileActive ******************** class EKS.Waiter.FargateProfileActive waiter = client.get_waiter('fargate_profile_active') wait(**kwargs) Polls "EKS.Client.describe_fargate_profile()" every 10 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( clusterName='string', fargateProfileName='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **fargateProfileName** (*string*) -- **[REQUIRED]** The name of the Fargate profile to describe. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None EKS / Waiter / ClusterActive ClusterActive ************* class EKS.Waiter.ClusterActive waiter = client.get_waiter('cluster_active') wait(**kwargs) Polls "EKS.Client.describe_cluster()" every 30 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( name='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of your cluster. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EKS / Waiter / NodegroupDeleted NodegroupDeleted **************** class EKS.Waiter.NodegroupDeleted waiter = client.get_waiter('nodegroup_deleted') wait(**kwargs) Polls "EKS.Client.describe_nodegroup()" every 30 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( clusterName='string', nodegroupName='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **nodegroupName** (*string*) -- **[REQUIRED]** The name of the node group to describe. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EKS / Waiter / FargateProfileDeleted FargateProfileDeleted ********************* class EKS.Waiter.FargateProfileDeleted waiter = client.get_waiter('fargate_profile_deleted') wait(**kwargs) Polls "EKS.Client.describe_fargate_profile()" every 30 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( clusterName='string', fargateProfileName='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **fargateProfileName** (*string*) -- **[REQUIRED]** The name of the Fargate profile to describe. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None EKS / Paginator / ListAddons ListAddons ********** class EKS.Paginator.ListAddons paginator = client.get_paginator('list_addons') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_addons()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( clusterName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'addons': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **addons** *(list) --* A list of installed add-ons. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / DescribeClusterVersions DescribeClusterVersions *********************** class EKS.Paginator.DescribeClusterVersions paginator = client.get_paginator('describe_cluster_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.describe_cluster_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( clusterType='string', defaultOnly=True|False, includeAll=True|False, clusterVersions=[ 'string', ], status='unsupported'|'standard-support'|'extended-support', versionStatus='UNSUPPORTED'|'STANDARD_SUPPORT'|'EXTENDED_SUPPORT', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **clusterType** (*string*) -- The type of cluster to filter versions by. * **defaultOnly** (*boolean*) -- Filter to show only default versions. * **includeAll** (*boolean*) -- Include all available versions in the response. * **clusterVersions** (*list*) -- List of specific cluster versions to describe. * *(string) --* * **status** (*string*) -- Warning: This field is deprecated. Use "versionStatus" instead, as that field matches for input and output of this action. Filter versions by their current status. * **versionStatus** (*string*) -- Filter versions by their current status. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'clusterVersions': [ { 'clusterVersion': 'string', 'clusterType': 'string', 'defaultPlatformVersion': 'string', 'defaultVersion': True|False, 'releaseDate': datetime(2015, 1, 1), 'endOfStandardSupportDate': datetime(2015, 1, 1), 'endOfExtendedSupportDate': datetime(2015, 1, 1), 'status': 'unsupported'|'standard-support'|'extended-support', 'versionStatus': 'UNSUPPORTED'|'STANDARD_SUPPORT'|'EXTENDED_SUPPORT', 'kubernetesPatchVersion': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **clusterVersions** *(list) --* List of cluster version information objects. * *(dict) --* Contains details about a specific EKS cluster version. * **clusterVersion** *(string) --* The Kubernetes version for the cluster. * **clusterType** *(string) --* The type of cluster this version is for. * **defaultPlatformVersion** *(string) --* Default platform version for this Kubernetes version. * **defaultVersion** *(boolean) --* Indicates if this is a default version. * **releaseDate** *(datetime) --* The release date of this cluster version. * **endOfStandardSupportDate** *(datetime) --* Date when standard support ends for this version. * **endOfExtendedSupportDate** *(datetime) --* Date when extended support ends for this version. * **status** *(string) --* Warning: This field is deprecated. Use "versionStatus" instead, as that field matches for input and output of this action. Current status of this cluster version. * **versionStatus** *(string) --* Current status of this cluster version. * **kubernetesPatchVersion** *(string) --* The patch version of Kubernetes for this cluster version. * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / ListFargateProfiles ListFargateProfiles ******************* class EKS.Paginator.ListFargateProfiles paginator = client.get_paginator('list_fargate_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_fargate_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( clusterName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'fargateProfileNames': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **fargateProfileNames** *(list) --* A list of all of the Fargate profiles associated with the specified cluster. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / ListPodIdentityAssociations ListPodIdentityAssociations *************************** class EKS.Paginator.ListPodIdentityAssociations paginator = client.get_paginator('list_pod_identity_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_pod_identity_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( clusterName='string', namespace='string', serviceAccount='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of the cluster that the associations are in. * **namespace** (*string*) -- The name of the Kubernetes namespace inside the cluster that the associations are in. * **serviceAccount** (*string*) -- The name of the Kubernetes service account that the associations use. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'associations': [ { 'clusterName': 'string', 'namespace': 'string', 'serviceAccount': 'string', 'associationArn': 'string', 'associationId': 'string', 'ownerArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **associations** *(list) --* The list of summarized descriptions of the associations that are in the cluster and match any filters that you provided. Each summary is simplified by removing these fields compared to the full PodIdentityAssociation: * The IAM role: "roleArn" * The timestamp that the association was created at: "createdAt" * The most recent timestamp that the association was modified at:. "modifiedAt" * The tags on the association: "tags" * *(dict) --* The summarized description of the association. Each summary is simplified by removing these fields compared to the full PodIdentityAssociation: * The IAM role: "roleArn" * The timestamp that the association was created at: "createdAt" * The most recent timestamp that the association was modified at:. "modifiedAt" * The tags on the association: "tags" * **clusterName** *(string) --* The name of the cluster that the association is in. * **namespace** *(string) --* The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the Pods that use the service account must be in this namespace. * **serviceAccount** *(string) --* The name of the Kubernetes service account inside the cluster to associate the IAM credentials with. * **associationArn** *(string) --* The Amazon Resource Name (ARN) of the association. * **associationId** *(string) --* The ID of the association. * **ownerArn** *(string) --* If defined, the association is owned by an Amazon EKS add-on. * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / ListAccessPolicies ListAccessPolicies ****************** class EKS.Paginator.ListAccessPolicies paginator = client.get_paginator('list_access_policies') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_access_policies()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'accessPolicies': [ { 'name': 'string', 'arn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **accessPolicies** *(list) --* The list of available access policies. You can't view the contents of an access policy using the API. To view the contents, see Access policy permissions in the *Amazon EKS User Guide*. * *(dict) --* An access policy includes permissions that allow Amazon EKS to authorize an IAM principal to work with Kubernetes objects on your cluster. The policies are managed by Amazon EKS, but they're not IAM policies. You can't view the permissions in the policies using the API. The permissions for many of the policies are similar to the Kubernetes "cluster-admin", "admin", "edit", and "view" cluster roles. For more information about these cluster roles, see User-facing roles in the Kubernetes documentation. To view the contents of the policies, see Access policy permissions in the *Amazon EKS User Guide*. * **name** *(string) --* The name of the access policy. * **arn** *(string) --* The ARN of the access policy. * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / ListAssociatedAccessPolicies ListAssociatedAccessPolicies **************************** class EKS.Paginator.ListAssociatedAccessPolicies paginator = client.get_paginator('list_associated_access_policies') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_associated_access_policies()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( clusterName='string', principalArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **principalArn** (*string*) -- **[REQUIRED]** The ARN of the IAM principal for the "AccessEntry". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'clusterName': 'string', 'principalArn': 'string', 'associatedAccessPolicies': [ { 'policyArn': 'string', 'accessScope': { 'type': 'cluster'|'namespace', 'namespaces': [ 'string', ] }, 'associatedAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **clusterName** *(string) --* The name of your cluster. * **principalArn** *(string) --* The ARN of the IAM principal for the "AccessEntry". * **associatedAccessPolicies** *(list) --* The list of access policies associated with the access entry. * *(dict) --* An access policy association. * **policyArn** *(string) --* The ARN of the "AccessPolicy". * **accessScope** *(dict) --* The scope of the access policy. * **type** *(string) --* The scope type of an access policy. * **namespaces** *(list) --* A Kubernetes "namespace" that an access policy is scoped to. A value is required if you specified "namespace" for "Type". * *(string) --* * **associatedAt** *(datetime) --* The date and time the "AccessPolicy" was associated with an "AccessEntry". * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / ListAccessEntries ListAccessEntries ***************** class EKS.Paginator.ListAccessEntries paginator = client.get_paginator('list_access_entries') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_access_entries()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( clusterName='string', associatedPolicyArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **associatedPolicyArn** (*string*) -- The ARN of an "AccessPolicy". When you specify an access policy ARN, only the access entries associated to that access policy are returned. For a list of available policy ARNs, use "ListAccessPolicies". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'accessEntries': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **accessEntries** *(list) --* The list of access entries that exist for the cluster. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / DescribeAddonVersions DescribeAddonVersions ********************* class EKS.Paginator.DescribeAddonVersions paginator = client.get_paginator('describe_addon_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.describe_addon_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( kubernetesVersion='string', addonName='string', types=[ 'string', ], publishers=[ 'string', ], owners=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **kubernetesVersion** (*string*) -- The Kubernetes versions that you can use the add-on with. * **addonName** (*string*) -- The name of the add-on. The name must match one of the names returned by ListAddons. * **types** (*list*) -- The type of the add-on. For valid "types", don't specify a value for this property. * *(string) --* * **publishers** (*list*) -- The publisher of the add-on. For valid "publishers", don't specify a value for this property. * *(string) --* * **owners** (*list*) -- The owner of the add-on. For valid "owners", don't specify a value for this property. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'addons': [ { 'addonName': 'string', 'type': 'string', 'addonVersions': [ { 'addonVersion': 'string', 'architecture': [ 'string', ], 'computeTypes': [ 'string', ], 'compatibilities': [ { 'clusterVersion': 'string', 'platformVersions': [ 'string', ], 'defaultVersion': True|False }, ], 'requiresConfiguration': True|False, 'requiresIamPermissions': True|False }, ], 'publisher': 'string', 'owner': 'string', 'marketplaceInformation': { 'productId': 'string', 'productUrl': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **addons** *(list) --* The list of available versions with Kubernetes version compatibility and other properties. * *(dict) --* Information about an add-on. * **addonName** *(string) --* The name of the add-on. * **type** *(string) --* The type of the add-on. * **addonVersions** *(list) --* An object representing information about available add-on versions and compatible Kubernetes versions. * *(dict) --* Information about an add-on version. * **addonVersion** *(string) --* The version of the add-on. * **architecture** *(list) --* The architectures that the version supports. * *(string) --* * **computeTypes** *(list) --* Indicates the compute type of the add-on version. * *(string) --* * **compatibilities** *(list) --* An object representing the compatibilities of a version. * *(dict) --* Compatibility information. * **clusterVersion** *(string) --* The supported Kubernetes version of the cluster. * **platformVersions** *(list) --* The supported compute platform. * *(string) --* * **defaultVersion** *(boolean) --* The supported default version. * **requiresConfiguration** *(boolean) --* Whether the add-on requires configuration. * **requiresIamPermissions** *(boolean) --* Indicates if the add-on requires IAM Permissions to operate, such as networking permissions. * **publisher** *(string) --* The publisher of the add-on. * **owner** *(string) --* The owner of the add-on. * **marketplaceInformation** *(dict) --* Information about the add-on from the Amazon Web Services Marketplace. * **productId** *(string) --* The product ID from the Amazon Web Services Marketplace. * **productUrl** *(string) --* The product URL from the Amazon Web Services Marketplace. * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / ListNodegroups ListNodegroups ************** class EKS.Paginator.ListNodegroups paginator = client.get_paginator('list_nodegroups') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_nodegroups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( clusterName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'nodegroups': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **nodegroups** *(list) --* A list of all of the node groups associated with the specified cluster. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / ListInsights ListInsights ************ class EKS.Paginator.ListInsights paginator = client.get_paginator('list_insights') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_insights()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( clusterName='string', filter={ 'categories': [ 'UPGRADE_READINESS'|'MISCONFIGURATION', ], 'kubernetesVersions': [ 'string', ], 'statuses': [ 'PASSING'|'WARNING'|'ERROR'|'UNKNOWN', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of the Amazon EKS cluster associated with the insights. * **filter** (*dict*) -- The criteria to filter your list of insights for your cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. * **categories** *(list) --* The categories to use to filter insights. The following lists the available categories: * "UPGRADE_READINESS": Amazon EKS identifies issues that could impact your ability to upgrade to new versions of Kubernetes. These are called upgrade insights. * "MISCONFIGURATION": Amazon EKS identifies misconfiguration in your EKS Hybrid Nodes setup that could impair functionality of your cluster or workloads. These are called configuration insights. * *(string) --* * **kubernetesVersions** *(list) --* The Kubernetes versions to use to filter the insights. * *(string) --* * **statuses** *(list) --* The statuses to use to filter the insights. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'insights': [ { 'id': 'string', 'name': 'string', 'category': 'UPGRADE_READINESS'|'MISCONFIGURATION', 'kubernetesVersion': 'string', 'lastRefreshTime': datetime(2015, 1, 1), 'lastTransitionTime': datetime(2015, 1, 1), 'description': 'string', 'insightStatus': { 'status': 'PASSING'|'WARNING'|'ERROR'|'UNKNOWN', 'reason': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **insights** *(list) --* The returned list of insights. * *(dict) --* The summarized description of the insight. * **id** *(string) --* The ID of the insight. * **name** *(string) --* The name of the insight. * **category** *(string) --* The category of the insight. * **kubernetesVersion** *(string) --* The Kubernetes minor version associated with an insight if applicable. * **lastRefreshTime** *(datetime) --* The time Amazon EKS last successfully completed a refresh of this insight check on the cluster. * **lastTransitionTime** *(datetime) --* The time the status of the insight last changed. * **description** *(string) --* The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown). * **insightStatus** *(dict) --* An object containing more detail on the status of the insight. * **status** *(string) --* The status of the resource. * **reason** *(string) --* Explanation on the reasoning for the status of the resource. * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / ListUpdates ListUpdates *********** class EKS.Paginator.ListUpdates paginator = client.get_paginator('list_updates') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_updates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( name='string', nodegroupName='string', addonName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the Amazon EKS cluster to list updates for. * **nodegroupName** (*string*) -- The name of the Amazon EKS managed node group to list updates for. * **addonName** (*string*) -- The names of the installed add- ons that have available updates. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'updateIds': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **updateIds** *(list) --* A list of all the updates for the specified cluster and Region. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / ListClusters ListClusters ************ class EKS.Paginator.ListClusters paginator = client.get_paginator('list_clusters') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_clusters()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( include=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **include** (*list*) -- Indicates whether external clusters are included in the returned list. Use ' "all"' to return *https://docs.aws.amazon.com/eks/latest/userguide/eks- connector.html `__connected clusters, or blank to return only Amazon EKS clusters. ' ``all`*' must be in lowercase otherwise an error occurs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'clusters': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **clusters** *(list) --* A list of all of the clusters for your account in the specified Amazon Web Services Region . * *(string) --* * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / ListEksAnywhereSubscriptions ListEksAnywhereSubscriptions **************************** class EKS.Paginator.ListEksAnywhereSubscriptions paginator = client.get_paginator('list_eks_anywhere_subscriptions') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_eks_anywhere_subscriptions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( includeStatus=[ 'CREATING'|'ACTIVE'|'UPDATING'|'EXPIRING'|'EXPIRED'|'DELETING', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **includeStatus** (*list*) -- An array of subscription statuses to filter on. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'subscriptions': [ { 'id': 'string', 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'effectiveDate': datetime(2015, 1, 1), 'expirationDate': datetime(2015, 1, 1), 'licenseQuantity': 123, 'licenseType': 'Cluster', 'term': { 'duration': 123, 'unit': 'MONTHS' }, 'status': 'string', 'autoRenew': True|False, 'licenseArns': [ 'string', ], 'licenses': [ { 'id': 'string', 'token': 'string' }, ], 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **subscriptions** *(list) --* A list of all subscription objects in the region, filtered by includeStatus and paginated by nextToken and maxResults. * *(dict) --* An EKS Anywhere subscription authorizing the customer to support for licensed clusters and access to EKS Anywhere Curated Packages. * **id** *(string) --* UUID identifying a subscription. * **arn** *(string) --* The Amazon Resource Name (ARN) for the subscription. * **createdAt** *(datetime) --* The Unix timestamp in seconds for when the subscription was created. * **effectiveDate** *(datetime) --* The Unix timestamp in seconds for when the subscription is effective. * **expirationDate** *(datetime) --* The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object. * **licenseQuantity** *(integer) --* The number of licenses included in a subscription. Valid values are between 1 and 100. * **licenseType** *(string) --* The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster. * **term** *(dict) --* An EksAnywhereSubscriptionTerm object. * **duration** *(integer) --* The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription. * **unit** *(string) --* The term unit of the subscription. Valid value is "MONTHS". * **status** *(string) --* The status of a subscription. * **autoRenew** *(boolean) --* A boolean indicating whether or not a subscription will auto renew when it expires. * **licenseArns** *(list) --* Amazon Web Services License Manager ARN associated with the subscription. * *(string) --* * **licenses** *(list) --* Includes all of the claims in the license token necessary to validate the license for extended support. * *(dict) --* An EKS Anywhere license associated with a subscription. * **id** *(string) --* An id associated with an EKS Anywhere subscription license. * **token** *(string) --* An optional license token that can be used for extended support verification. * **tags** *(dict) --* The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription. * *(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). * **NextToken** *(string) --* A token to resume pagination. EKS / Paginator / ListIdentityProviderConfigs ListIdentityProviderConfigs *************************** class EKS.Paginator.ListIdentityProviderConfigs paginator = client.get_paginator('list_identity_provider_configs') paginate(**kwargs) Creates an iterator that will paginate through responses from "EKS.Client.list_identity_provider_configs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( clusterName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'identityProviderConfigs': [ { 'type': 'string', 'name': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **identityProviderConfigs** *(list) --* The identity provider configurations for the cluster. * *(dict) --* An object representing an identity provider configuration. * **type** *(string) --* The type of the identity provider configuration. The only type available is "oidc". * **name** *(string) --* The name of the identity provider configuration. * **NextToken** *(string) --* A token to resume pagination. EKS / Client / describe_update describe_update *************** EKS.Client.describe_update(**kwargs) Describes an update to an Amazon EKS resource. When the status of the update is "Successful", the update is complete. If an update fails, the status is "Failed", and an error detail explains the reason for the failure. See also: AWS API Documentation **Request Syntax** response = client.describe_update( name='string', updateId='string', nodegroupName='string', addonName='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the Amazon EKS cluster associated with the update. * **updateId** (*string*) -- **[REQUIRED]** The ID of the update to describe. * **nodegroupName** (*string*) -- The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update. * **addonName** (*string*) -- The name of the add-on. The name must match one of the names returned by ListAddons. This parameter is required if the update is an add-on update. Return type: dict Returns: **Response Syntax** { 'update': { 'id': 'string', 'status': 'InProgress'|'Failed'|'Cancelled'|'Successful', 'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate'|'AccessConfigUpdate'|'UpgradePolicyUpdate'|'ZonalShiftConfigUpdate'|'AutoModeUpdate'|'RemoteNetworkConfigUpdate'|'DeletionProtectionUpdate', 'params': [ { 'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'TaintsToAdd'|'TaintsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'LaunchTemplateName'|'LaunchTemplateVersion'|'IdentityProviderConfig'|'EncryptionConfig'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts'|'MaxUnavailable'|'MaxUnavailablePercentage'|'NodeRepairEnabled'|'UpdateStrategy'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig'|'ComputeConfig'|'StorageConfig'|'KubernetesNetworkConfig'|'RemoteNetworkConfig'|'DeletionProtection', 'value': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'errors': [ { 'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound', 'errorMessage': 'string', 'resourceIds': [ 'string', ] }, ] } } **Response Structure** * *(dict) --* * **update** *(dict) --* The full description of the specified update. * **id** *(string) --* A UUID that is used to track the update. * **status** *(string) --* The current status of the update. * **type** *(string) --* The type of the update. * **params** *(list) --* A key-value map that contains the parameters associated with the update. * *(dict) --* An object representing the details of an update request. * **type** *(string) --* The keys associated with an update request. * **value** *(string) --* The value of the keys submitted as part of an update request. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **errors** *(list) --* Any errors associated with a "Failed" update. * *(dict) --* An object representing an error when an asynchronous operation fails. * **errorCode** *(string) --* A brief description of the error. * **SubnetNotFound**: We couldn't find one of the subnets associated with the cluster. * **SecurityGroupNotFound**: We couldn't find one of the security groups associated with the cluster. * **EniLimitReached**: You have reached the elastic network interface limit for your account. * **IpNotAvailable**: A subnet associated with the cluster doesn't have any available IP addresses. * **AccessDenied**: You don't have permissions to perform the specified operation. * **OperationNotPermitted**: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS. * **VpcIdNotFound**: We couldn't find the VPC associated with the cluster. * **errorMessage** *(string) --* A more complete description of the error. * **resourceIds** *(list) --* An optional field that contains the resource IDs associated with the error. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" EKS / Client / describe_addon_versions describe_addon_versions *********************** EKS.Client.describe_addon_versions(**kwargs) Describes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the "owner", "publisher", and the "type" of the add-on are returned. See also: AWS API Documentation **Request Syntax** response = client.describe_addon_versions( kubernetesVersion='string', maxResults=123, nextToken='string', addonName='string', types=[ 'string', ], publishers=[ 'string', ], owners=[ 'string', ] ) Parameters: * **kubernetesVersion** (*string*) -- The Kubernetes versions that you can use the add-on with. * **maxResults** (*integer*) -- The maximum number of results, returned in paginated output. You receive "maxResults" in a single page, along with a "nextToken" response element. You can see the remaining results of the initial request by sending another request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a "nextToken" value, if applicable, are returned. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. * **addonName** (*string*) -- The name of the add-on. The name must match one of the names returned by ListAddons. * **types** (*list*) -- The type of the add-on. For valid "types", don't specify a value for this property. * *(string) --* * **publishers** (*list*) -- The publisher of the add-on. For valid "publishers", don't specify a value for this property. * *(string) --* * **owners** (*list*) -- The owner of the add-on. For valid "owners", don't specify a value for this property. * *(string) --* Return type: dict Returns: **Response Syntax** { 'addons': [ { 'addonName': 'string', 'type': 'string', 'addonVersions': [ { 'addonVersion': 'string', 'architecture': [ 'string', ], 'computeTypes': [ 'string', ], 'compatibilities': [ { 'clusterVersion': 'string', 'platformVersions': [ 'string', ], 'defaultVersion': True|False }, ], 'requiresConfiguration': True|False, 'requiresIamPermissions': True|False }, ], 'publisher': 'string', 'owner': 'string', 'marketplaceInformation': { 'productId': 'string', 'productUrl': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **addons** *(list) --* The list of available versions with Kubernetes version compatibility and other properties. * *(dict) --* Information about an add-on. * **addonName** *(string) --* The name of the add-on. * **type** *(string) --* The type of the add-on. * **addonVersions** *(list) --* An object representing information about available add- on versions and compatible Kubernetes versions. * *(dict) --* Information about an add-on version. * **addonVersion** *(string) --* The version of the add-on. * **architecture** *(list) --* The architectures that the version supports. * *(string) --* * **computeTypes** *(list) --* Indicates the compute type of the add-on version. * *(string) --* * **compatibilities** *(list) --* An object representing the compatibilities of a version. * *(dict) --* Compatibility information. * **clusterVersion** *(string) --* The supported Kubernetes version of the cluster. * **platformVersions** *(list) --* The supported compute platform. * *(string) --* * **defaultVersion** *(boolean) --* The supported default version. * **requiresConfiguration** *(boolean) --* Whether the add-on requires configuration. * **requiresIamPermissions** *(boolean) --* Indicates if the add-on requires IAM Permissions to operate, such as networking permissions. * **publisher** *(string) --* The publisher of the add-on. * **owner** *(string) --* The owner of the add-on. * **marketplaceInformation** *(dict) --* Information about the add-on from the Amazon Web Services Marketplace. * **productId** *(string) --* The product ID from the Amazon Web Services Marketplace. * **productUrl** *(string) --* The product URL from the Amazon Web Services Marketplace. * **nextToken** *(string) --* The "nextToken" value to include in a future "DescribeAddonVersions" request. When the results of a "DescribeAddonVersions" request exceed "maxResults", you can use this value to retrieve the next page of results. This value is "null" when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidParameterException" EKS / Client / create_nodegroup create_nodegroup **************** EKS.Client.create_nodegroup(**kwargs) Creates a managed node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For later updates, you will only be able to update a node group using a launch template only if it was originally deployed with a launch template. Additionally, the launch template ID or name must match what was used when the node group was created. You can update the launch template version with necessary changes. For more information about using launch templates, see Customizing managed nodes with launch templates. An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. For more information, see Managed node groups in the *Amazon EKS User Guide*. Note: Windows AMI types are only supported for commercial Amazon Web Services Regions that support Windows on Amazon EKS. See also: AWS API Documentation **Request Syntax** response = client.create_nodegroup( clusterName='string', nodegroupName='string', scalingConfig={ 'minSize': 123, 'maxSize': 123, 'desiredSize': 123 }, diskSize=123, subnets=[ 'string', ], instanceTypes=[ 'string', ], amiType='AL2_x86_64'|'AL2_x86_64_GPU'|'AL2_ARM_64'|'CUSTOM'|'BOTTLEROCKET_ARM_64'|'BOTTLEROCKET_x86_64'|'BOTTLEROCKET_ARM_64_FIPS'|'BOTTLEROCKET_x86_64_FIPS'|'BOTTLEROCKET_ARM_64_NVIDIA'|'BOTTLEROCKET_x86_64_NVIDIA'|'WINDOWS_CORE_2019_x86_64'|'WINDOWS_FULL_2019_x86_64'|'WINDOWS_CORE_2022_x86_64'|'WINDOWS_FULL_2022_x86_64'|'AL2023_x86_64_STANDARD'|'AL2023_ARM_64_STANDARD'|'AL2023_x86_64_NEURON'|'AL2023_x86_64_NVIDIA'|'AL2023_ARM_64_NVIDIA', remoteAccess={ 'ec2SshKey': 'string', 'sourceSecurityGroups': [ 'string', ] }, nodeRole='string', labels={ 'string': 'string' }, taints=[ { 'key': 'string', 'value': 'string', 'effect': 'NO_SCHEDULE'|'NO_EXECUTE'|'PREFER_NO_SCHEDULE' }, ], tags={ 'string': 'string' }, clientRequestToken='string', launchTemplate={ 'name': 'string', 'version': 'string', 'id': 'string' }, updateConfig={ 'maxUnavailable': 123, 'maxUnavailablePercentage': 123, 'updateStrategy': 'DEFAULT'|'MINIMAL' }, nodeRepairConfig={ 'enabled': True|False }, capacityType='ON_DEMAND'|'SPOT'|'CAPACITY_BLOCK', version='string', releaseVersion='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **nodegroupName** (*string*) -- **[REQUIRED]** The unique name to give your node group. * **scalingConfig** (*dict*) -- The scaling configuration details for the Auto Scaling group that is created for your node group. * **minSize** *(integer) --* The minimum number of nodes that the managed node group can scale in to. * **maxSize** *(integer) --* The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the *Amazon EKS User Guide*. * **desiredSize** *(integer) --* The current number of nodes that the managed node group should maintain. Warning: If you use the Kubernetes Cluster Autoscaler, you shouldn't change the "desiredSize" value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down. Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template. This parameter can be different from "minSize" in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the "desiredSize" parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than "minSize" or higher than "maxSize". * **diskSize** (*integer*) -- The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify "launchTemplate", then don't specify "diskSize", or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the *Amazon EKS User Guide*. * **subnets** (*list*) -- **[REQUIRED]** The subnets to use for the Auto Scaling group that is created for your node group. If you specify "launchTemplate", then don't specify "SubnetId" in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the *Amazon EKS User Guide*. * *(string) --* * **instanceTypes** (*list*) -- Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the "amiType" parameter. If you specify "launchTemplate", then you can specify zero or one instance type in your launch template *or* you can specify 0-20 instance types for "instanceTypes". If however, you specify an instance type in your launch template *and* specify any "instanceTypes", the node group deployment will fail. If you don't specify an instance type in a launch template or for "instanceTypes", then "t3.medium" is used, by default. If you specify "Spot" for "capacityType", then we recommend specifying multiple values for "instanceTypes". For more information, see Managed node group capacity types and Customizing managed nodes with launch templates in the *Amazon EKS User Guide*. * *(string) --* * **amiType** (*string*) -- The AMI type for your node group. If you specify "launchTemplate", and your launch template uses a custom AMI, then don't specify "amiType", or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add "eks:kube-proxy-windows" to your Windows nodes "rolearn" in the "aws-auth" "ConfigMap". For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the *Amazon EKS User Guide*. * **remoteAccess** (*dict*) -- The remote access configuration to use with your node group. For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify "launchTemplate", then don't specify "remoteAccess", or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the *Amazon EKS User Guide*. * **ec2SshKey** *(string) --* The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. For Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more information, see Amazon EC2 key pairs and Windows instances in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*. * **sourceSecurityGroups** *(list) --* The security group IDs that are allowed SSH access (port 22) to the nodes. For Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet ( "0.0.0.0/0"). For more information, see Security Groups for Your VPC in the *Amazon Virtual Private Cloud User Guide*. * *(string) --* * **nodeRole** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node "kubelet" daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the *Amazon EKS User Guide* . If you specify "launchTemplate", then don't specify "IamInstanceProfile" in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the *Amazon EKS User Guide*. * **labels** (*dict*) -- The Kubernetes "labels" to apply to the nodes in the node group when they are created. * *(string) --* * *(string) --* * **taints** (*list*) -- The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups. * *(dict) --* A property that allows a node to repel a "Pod". For more information, see Node taints on managed node groups in the *Amazon EKS User Guide*. * **key** *(string) --* The key of the taint. * **value** *(string) --* The value of the taint. * **effect** *(string) --* The effect of the taint. * **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). * **clientRequestToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. * **launchTemplate** (*dict*) -- An object representing a node group's launch template specification. When using this object, don't directly specify "instanceTypes", "diskSize", or "remoteAccess". You cannot later specify a different launch template ID or name than what was used to create the node group. Make sure that the launch template meets the requirements in "launchTemplateSpecification". Also refer to Customizing managed nodes with launch templates in the *Amazon EKS User Guide*. * **name** *(string) --* The name of the launch template. You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name. * **version** *(string) --* The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates. * **id** *(string) --* The ID of the launch template. You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID. * **updateConfig** (*dict*) -- The node group update configuration. * **maxUnavailable** *(integer) --* The maximum number of nodes unavailable at once during a version update. Nodes are updated in parallel. This value or "maxUnavailablePercentage" is required to have a value.The maximum number is 100. * **maxUnavailablePercentage** *(integer) --* The maximum percentage of nodes unavailable during a version update. This percentage of nodes are updated in parallel, up to 100 nodes at once. This value or "maxUnavailable" is required to have a value. * **updateStrategy** *(string) --* The configuration for the behavior to follow during a node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action. An Amazon EKS managed node group updates by replacing nodes with new nodes of newer AMI versions in parallel. The *update strategy* changes the managed node update behavior of the managed node group for each quantity. The *default* strategy has guardrails to protect you from misconfiguration and launches the new instances first, before terminating the old instances. The *minimal* strategy removes the guardrails and terminates the old instances before launching the new instances. This minimal strategy is useful in scenarios where you are constrained to resources or costs (for example, with hardware accelerators such as GPUs). * **nodeRepairConfig** (*dict*) -- The node auto repair configuration for the node group. * **enabled** *(boolean) --* Specifies whether to enable node auto repair for the node group. Node auto repair is disabled by default. * **capacityType** (*string*) -- The capacity type for your node group. * **version** (*string*) -- The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify "launchTemplate", and your launch template uses a custom AMI, then don't specify "version", or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the *Amazon EKS User Guide*. * **releaseVersion** (*string*) -- The AMI version of the Amazon EKS optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the *Amazon EKS User Guide*. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the *Amazon EKS User Guide*. If you specify "launchTemplate", and your launch template uses a custom AMI, then don't specify "releaseVersion", or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the *Amazon EKS User Guide*. Return type: dict Returns: **Response Syntax** { 'nodegroup': { 'nodegroupName': 'string', 'nodegroupArn': 'string', 'clusterName': 'string', 'version': 'string', 'releaseVersion': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'|'DEGRADED', 'capacityType': 'ON_DEMAND'|'SPOT'|'CAPACITY_BLOCK', 'scalingConfig': { 'minSize': 123, 'maxSize': 123, 'desiredSize': 123 }, 'instanceTypes': [ 'string', ], 'subnets': [ 'string', ], 'remoteAccess': { 'ec2SshKey': 'string', 'sourceSecurityGroups': [ 'string', ] }, 'amiType': 'AL2_x86_64'|'AL2_x86_64_GPU'|'AL2_ARM_64'|'CUSTOM'|'BOTTLEROCKET_ARM_64'|'BOTTLEROCKET_x86_64'|'BOTTLEROCKET_ARM_64_FIPS'|'BOTTLEROCKET_x86_64_FIPS'|'BOTTLEROCKET_ARM_64_NVIDIA'|'BOTTLEROCKET_x86_64_NVIDIA'|'WINDOWS_CORE_2019_x86_64'|'WINDOWS_FULL_2019_x86_64'|'WINDOWS_CORE_2022_x86_64'|'WINDOWS_FULL_2022_x86_64'|'AL2023_x86_64_STANDARD'|'AL2023_ARM_64_STANDARD'|'AL2023_x86_64_NEURON'|'AL2023_x86_64_NVIDIA'|'AL2023_ARM_64_NVIDIA', 'nodeRole': 'string', 'labels': { 'string': 'string' }, 'taints': [ { 'key': 'string', 'value': 'string', 'effect': 'NO_SCHEDULE'|'NO_EXECUTE'|'PREFER_NO_SCHEDULE' }, ], 'resources': { 'autoScalingGroups': [ { 'name': 'string' }, ], 'remoteAccessSecurityGroup': 'string' }, 'diskSize': 123, 'health': { 'issues': [ { 'code': 'AutoScalingGroupNotFound'|'AutoScalingGroupInvalidConfiguration'|'Ec2SecurityGroupNotFound'|'Ec2SecurityGroupDeletionFailure'|'Ec2LaunchTemplateNotFound'|'Ec2LaunchTemplateVersionMismatch'|'Ec2SubnetNotFound'|'Ec2SubnetInvalidConfiguration'|'IamInstanceProfileNotFound'|'Ec2SubnetMissingIpv6Assignment'|'IamLimitExceeded'|'IamNodeRoleNotFound'|'NodeCreationFailure'|'AsgInstanceLaunchFailures'|'InstanceLimitExceeded'|'InsufficientFreeAddresses'|'AccessDenied'|'InternalFailure'|'ClusterUnreachable'|'AmiIdNotFound'|'AutoScalingGroupOptInRequired'|'AutoScalingGroupRateLimitExceeded'|'Ec2LaunchTemplateDeletionFailure'|'Ec2LaunchTemplateInvalidConfiguration'|'Ec2LaunchTemplateMaxLimitExceeded'|'Ec2SubnetListTooLong'|'IamThrottling'|'NodeTerminationFailure'|'PodEvictionFailure'|'SourceEc2LaunchTemplateNotFound'|'LimitExceeded'|'Unknown'|'AutoScalingGroupInstanceRefreshActive'|'KubernetesLabelInvalid'|'Ec2LaunchTemplateVersionMaxLimitExceeded'|'Ec2InstanceTypeDoesNotExist', 'message': 'string', 'resourceIds': [ 'string', ] }, ] }, 'updateConfig': { 'maxUnavailable': 123, 'maxUnavailablePercentage': 123, 'updateStrategy': 'DEFAULT'|'MINIMAL' }, 'nodeRepairConfig': { 'enabled': True|False }, 'launchTemplate': { 'name': 'string', 'version': 'string', 'id': 'string' }, 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **nodegroup** *(dict) --* The full description of your new node group. * **nodegroupName** *(string) --* The name associated with an Amazon EKS managed node group. * **nodegroupArn** *(string) --* The Amazon Resource Name (ARN) associated with the managed node group. * **clusterName** *(string) --* The name of your cluster. * **version** *(string) --* The Kubernetes version of the managed node group. * **releaseVersion** *(string) --* If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. * **status** *(string) --* The current status of the managed node group. * **capacityType** *(string) --* The capacity type of your managed node group. * **scalingConfig** *(dict) --* The scaling configuration details for the Auto Scaling group that is associated with your node group. * **minSize** *(integer) --* The minimum number of nodes that the managed node group can scale in to. * **maxSize** *(integer) --* The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the *Amazon EKS User Guide*. * **desiredSize** *(integer) --* The current number of nodes that the managed node group should maintain. Warning: If you use the Kubernetes Cluster Autoscaler, you shouldn't change the "desiredSize" value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down. Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template. This parameter can be different from "minSize" in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the "desiredSize" parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than "minSize" or higher than "maxSize". * **instanceTypes** *(list) --* If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is "null". * *(string) --* * **subnets** *(list) --* The subnets that were specified for the Auto Scaling group that is associated with your node group. * *(string) --* * **remoteAccess** *(dict) --* If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is "null". * **ec2SshKey** *(string) --* The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. For Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more information, see Amazon EC2 key pairs and Windows instances in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*. * **sourceSecurityGroups** *(list) --* The security group IDs that are allowed SSH access (port 22) to the nodes. For Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet ( "0.0.0.0/0"). For more information, see Security Groups for Your VPC in the *Amazon Virtual Private Cloud User Guide*. * *(string) --* * **amiType** *(string) --* If the node group was deployed using a launch template with a custom AMI, then this is "CUSTOM". For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration. * **nodeRole** *(string) --* The IAM role associated with your node group. The Amazon EKS node "kubelet" daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. * **labels** *(dict) --* The Kubernetes "labels" applied to the nodes in the node group. Note: Only "labels" that are applied with the Amazon EKS API are shown here. There may be other Kubernetes "labels" applied to the nodes in this group. * *(string) --* * *(string) --* * **taints** *(list) --* The Kubernetes taints to be applied to the nodes in the node group when they are created. Effect is one of "No_Schedule", "Prefer_No_Schedule", or "No_Execute". Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. For more information, see Node taints on managed node groups. * *(dict) --* A property that allows a node to repel a "Pod". For more information, see Node taints on managed node groups in the *Amazon EKS User Guide*. * **key** *(string) --* The key of the taint. * **value** *(string) --* The value of the taint. * **effect** *(string) --* The effect of the taint. * **resources** *(dict) --* The resources associated with the node group, such as Auto Scaling groups and security groups for remote access. * **autoScalingGroups** *(list) --* The Auto Scaling groups associated with the node group. * *(dict) --* An Auto Scaling group that is associated with an Amazon EKS managed node group. * **name** *(string) --* The name of the Auto Scaling group associated with an Amazon EKS managed node group. * **remoteAccessSecurityGroup** *(string) --* The remote access security group associated with the node group. This security group controls SSH access to the nodes. * **diskSize** *(integer) --* If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is "null". * **health** *(dict) --* The health status of the node group. If there are issues with your node group's health, they are listed here. * **issues** *(list) --* Any issues that are associated with the node group. * *(dict) --* An object representing an issue with an Amazon EKS resource. * **code** *(string) --* A brief description of the error. * **AccessDenied**: Amazon EKS or one or more of your managed nodes is failing to authenticate or authorize with your Kubernetes cluster API server. * **AsgInstanceLaunchFailures**: Your Auto Scaling group is experiencing failures while attempting to launch instances. * **AutoScalingGroupNotFound**: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover. * **ClusterUnreachable**: Amazon EKS or one or more of your managed nodes is unable to to communicate with your Kubernetes cluster API server. This can happen if there are network disruptions or if API servers are timing out processing requests. * **Ec2InstanceTypeDoesNotExist**: One or more of the supplied Amazon EC2 instance types do not exist. Amazon EKS checked for the instance types that you provided in this Amazon Web Services Region, and one or more aren't available. * **Ec2LaunchTemplateNotFound**: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover. * **Ec2LaunchTemplateVersionMismatch**: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover. * **Ec2SecurityGroupDeletionFailure**: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group. * **Ec2SecurityGroupNotFound**: We couldn't find the cluster security group for the cluster. You must recreate your cluster. * **Ec2SubnetInvalidConfiguration**: One or more Amazon EC2 subnets specified for a node group do not automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned a public IP address, then you need to enable the "auto-assign public IP address" setting for the subnet. See Modifying the public IPv4 addressing attribute for your subnet in the *Amazon VPC User Guide*. * **IamInstanceProfileNotFound**: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover. * **IamNodeRoleNotFound**: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover. * **InstanceLimitExceeded**: Your Amazon Web Services account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover. * **InsufficientFreeAddresses**: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes. * **InternalFailure**: These errors are usually caused by an Amazon EKS server-side issue. * **NodeCreationFailure**: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient node IAM role permissions or lack of outbound internet access for the nodes. * **message** *(string) --* The error message associated with the issue. * **resourceIds** *(list) --* The Amazon Web Services resources that are afflicted by this issue. * *(string) --* * **updateConfig** *(dict) --* The node group update configuration. * **maxUnavailable** *(integer) --* The maximum number of nodes unavailable at once during a version update. Nodes are updated in parallel. This value or "maxUnavailablePercentage" is required to have a value.The maximum number is 100. * **maxUnavailablePercentage** *(integer) --* The maximum percentage of nodes unavailable during a version update. This percentage of nodes are updated in parallel, up to 100 nodes at once. This value or "maxUnavailable" is required to have a value. * **updateStrategy** *(string) --* The configuration for the behavior to follow during a node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action. An Amazon EKS managed node group updates by replacing nodes with new nodes of newer AMI versions in parallel. The *update strategy* changes the managed node update behavior of the managed node group for each quantity. The *default* strategy has guardrails to protect you from misconfiguration and launches the new instances first, before terminating the old instances. The *minimal* strategy removes the guardrails and terminates the old instances before launching the new instances. This minimal strategy is useful in scenarios where you are constrained to resources or costs (for example, with hardware accelerators such as GPUs). * **nodeRepairConfig** *(dict) --* The node auto repair configuration for the node group. * **enabled** *(boolean) --* Specifies whether to enable node auto repair for the node group. Node auto repair is disabled by default. * **launchTemplate** *(dict) --* If a launch template was used to create the node group, then this is the launch template that was used. * **name** *(string) --* The name of the launch template. You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name. * **version** *(string) --* The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates. * **id** *(string) --* The ID of the launch template. You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID. * **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). **Exceptions** * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourceLimitExceededException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" EKS / Client / get_paginator get_paginator ************* EKS.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. 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. The endpoint domain name and IP address family depends on the value of the "ipFamily" for the cluster. 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 Allowing users to access your cluster and Launching Amazon EKS nodes in the *Amazon EKS User Guide*. See also: AWS API Documentation **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', 'elasticLoadBalancing': { 'enabled': True|False } }, 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' }, bootstrapSelfManagedAddons=True|False, upgradePolicy={ 'supportType': 'STANDARD'|'EXTENDED' }, zonalShiftConfig={ 'enabled': True|False }, remoteNetworkConfig={ 'remoteNodeNetworks': [ { 'cidrs': [ 'string', ] }, ], 'remotePodNetworks': [ { 'cidrs': [ 'string', ] }, ] }, computeConfig={ 'enabled': True|False, 'nodePools': [ 'string', ], 'nodeRoleArn': 'string' }, storageConfig={ 'blockStorage': { 'enabled': True|False } }, deletionProtection=True|False ) Parameters: * **name** (*string*) -- **[REQUIRED]** 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. * **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. The endpoint domain name and IP address family depends on the value of the "ipFamily" for the cluster. For more information, see Cluster API server endpoint 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 Cluster API server endpoint 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" and additionally "::/0" for dual-stack *IPv6* clusters. 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 Cluster API server endpoint in the *Amazon EKS User Guide* . Note that the public endpoints are dual-stack for only "IPv6" clusters that are made after October 2024. You can't add "IPv6" CIDR blocks to "IPv4" clusters or "IPv6" clusters that were made before October 2024. * *(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. * **elasticLoadBalancing** *(dict) --* Request to enable or disable the load balancing capability on your EKS Auto Mode cluster. For more information, see EKS Auto Mode load balancing capability in the *Amazon EKS User Guide*. * **enabled** *(boolean) --* Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account. * **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". * **bootstrapSelfManagedAddons** (*boolean*) -- If you set this value to "False" when creating a cluster, the default networking add-ons will not be installed. The default networking add-ons include "vpc-cni", "coredns", and "kube-proxy". Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add- ons. * **upgradePolicy** (*dict*) -- New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to "STANDARD". * **supportType** *(string) --* If the cluster is set to "EXTENDED", it will enter extended support at the end of standard support. If the cluster is set to "STANDARD", it will be automatically upgraded at the end of standard support. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **zonalShiftConfig** (*dict*) -- Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster. 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. 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 *zonal autoshift*. 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 Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS in the *Amazon EKS User Guide* . * **enabled** *(boolean) --* If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster. * **remoteNetworkConfig** (*dict*) -- The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. * **remoteNodeNetworks** *(list) --* The list of network CIDRs that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * *(dict) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * **cidrs** *(list) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to- Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * *(string) --* * **remotePodNetworks** *(list) --* The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * *(dict) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * **cidrs** *(list) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on- premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * *(string) --* * **computeConfig** (*dict*) -- 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 * **enabled** *(boolean) --* Request to enable or disable the compute capability on 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. * **nodePools** *(list) --* Configuration for node pools that defines the compute resources for your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the *Amazon EKS User Guide*. * *(string) --* * **nodeRoleArn** *(string) --* The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. This value cannot be changed after the compute capability of EKS Auto Mode is enabled. For more information, see the IAM Reference in the *Amazon EKS User Guide*. * **storageConfig** (*dict*) -- 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. * **blockStorage** *(dict) --* Request to configure EBS Block Storage settings for your EKS Auto Mode cluster. * **enabled** *(boolean) --* Indicates if the block storage capability is enabled on 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. * **deletionProtection** (*boolean*) -- 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 "false". 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', 'elasticLoadBalancing': { 'enabled': True|False } }, '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' }, 'upgradePolicy': { 'supportType': 'STANDARD'|'EXTENDED' }, 'zonalShiftConfig': { 'enabled': True|False }, 'remoteNetworkConfig': { 'remoteNodeNetworks': [ { 'cidrs': [ 'string', ] }, ], 'remotePodNetworks': [ { 'cidrs': [ 'string', ] }, ] }, 'computeConfig': { 'enabled': True|False, 'nodePools': [ 'string', ], 'nodeRoleArn': 'string' }, 'storageConfig': { 'blockStorage': { 'enabled': True|False } }, 'deletionProtection': True|False } } **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 Cluster API server endpoint 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" and additionally "::/0" for dual- stack *IPv6* clusters. 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 Cluster API server endpoint in the *Amazon EKS User Guide* . Note that the public endpoints are dual-stack for only "IPv6" clusters that are made after October 2024. You can't add "IPv6" CIDR blocks to "IPv4" clusters or "IPv6" clusters that were made before October 2024. * *(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. * **elasticLoadBalancing** *(dict) --* Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. * **enabled** *(boolean) --* Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account. * **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 Amazon EKS cluster. * **issues** *(list) --* An object representing the health issues of your Amazon EKS cluster. * *(dict) --* An issue with your Amazon EKS cluster. * **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. * **upgradePolicy** *(dict) --* This value indicates if extended support is enabled or disabled for the cluster. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **supportType** *(string) --* If the cluster is set to "EXTENDED", it will enter extended support at the end of standard support. If the cluster is set to "STANDARD", it will be automatically upgraded at the end of standard support. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **zonalShiftConfig** *(dict) --* The configuration for zonal shift for the cluster. * **enabled** *(boolean) --* Whether the zonal shift is enabled. * **remoteNetworkConfig** *(dict) --* The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. * **remoteNodeNetworks** *(list) --* The list of network CIDRs that can contain hybrid nodes. * *(dict) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * **cidrs** *(list) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * *(string) --* * **remotePodNetworks** *(list) --* The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes. * *(dict) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on- premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * **cidrs** *(list) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * *(string) --* * **computeConfig** *(dict) --* Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the *Amazon EKS User Guide*. * **enabled** *(boolean) --* Indicates if the compute capability is enabled on 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. * **nodePools** *(list) --* Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the *Amazon EKS User Guide*. * *(string) --* * **nodeRoleArn** *(string) --* The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. * **storageConfig** *(dict) --* Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the *Amazon EKS User Guide*. * **blockStorage** *(dict) --* Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. * **enabled** *(boolean) --* Indicates if the block storage capability is enabled on 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. * **deletionProtection** *(boolean) --* The current deletion protection setting for the cluster. When "true", deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When "false", the cluster can be deleted normally. This setting only applies to clusters in an active state. **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': { '...': '...', }, } EKS / Client / delete_pod_identity_association delete_pod_identity_association ******************************* EKS.Client.delete_pod_identity_association(**kwargs) Deletes a EKS Pod Identity association. The temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console. See also: AWS API Documentation **Request Syntax** response = client.delete_pod_identity_association( clusterName='string', associationId='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The cluster name that * **associationId** (*string*) -- **[REQUIRED]** The ID of the association to be deleted. Return type: dict Returns: **Response Syntax** { 'association': { 'clusterName': 'string', 'namespace': 'string', 'serviceAccount': 'string', 'roleArn': 'string', 'associationArn': 'string', 'associationId': 'string', 'tags': { 'string': 'string' }, 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'ownerArn': 'string', 'disableSessionTags': True|False, 'targetRoleArn': 'string', 'externalId': 'string' } } **Response Structure** * *(dict) --* * **association** *(dict) --* The full description of the EKS Pod Identity association that was deleted. * **clusterName** *(string) --* The name of the cluster that the association is in. * **namespace** *(string) --* The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the Pods that use the service account must be in this namespace. * **serviceAccount** *(string) --* The name of the Kubernetes service account inside the cluster to associate the IAM credentials with. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the Pods that use this service account. * **associationArn** *(string) --* The Amazon Resource Name (ARN) of the association. * **associationId** *(string) --* The ID of the association. * **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. The following basic restrictions apply to tags: * Maximum number of tags per resource – 50 * For each resource, each tag key must be unique, and each tag key can have only one value. * Maximum key length – 128 Unicode characters in UTF-8 * Maximum value length – 256 Unicode characters in UTF-8 * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. * Tag keys and values are case-sensitive. * Do not use "aws:", "AWS:", or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. * *(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). * **createdAt** *(datetime) --* The timestamp that the association was created at. * **modifiedAt** *(datetime) --* The most recent timestamp that the association was modified at. * **ownerArn** *(string) --* If defined, the EKS Pod Identity association is owned by an Amazon EKS add-on. * **disableSessionTags** *(boolean) --* The state of the automatic sessions tags. The value of *true* disables these tags. EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to Amazon Web Services resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see List of session tags added by EKS Pod Identity in the *Amazon EKS User Guide*. * **targetRoleArn** *(string) --* The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod. * **externalId** *(string) --* The unique identifier for this EKS Pod Identity association for a target IAM role. You put this value in the trust policy of the target role, in a "Condition" to match the "sts.ExternalId". This ensures that the target role can only be assumed by this association. This prevents the *confused deputy problem*. For more information about the confused deputy problem, see The confused deputy problem in the *IAM User Guide*. If you want to use the same target role with multiple associations or other roles, use independent statements in the trust policy to allow "sts:AssumeRole" access from each role. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" EKS / Client / update_pod_identity_association update_pod_identity_association ******************************* EKS.Client.update_pod_identity_association(**kwargs) Updates a EKS Pod Identity association. In an update, you can change the IAM role, the target IAM role, or "disableSessionTags". You must change at least one of these in an update. An association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings. Similar to Amazon Web Services IAM behavior, EKS Pod Identity associations are eventually consistent, and may take several seconds to be effective after the initial API call returns successfully. You must design your applications to account for these potential delays. We recommend that you don’t include association create/updates in the critical, high-availability code paths of your application. Instead, make changes in a separate initialization or setup routine that you run less frequently. You can set a *target IAM role* in the same or a different account for advanced scenarios. With a target role, EKS Pod Identity automatically performs two role assumptions in sequence: first assuming the role in the association that is in this account, then using those credentials to assume the target IAM role. This process provides your Pod with temporary credentials that have the permissions defined in the target role, allowing secure access to resources in another Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.update_pod_identity_association( clusterName='string', associationId='string', roleArn='string', clientRequestToken='string', disableSessionTags=True|False, targetRoleArn='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of the cluster that you want to update the association in. * **associationId** (*string*) -- **[REQUIRED]** The ID of the association to be updated. * **roleArn** (*string*) -- The new IAM role to change in the association. * **clientRequestToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. * **disableSessionTags** (*boolean*) -- Disable the automatic sessions tags that are appended by EKS Pod Identity. EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to Amazon Web Services resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see List of session tags added by EKS Pod Identity in the *Amazon EKS User Guide*. Amazon Web Services compresses inline session policies, managed policy ARNs, and session tags into a packed binary format that has a separate limit. If you receive a "PackedPolicyTooLarge" error indicating the packed binary format has exceeded the size limit, you can attempt to reduce the size by disabling the session tags added by EKS Pod Identity. * **targetRoleArn** (*string*) -- The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod. When you run applications on Amazon EKS, your application might need to access Amazon Web Services resources from a different role that exists in the same or different Amazon Web Services account. For example, your application running in “Account A” might need to access resources, such as buckets in “Account B” or within “Account A” itself. You can create a association to access Amazon Web Services resources in “Account B” by creating two IAM roles: a role in “Account A” and a role in “Account B” (which can be the same or different account), each with the necessary trust and permission policies. After you provide these roles in the *IAM role* and *Target IAM role* fields, EKS will perform role chaining to ensure your application gets the required permissions. This means Role A will assume Role B, allowing your Pods to securely access resources like S3 buckets in the target account. Return type: dict Returns: **Response Syntax** { 'association': { 'clusterName': 'string', 'namespace': 'string', 'serviceAccount': 'string', 'roleArn': 'string', 'associationArn': 'string', 'associationId': 'string', 'tags': { 'string': 'string' }, 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'ownerArn': 'string', 'disableSessionTags': True|False, 'targetRoleArn': 'string', 'externalId': 'string' } } **Response Structure** * *(dict) --* * **association** *(dict) --* The full description of the association that was updated. * **clusterName** *(string) --* The name of the cluster that the association is in. * **namespace** *(string) --* The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the Pods that use the service account must be in this namespace. * **serviceAccount** *(string) --* The name of the Kubernetes service account inside the cluster to associate the IAM credentials with. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the Pods that use this service account. * **associationArn** *(string) --* The Amazon Resource Name (ARN) of the association. * **associationId** *(string) --* The ID of the association. * **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. The following basic restrictions apply to tags: * Maximum number of tags per resource – 50 * For each resource, each tag key must be unique, and each tag key can have only one value. * Maximum key length – 128 Unicode characters in UTF-8 * Maximum value length – 256 Unicode characters in UTF-8 * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. * Tag keys and values are case-sensitive. * Do not use "aws:", "AWS:", or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. * *(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). * **createdAt** *(datetime) --* The timestamp that the association was created at. * **modifiedAt** *(datetime) --* The most recent timestamp that the association was modified at. * **ownerArn** *(string) --* If defined, the EKS Pod Identity association is owned by an Amazon EKS add-on. * **disableSessionTags** *(boolean) --* The state of the automatic sessions tags. The value of *true* disables these tags. EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to Amazon Web Services resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see List of session tags added by EKS Pod Identity in the *Amazon EKS User Guide*. * **targetRoleArn** *(string) --* The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod. * **externalId** *(string) --* The unique identifier for this EKS Pod Identity association for a target IAM role. You put this value in the trust policy of the target role, in a "Condition" to match the "sts.ExternalId". This ensures that the target role can only be assumed by this association. This prevents the *confused deputy problem*. For more information about the confused deputy problem, see The confused deputy problem in the *IAM User Guide*. If you want to use the same target role with multiple associations or other roles, use independent statements in the trust policy to allow "sts:AssumeRole" access from each role. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" EKS / Client / delete_cluster delete_cluster ************** EKS.Client.delete_cluster(**kwargs) Deletes an Amazon EKS cluster control plane. If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a cluster in the *Amazon EKS User Guide*. If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see "DeleteNodgroup" and "DeleteFargateProfile". See also: AWS API Documentation **Request Syntax** response = client.delete_cluster( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name of the cluster to delete. 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', 'elasticLoadBalancing': { 'enabled': True|False } }, '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' }, 'upgradePolicy': { 'supportType': 'STANDARD'|'EXTENDED' }, 'zonalShiftConfig': { 'enabled': True|False }, 'remoteNetworkConfig': { 'remoteNodeNetworks': [ { 'cidrs': [ 'string', ] }, ], 'remotePodNetworks': [ { 'cidrs': [ 'string', ] }, ] }, 'computeConfig': { 'enabled': True|False, 'nodePools': [ 'string', ], 'nodeRoleArn': 'string' }, 'storageConfig': { 'blockStorage': { 'enabled': True|False } }, 'deletionProtection': True|False } } **Response Structure** * *(dict) --* * **cluster** *(dict) --* The full description of the cluster to delete. * **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 Cluster API server endpoint 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" and additionally "::/0" for dual- stack *IPv6* clusters. 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 Cluster API server endpoint in the *Amazon EKS User Guide* . Note that the public endpoints are dual-stack for only "IPv6" clusters that are made after October 2024. You can't add "IPv6" CIDR blocks to "IPv4" clusters or "IPv6" clusters that were made before October 2024. * *(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. * **elasticLoadBalancing** *(dict) --* Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. * **enabled** *(boolean) --* Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account. * **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 Amazon EKS cluster. * **issues** *(list) --* An object representing the health issues of your Amazon EKS cluster. * *(dict) --* An issue with your Amazon EKS cluster. * **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. * **upgradePolicy** *(dict) --* This value indicates if extended support is enabled or disabled for the cluster. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **supportType** *(string) --* If the cluster is set to "EXTENDED", it will enter extended support at the end of standard support. If the cluster is set to "STANDARD", it will be automatically upgraded at the end of standard support. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **zonalShiftConfig** *(dict) --* The configuration for zonal shift for the cluster. * **enabled** *(boolean) --* Whether the zonal shift is enabled. * **remoteNetworkConfig** *(dict) --* The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. * **remoteNodeNetworks** *(list) --* The list of network CIDRs that can contain hybrid nodes. * *(dict) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * **cidrs** *(list) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * *(string) --* * **remotePodNetworks** *(list) --* The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes. * *(dict) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on- premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * **cidrs** *(list) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * *(string) --* * **computeConfig** *(dict) --* Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the *Amazon EKS User Guide*. * **enabled** *(boolean) --* Indicates if the compute capability is enabled on 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. * **nodePools** *(list) --* Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the *Amazon EKS User Guide*. * *(string) --* * **nodeRoleArn** *(string) --* The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. * **storageConfig** *(dict) --* Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the *Amazon EKS User Guide*. * **blockStorage** *(dict) --* Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. * **enabled** *(boolean) --* Indicates if the block storage capability is enabled on 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. * **deletionProtection** *(boolean) --* The current deletion protection setting for the cluster. When "true", deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When "false", the cluster can be deleted normally. This setting only applies to clusters in an active state. **Exceptions** * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" * "EKS.Client.exceptions.InvalidRequestException" **Examples** This example command deletes a cluster named *devel* in your default region. response = client.delete_cluster( name='devel', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EKS / Client / update_nodegroup_version update_nodegroup_version ************************ EKS.Client.update_nodegroup_version(**kwargs) Updates the Kubernetes version or AMI version of an Amazon EKS managed node group. You can update a node group using a launch template only if the node group was originally deployed with a launch template. Additionally, the launch template ID or name must match what was used when the node group was created. You can update the launch template version with necessary changes. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template. If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the *Amazon EKS User Guide*. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the *Amazon EKS User Guide*. You cannot roll back a node group to an earlier Kubernetes version or AMI version. When a node in a managed node group is terminated due to a scaling action or update, every "Pod" on that node is drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can "force" the update if Amazon EKS is unable to drain the nodes as a result of a "Pod" disruption budget issue. See also: AWS API Documentation **Request Syntax** response = client.update_nodegroup_version( clusterName='string', nodegroupName='string', version='string', releaseVersion='string', launchTemplate={ 'name': 'string', 'version': 'string', 'id': 'string' }, force=True|False, clientRequestToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **nodegroupName** (*string*) -- **[REQUIRED]** The name of the managed node group to update. * **version** (*string*) -- The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version. If you specify "launchTemplate", and your launch template uses a custom AMI, then don't specify "version", or the node group update will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the *Amazon EKS User Guide*. * **releaseVersion** (*string*) -- The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the *Amazon EKS User Guide*. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the *Amazon EKS User Guide*. If you specify "launchTemplate", and your launch template uses a custom AMI, then don't specify "releaseVersion", or the node group update will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the *Amazon EKS User Guide*. * **launchTemplate** (*dict*) -- An object representing a node group's launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template. When updating, you must specify the same launch template ID or name that was used to create the node group. * **name** *(string) --* The name of the launch template. You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name. * **version** *(string) --* The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates. * **id** *(string) --* The ID of the launch template. You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID. * **force** (*boolean*) -- Force the update if any "Pod" on the existing node group can't be drained due to a "Pod" disruption budget issue. If an update fails because all Pods can't be drained, you can force the update after it fails to terminate the old node whether or not any "Pod" is running on the node. * **clientRequestToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'update': { 'id': 'string', 'status': 'InProgress'|'Failed'|'Cancelled'|'Successful', 'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate'|'AccessConfigUpdate'|'UpgradePolicyUpdate'|'ZonalShiftConfigUpdate'|'AutoModeUpdate'|'RemoteNetworkConfigUpdate'|'DeletionProtectionUpdate', 'params': [ { 'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'TaintsToAdd'|'TaintsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'LaunchTemplateName'|'LaunchTemplateVersion'|'IdentityProviderConfig'|'EncryptionConfig'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts'|'MaxUnavailable'|'MaxUnavailablePercentage'|'NodeRepairEnabled'|'UpdateStrategy'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig'|'ComputeConfig'|'StorageConfig'|'KubernetesNetworkConfig'|'RemoteNetworkConfig'|'DeletionProtection', 'value': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'errors': [ { 'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound', 'errorMessage': 'string', 'resourceIds': [ 'string', ] }, ] } } **Response Structure** * *(dict) --* * **update** *(dict) --* An object representing an asynchronous update. * **id** *(string) --* A UUID that is used to track the update. * **status** *(string) --* The current status of the update. * **type** *(string) --* The type of the update. * **params** *(list) --* A key-value map that contains the parameters associated with the update. * *(dict) --* An object representing the details of an update request. * **type** *(string) --* The keys associated with an update request. * **value** *(string) --* The value of the keys submitted as part of an update request. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **errors** *(list) --* Any errors associated with a "Failed" update. * *(dict) --* An object representing an error when an asynchronous operation fails. * **errorCode** *(string) --* A brief description of the error. * **SubnetNotFound**: We couldn't find one of the subnets associated with the cluster. * **SecurityGroupNotFound**: We couldn't find one of the security groups associated with the cluster. * **EniLimitReached**: You have reached the elastic network interface limit for your account. * **IpNotAvailable**: A subnet associated with the cluster doesn't have any available IP addresses. * **AccessDenied**: You don't have permissions to perform the specified operation. * **OperationNotPermitted**: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS. * **VpcIdNotFound**: We couldn't find the VPC associated with the cluster. * **errorMessage** *(string) --* A more complete description of the error. * **resourceIds** *(list) --* An optional field that contains the resource IDs associated with the error. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" EKS / Client / can_paginate can_paginate ************ EKS.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. EKS / Client / describe_identity_provider_config describe_identity_provider_config ********************************* EKS.Client.describe_identity_provider_config(**kwargs) Describes an identity provider configuration. See also: AWS API Documentation **Request Syntax** response = client.describe_identity_provider_config( clusterName='string', identityProviderConfig={ 'type': 'string', 'name': 'string' } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **identityProviderConfig** (*dict*) -- **[REQUIRED]** An object representing an identity provider configuration. * **type** *(string) --* **[REQUIRED]** The type of the identity provider configuration. The only type available is "oidc". * **name** *(string) --* **[REQUIRED]** The name of the identity provider configuration. Return type: dict Returns: **Response Syntax** { 'identityProviderConfig': { 'oidc': { 'identityProviderConfigName': 'string', 'identityProviderConfigArn': 'string', 'clusterName': 'string', 'issuerUrl': 'string', 'clientId': 'string', 'usernameClaim': 'string', 'usernamePrefix': 'string', 'groupsClaim': 'string', 'groupsPrefix': 'string', 'requiredClaims': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'status': 'CREATING'|'DELETING'|'ACTIVE' } } } **Response Structure** * *(dict) --* * **identityProviderConfig** *(dict) --* The object that represents an OpenID Connect (OIDC) identity provider configuration. * **oidc** *(dict) --* An object representing an OpenID Connect (OIDC) identity provider configuration. * **identityProviderConfigName** *(string) --* The name of the configuration. * **identityProviderConfigArn** *(string) --* The ARN of the configuration. * **clusterName** *(string) --* The name of your cluster. * **issuerUrl** *(string) --* The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens. * **clientId** *(string) --* This is also known as *audience*. The ID of the client application that makes authentication requests to the OIDC identity provider. * **usernameClaim** *(string) --* The JSON Web token (JWT) claim that is used as the username. * **usernamePrefix** *(string) --* The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain "system:" * **groupsClaim** *(string) --* The JSON web token (JWT) claim that the provider uses to return your groups. * **groupsPrefix** *(string) --* The prefix that is prepended to group claims to prevent clashes with existing names (such as "system:" groups). For example, the value `` oidc:`` creates group names like "oidc:engineering" and "oidc:infra". The prefix can't contain "system:" * **requiredClaims** *(dict) --* The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value. * *(string) --* * *(string) --* * **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). * **status** *(string) --* The status of the OIDC identity provider. **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" EKS / Client / describe_fargate_profile describe_fargate_profile ************************ EKS.Client.describe_fargate_profile(**kwargs) Describes an Fargate profile. See also: AWS API Documentation **Request Syntax** response = client.describe_fargate_profile( clusterName='string', fargateProfileName='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **fargateProfileName** (*string*) -- **[REQUIRED]** The name of the Fargate profile to describe. Return type: dict Returns: **Response Syntax** { 'fargateProfile': { 'fargateProfileName': 'string', 'fargateProfileArn': 'string', 'clusterName': 'string', 'createdAt': datetime(2015, 1, 1), 'podExecutionRoleArn': 'string', 'subnets': [ 'string', ], 'selectors': [ { 'namespace': 'string', 'labels': { 'string': 'string' } }, ], 'status': 'CREATING'|'ACTIVE'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED', 'tags': { 'string': 'string' }, 'health': { 'issues': [ { 'code': 'PodExecutionRoleAlreadyInUse'|'AccessDenied'|'ClusterUnreachable'|'InternalFailure', 'message': 'string', 'resourceIds': [ 'string', ] }, ] } } } **Response Structure** * *(dict) --* * **fargateProfile** *(dict) --* The full description of your Fargate profile. * **fargateProfileName** *(string) --* The name of the Fargate profile. * **fargateProfileArn** *(string) --* The full Amazon Resource Name (ARN) of the Fargate profile. * **clusterName** *(string) --* The name of your cluster. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **podExecutionRoleArn** *(string) --* The Amazon Resource Name (ARN) of the "Pod" execution role to use for any "Pod" that matches the selectors in the Fargate profile. For more information, see Pod execution role in the *Amazon EKS User Guide*. * **subnets** *(list) --* The IDs of subnets to launch a "Pod" into. * *(string) --* * **selectors** *(list) --* The selectors to match for a "Pod" to use this Fargate profile. * *(dict) --* An object representing an Fargate profile selector. * **namespace** *(string) --* The Kubernetes "namespace" that the selector should match. * **labels** *(dict) --* The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match. * *(string) --* * *(string) --* * **status** *(string) --* The current status of the Fargate profile. * **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). * **health** *(dict) --* The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here. * **issues** *(list) --* Any issues that are associated with the Fargate profile. * *(dict) --* An issue that is associated with the Fargate profile. * **code** *(string) --* A brief description of the error. * **message** *(string) --* The error message associated with the issue. * **resourceIds** *(list) --* The Amazon Web Services resources that are affected by this issue. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" EKS / Client / deregister_cluster deregister_cluster ****************** EKS.Client.deregister_cluster(**kwargs) Deregisters a connected cluster to remove it from the Amazon EKS control plane. A connected cluster is a Kubernetes cluster that you've connected to your control plane using the Amazon EKS Connector. See also: AWS API Documentation **Request Syntax** response = client.deregister_cluster( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name of the connected cluster to deregister. 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', 'elasticLoadBalancing': { 'enabled': True|False } }, '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' }, 'upgradePolicy': { 'supportType': 'STANDARD'|'EXTENDED' }, 'zonalShiftConfig': { 'enabled': True|False }, 'remoteNetworkConfig': { 'remoteNodeNetworks': [ { 'cidrs': [ 'string', ] }, ], 'remotePodNetworks': [ { 'cidrs': [ 'string', ] }, ] }, 'computeConfig': { 'enabled': True|False, 'nodePools': [ 'string', ], 'nodeRoleArn': 'string' }, 'storageConfig': { 'blockStorage': { 'enabled': True|False } }, 'deletionProtection': True|False } } **Response Structure** * *(dict) --* * **cluster** *(dict) --* An object representing an Amazon EKS 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 Cluster API server endpoint 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" and additionally "::/0" for dual- stack *IPv6* clusters. 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 Cluster API server endpoint in the *Amazon EKS User Guide* . Note that the public endpoints are dual-stack for only "IPv6" clusters that are made after October 2024. You can't add "IPv6" CIDR blocks to "IPv4" clusters or "IPv6" clusters that were made before October 2024. * *(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. * **elasticLoadBalancing** *(dict) --* Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. * **enabled** *(boolean) --* Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account. * **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 Amazon EKS cluster. * **issues** *(list) --* An object representing the health issues of your Amazon EKS cluster. * *(dict) --* An issue with your Amazon EKS cluster. * **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. * **upgradePolicy** *(dict) --* This value indicates if extended support is enabled or disabled for the cluster. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **supportType** *(string) --* If the cluster is set to "EXTENDED", it will enter extended support at the end of standard support. If the cluster is set to "STANDARD", it will be automatically upgraded at the end of standard support. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **zonalShiftConfig** *(dict) --* The configuration for zonal shift for the cluster. * **enabled** *(boolean) --* Whether the zonal shift is enabled. * **remoteNetworkConfig** *(dict) --* The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. * **remoteNodeNetworks** *(list) --* The list of network CIDRs that can contain hybrid nodes. * *(dict) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * **cidrs** *(list) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * *(string) --* * **remotePodNetworks** *(list) --* The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes. * *(dict) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on- premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * **cidrs** *(list) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * *(string) --* * **computeConfig** *(dict) --* Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the *Amazon EKS User Guide*. * **enabled** *(boolean) --* Indicates if the compute capability is enabled on 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. * **nodePools** *(list) --* Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the *Amazon EKS User Guide*. * *(string) --* * **nodeRoleArn** *(string) --* The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. * **storageConfig** *(dict) --* Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the *Amazon EKS User Guide*. * **blockStorage** *(dict) --* Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. * **enabled** *(boolean) --* Indicates if the block storage capability is enabled on 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. * **deletionProtection** *(boolean) --* The current deletion protection setting for the cluster. When "true", deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When "false", the cluster can be deleted normally. This setting only applies to clusters in an active state. **Exceptions** * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" * "EKS.Client.exceptions.AccessDeniedException" EKS / Client / describe_cluster_versions describe_cluster_versions ************************* EKS.Client.describe_cluster_versions(**kwargs) Lists available Kubernetes versions for Amazon EKS clusters. See also: AWS API Documentation **Request Syntax** response = client.describe_cluster_versions( clusterType='string', maxResults=123, nextToken='string', defaultOnly=True|False, includeAll=True|False, clusterVersions=[ 'string', ], status='unsupported'|'standard-support'|'extended-support', versionStatus='UNSUPPORTED'|'STANDARD_SUPPORT'|'EXTENDED_SUPPORT' ) Parameters: * **clusterType** (*string*) -- The type of cluster to filter versions by. * **maxResults** (*integer*) -- Maximum number of results to return. * **nextToken** (*string*) -- Pagination token for the next set of results. * **defaultOnly** (*boolean*) -- Filter to show only default versions. * **includeAll** (*boolean*) -- Include all available versions in the response. * **clusterVersions** (*list*) -- List of specific cluster versions to describe. * *(string) --* * **status** (*string*) -- Warning: This field is deprecated. Use "versionStatus" instead, as that field matches for input and output of this action. Filter versions by their current status. * **versionStatus** (*string*) -- Filter versions by their current status. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'clusterVersions': [ { 'clusterVersion': 'string', 'clusterType': 'string', 'defaultPlatformVersion': 'string', 'defaultVersion': True|False, 'releaseDate': datetime(2015, 1, 1), 'endOfStandardSupportDate': datetime(2015, 1, 1), 'endOfExtendedSupportDate': datetime(2015, 1, 1), 'status': 'unsupported'|'standard-support'|'extended-support', 'versionStatus': 'UNSUPPORTED'|'STANDARD_SUPPORT'|'EXTENDED_SUPPORT', 'kubernetesPatchVersion': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* Pagination token for the next set of results. * **clusterVersions** *(list) --* List of cluster version information objects. * *(dict) --* Contains details about a specific EKS cluster version. * **clusterVersion** *(string) --* The Kubernetes version for the cluster. * **clusterType** *(string) --* The type of cluster this version is for. * **defaultPlatformVersion** *(string) --* Default platform version for this Kubernetes version. * **defaultVersion** *(boolean) --* Indicates if this is a default version. * **releaseDate** *(datetime) --* The release date of this cluster version. * **endOfStandardSupportDate** *(datetime) --* Date when standard support ends for this version. * **endOfExtendedSupportDate** *(datetime) --* Date when extended support ends for this version. * **status** *(string) --* Warning: This field is deprecated. Use "versionStatus" instead, as that field matches for input and output of this action. Current status of this cluster version. * **versionStatus** *(string) --* Current status of this cluster version. * **kubernetesPatchVersion** *(string) --* The patch version of Kubernetes for this cluster version. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.InvalidRequestException" EKS / Client / describe_addon_configuration describe_addon_configuration **************************** EKS.Client.describe_addon_configuration(**kwargs) Returns configuration options. See also: AWS API Documentation **Request Syntax** response = client.describe_addon_configuration( addonName='string', addonVersion='string' ) Parameters: * **addonName** (*string*) -- **[REQUIRED]** The name of the add-on. The name must match one of the names returned by "DescribeAddonVersions". * **addonVersion** (*string*) -- **[REQUIRED]** The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions. Return type: dict Returns: **Response Syntax** { 'addonName': 'string', 'addonVersion': 'string', 'configurationSchema': 'string', 'podIdentityConfiguration': [ { 'serviceAccount': 'string', 'recommendedManagedPolicies': [ 'string', ] }, ] } **Response Structure** * *(dict) --* * **addonName** *(string) --* The name of the add-on. * **addonVersion** *(string) --* The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions. * **configurationSchema** *(string) --* A JSON schema that's used to validate the configuration values you provide when an add-on is created or updated. * **podIdentityConfiguration** *(list) --* The Kubernetes service account name used by the add-on, and any suggested IAM policies. Use this information to create an IAM Role for the add-on. * *(dict) --* Information about how to configure IAM for an add-on. * **serviceAccount** *(string) --* The Kubernetes Service Account name used by the add-on. * **recommendedManagedPolicies** *(list) --* A suggested IAM Policy for the add-on. * *(string) --* **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidParameterException" EKS / Client / associate_encryption_config associate_encryption_config *************************** EKS.Client.associate_encryption_config(**kwargs) Associates an encryption configuration to an existing cluster. Use this API to enable encryption on existing clusters that don't already have encryption enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters. See also: AWS API Documentation **Request Syntax** response = client.associate_encryption_config( clusterName='string', encryptionConfig=[ { 'resources': [ 'string', ], 'provider': { 'keyArn': 'string' } }, ], clientRequestToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **encryptionConfig** (*list*) -- **[REQUIRED]** The configuration you are using for encryption. * *(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*. * **clientRequestToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'update': { 'id': 'string', 'status': 'InProgress'|'Failed'|'Cancelled'|'Successful', 'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate'|'AccessConfigUpdate'|'UpgradePolicyUpdate'|'ZonalShiftConfigUpdate'|'AutoModeUpdate'|'RemoteNetworkConfigUpdate'|'DeletionProtectionUpdate', 'params': [ { 'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'TaintsToAdd'|'TaintsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'LaunchTemplateName'|'LaunchTemplateVersion'|'IdentityProviderConfig'|'EncryptionConfig'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts'|'MaxUnavailable'|'MaxUnavailablePercentage'|'NodeRepairEnabled'|'UpdateStrategy'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig'|'ComputeConfig'|'StorageConfig'|'KubernetesNetworkConfig'|'RemoteNetworkConfig'|'DeletionProtection', 'value': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'errors': [ { 'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound', 'errorMessage': 'string', 'resourceIds': [ 'string', ] }, ] } } **Response Structure** * *(dict) --* * **update** *(dict) --* An object representing an asynchronous update. * **id** *(string) --* A UUID that is used to track the update. * **status** *(string) --* The current status of the update. * **type** *(string) --* The type of the update. * **params** *(list) --* A key-value map that contains the parameters associated with the update. * *(dict) --* An object representing the details of an update request. * **type** *(string) --* The keys associated with an update request. * **value** *(string) --* The value of the keys submitted as part of an update request. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **errors** *(list) --* Any errors associated with a "Failed" update. * *(dict) --* An object representing an error when an asynchronous operation fails. * **errorCode** *(string) --* A brief description of the error. * **SubnetNotFound**: We couldn't find one of the subnets associated with the cluster. * **SecurityGroupNotFound**: We couldn't find one of the security groups associated with the cluster. * **EniLimitReached**: You have reached the elastic network interface limit for your account. * **IpNotAvailable**: A subnet associated with the cluster doesn't have any available IP addresses. * **AccessDenied**: You don't have permissions to perform the specified operation. * **OperationNotPermitted**: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS. * **VpcIdNotFound**: We couldn't find the VPC associated with the cluster. * **errorMessage** *(string) --* A more complete description of the error. * **resourceIds** *(list) --* An optional field that contains the resource IDs associated with the error. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ThrottlingException" EKS / Client / delete_eks_anywhere_subscription delete_eks_anywhere_subscription ******************************** EKS.Client.delete_eks_anywhere_subscription(**kwargs) Deletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation and are cancelled by creating a ticket in the Amazon Web Services Support Center. See also: AWS API Documentation **Request Syntax** response = client.delete_eks_anywhere_subscription( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the subscription. Return type: dict Returns: **Response Syntax** { 'subscription': { 'id': 'string', 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'effectiveDate': datetime(2015, 1, 1), 'expirationDate': datetime(2015, 1, 1), 'licenseQuantity': 123, 'licenseType': 'Cluster', 'term': { 'duration': 123, 'unit': 'MONTHS' }, 'status': 'string', 'autoRenew': True|False, 'licenseArns': [ 'string', ], 'licenses': [ { 'id': 'string', 'token': 'string' }, ], 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **subscription** *(dict) --* The full description of the subscription to be deleted. * **id** *(string) --* UUID identifying a subscription. * **arn** *(string) --* The Amazon Resource Name (ARN) for the subscription. * **createdAt** *(datetime) --* The Unix timestamp in seconds for when the subscription was created. * **effectiveDate** *(datetime) --* The Unix timestamp in seconds for when the subscription is effective. * **expirationDate** *(datetime) --* The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object. * **licenseQuantity** *(integer) --* The number of licenses included in a subscription. Valid values are between 1 and 100. * **licenseType** *(string) --* The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster. * **term** *(dict) --* An EksAnywhereSubscriptionTerm object. * **duration** *(integer) --* The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription. * **unit** *(string) --* The term unit of the subscription. Valid value is "MONTHS". * **status** *(string) --* The status of a subscription. * **autoRenew** *(boolean) --* A boolean indicating whether or not a subscription will auto renew when it expires. * **licenseArns** *(list) --* Amazon Web Services License Manager ARN associated with the subscription. * *(string) --* * **licenses** *(list) --* Includes all of the claims in the license token necessary to validate the license for extended support. * *(dict) --* An EKS Anywhere license associated with a subscription. * **id** *(string) --* An id associated with an EKS Anywhere subscription license. * **token** *(string) --* An optional license token that can be used for extended support verification. * **tags** *(dict) --* The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription. * *(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). **Exceptions** * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ServerException" EKS / Client / describe_eks_anywhere_subscription describe_eks_anywhere_subscription ********************************** EKS.Client.describe_eks_anywhere_subscription(**kwargs) Returns descriptive information about a subscription. See also: AWS API Documentation **Request Syntax** response = client.describe_eks_anywhere_subscription( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the subscription. Return type: dict Returns: **Response Syntax** { 'subscription': { 'id': 'string', 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'effectiveDate': datetime(2015, 1, 1), 'expirationDate': datetime(2015, 1, 1), 'licenseQuantity': 123, 'licenseType': 'Cluster', 'term': { 'duration': 123, 'unit': 'MONTHS' }, 'status': 'string', 'autoRenew': True|False, 'licenseArns': [ 'string', ], 'licenses': [ { 'id': 'string', 'token': 'string' }, ], 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **subscription** *(dict) --* The full description of the subscription. * **id** *(string) --* UUID identifying a subscription. * **arn** *(string) --* The Amazon Resource Name (ARN) for the subscription. * **createdAt** *(datetime) --* The Unix timestamp in seconds for when the subscription was created. * **effectiveDate** *(datetime) --* The Unix timestamp in seconds for when the subscription is effective. * **expirationDate** *(datetime) --* The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object. * **licenseQuantity** *(integer) --* The number of licenses included in a subscription. Valid values are between 1 and 100. * **licenseType** *(string) --* The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster. * **term** *(dict) --* An EksAnywhereSubscriptionTerm object. * **duration** *(integer) --* The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription. * **unit** *(string) --* The term unit of the subscription. Valid value is "MONTHS". * **status** *(string) --* The status of a subscription. * **autoRenew** *(boolean) --* A boolean indicating whether or not a subscription will auto renew when it expires. * **licenseArns** *(list) --* Amazon Web Services License Manager ARN associated with the subscription. * *(string) --* * **licenses** *(list) --* Includes all of the claims in the license token necessary to validate the license for extended support. * *(dict) --* An EKS Anywhere license associated with a subscription. * **id** *(string) --* An id associated with an EKS Anywhere subscription license. * **token** *(string) --* An optional license token that can be used for extended support verification. * **tags** *(dict) --* The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription. * *(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). **Exceptions** * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" EKS / Client / list_tags_for_resource list_tags_for_resource ********************** EKS.Client.list_tags_for_resource(**kwargs) List the tags for an Amazon EKS resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that identifies the resource to list tags for. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* The tags for the resource. * *(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). **Exceptions** * "EKS.Client.exceptions.BadRequestException" * "EKS.Client.exceptions.NotFoundException" **Examples** This example lists all of the tags for the *beta* cluster. response = client.list_tags_for_resource( resourceArn='arn:aws:eks:us-west-2:012345678910:cluster/beta', ) print(response) Expected Output: { 'tags': { 'aws:tag:domain': 'beta', }, 'ResponseMetadata': { '...': '...', }, } EKS / Client / associate_identity_provider_config associate_identity_provider_config ********************************** EKS.Client.associate_identity_provider_config(**kwargs) Associates an identity provider configuration to a cluster. If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes "Role" and "ClusterRole" objects, assign permissions to them, and then bind them to the identities using Kubernetes "RoleBinding" and "ClusterRoleBinding" objects. For more information see Using RBAC Authorization in the Kubernetes documentation. See also: AWS API Documentation **Request Syntax** response = client.associate_identity_provider_config( clusterName='string', oidc={ 'identityProviderConfigName': 'string', 'issuerUrl': 'string', 'clientId': 'string', 'usernameClaim': 'string', 'usernamePrefix': 'string', 'groupsClaim': 'string', 'groupsPrefix': 'string', 'requiredClaims': { 'string': 'string' } }, tags={ 'string': 'string' }, clientRequestToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **oidc** (*dict*) -- **[REQUIRED]** An object representing an OpenID Connect (OIDC) identity provider configuration. * **identityProviderConfigName** *(string) --* **[REQUIRED]** The name of the OIDC provider configuration. * **issuerUrl** *(string) --* **[REQUIRED]** The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens. The URL must begin with "https://" and should correspond to the "iss" claim in the provider's OIDC ID tokens. Based on the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like "https://server.example.org" or "https://example.com". This URL should point to the level below ".well-known/openid-configuration" and must be publicly accessible over the internet. * **clientId** *(string) --* **[REQUIRED]** This is also known as *audience*. The ID for the client application that makes authentication requests to the OIDC identity provider. * **usernameClaim** *(string) --* The JSON Web Token (JWT) claim to use as the username. The default is "sub", which is expected to be a unique identifier of the end user. You can choose other claims, such as "email" or "name", depending on the OIDC identity provider. Claims other than "email" are prefixed with the issuer URL to prevent naming clashes with other plug-ins. * **usernamePrefix** *(string) --* The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and "username" is a value other than "email", the prefix defaults to "issuerurl#". You can use the value "-" to disable all prefixing. * **groupsClaim** *(string) --* The JWT claim that the provider uses to return your groups. * **groupsPrefix** *(string) --* The prefix that is prepended to group claims to prevent clashes with existing names (such as "system:" groups). For example, the value `` oidc:`` will create group names like "oidc:engineering" and "oidc:infra". * **requiredClaims** *(dict) --* The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value. For the maximum number of claims that you can require, see Amazon EKS service quotas in the *Amazon EKS User Guide*. * *(string) --* * *(string) --* * **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). * **clientRequestToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'update': { 'id': 'string', 'status': 'InProgress'|'Failed'|'Cancelled'|'Successful', 'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate'|'AccessConfigUpdate'|'UpgradePolicyUpdate'|'ZonalShiftConfigUpdate'|'AutoModeUpdate'|'RemoteNetworkConfigUpdate'|'DeletionProtectionUpdate', 'params': [ { 'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'TaintsToAdd'|'TaintsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'LaunchTemplateName'|'LaunchTemplateVersion'|'IdentityProviderConfig'|'EncryptionConfig'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts'|'MaxUnavailable'|'MaxUnavailablePercentage'|'NodeRepairEnabled'|'UpdateStrategy'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig'|'ComputeConfig'|'StorageConfig'|'KubernetesNetworkConfig'|'RemoteNetworkConfig'|'DeletionProtection', 'value': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'errors': [ { 'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound', 'errorMessage': 'string', 'resourceIds': [ 'string', ] }, ] }, 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **update** *(dict) --* An object representing an asynchronous update. * **id** *(string) --* A UUID that is used to track the update. * **status** *(string) --* The current status of the update. * **type** *(string) --* The type of the update. * **params** *(list) --* A key-value map that contains the parameters associated with the update. * *(dict) --* An object representing the details of an update request. * **type** *(string) --* The keys associated with an update request. * **value** *(string) --* The value of the keys submitted as part of an update request. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **errors** *(list) --* Any errors associated with a "Failed" update. * *(dict) --* An object representing an error when an asynchronous operation fails. * **errorCode** *(string) --* A brief description of the error. * **SubnetNotFound**: We couldn't find one of the subnets associated with the cluster. * **SecurityGroupNotFound**: We couldn't find one of the security groups associated with the cluster. * **EniLimitReached**: You have reached the elastic network interface limit for your account. * **IpNotAvailable**: A subnet associated with the cluster doesn't have any available IP addresses. * **AccessDenied**: You don't have permissions to perform the specified operation. * **OperationNotPermitted**: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS. * **VpcIdNotFound**: We couldn't find the VPC associated with the cluster. * **errorMessage** *(string) --* A more complete description of the error. * **resourceIds** *(list) --* An optional field that contains the resource IDs associated with the error. * *(string) --* * **tags** *(dict) --* The tags for the resource. * *(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). **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ThrottlingException" EKS / Client / delete_access_entry delete_access_entry ******************* EKS.Client.delete_access_entry(**kwargs) Deletes an access entry. Deleting an access entry of a type other than "Standard" can cause your cluster to function improperly. If you delete an access entry in error, you can recreate it. See also: AWS API Documentation **Request Syntax** response = client.delete_access_entry( clusterName='string', principalArn='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **principalArn** (*string*) -- **[REQUIRED]** The ARN of the IAM principal for the "AccessEntry". Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" EKS / Client / untag_resource untag_resource ************** EKS.Client.untag_resource(**kwargs) Deletes specified tags from an Amazon EKS resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to delete tags from. * **tagKeys** (*list*) -- **[REQUIRED]** The keys of the tags to remove. * *(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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "EKS.Client.exceptions.BadRequestException" * "EKS.Client.exceptions.NotFoundException" EKS / Client / describe_addon describe_addon ************** EKS.Client.describe_addon(**kwargs) Describes an Amazon EKS add-on. See also: AWS API Documentation **Request Syntax** response = client.describe_addon( clusterName='string', addonName='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **addonName** (*string*) -- **[REQUIRED]** The name of the add-on. The name must match one of the names returned by ListAddons. Return type: dict Returns: **Response Syntax** { 'addon': { 'addonName': 'string', 'clusterName': 'string', 'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETE_FAILED'|'DEGRADED'|'UPDATE_FAILED', 'addonVersion': 'string', 'health': { 'issues': [ { 'code': 'AccessDenied'|'InternalFailure'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound'|'AddonSubscriptionNeeded'|'AddonPermissionFailure', 'message': 'string', 'resourceIds': [ 'string', ] }, ] }, 'addonArn': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'serviceAccountRoleArn': 'string', 'tags': { 'string': 'string' }, 'publisher': 'string', 'owner': 'string', 'marketplaceInformation': { 'productId': 'string', 'productUrl': 'string' }, 'configurationValues': 'string', 'podIdentityAssociations': [ 'string', ] } } **Response Structure** * *(dict) --* * **addon** *(dict) --* An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the *Amazon EKS User Guide*. * **addonName** *(string) --* The name of the add-on. * **clusterName** *(string) --* The name of your cluster. * **status** *(string) --* The status of the add-on. * **addonVersion** *(string) --* The version of the add-on. * **health** *(dict) --* An object that represents the health of the add-on. * **issues** *(list) --* An object representing the health issues for an add-on. * *(dict) --* An issue related to an add-on. * **code** *(string) --* A code that describes the type of issue. * **message** *(string) --* A message that provides details about the issue and what might cause it. * **resourceIds** *(list) --* The resource IDs of the issue. * *(string) --* * **addonArn** *(string) --* The Amazon Resource Name (ARN) of the add-on. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. * **serviceAccountRoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that's bound to the Kubernetes "ServiceAccount" object that the add-on uses. * **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). * **publisher** *(string) --* The publisher of the add-on. * **owner** *(string) --* The owner of the add-on. * **marketplaceInformation** *(dict) --* Information about an Amazon EKS add-on from the Amazon Web Services Marketplace. * **productId** *(string) --* The product ID from the Amazon Web Services Marketplace. * **productUrl** *(string) --* The product URL from the Amazon Web Services Marketplace. * **configurationValues** *(string) --* The configuration values that you provided. * **podIdentityAssociations** *(list) --* An array of EKS Pod Identity associations owned by the add-on. Each association maps a role to a service account in a namespace in the cluster. For more information, see Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity in the *Amazon EKS User Guide*. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" EKS / Client / list_pod_identity_associations list_pod_identity_associations ****************************** EKS.Client.list_pod_identity_associations(**kwargs) List the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the association uses. See also: AWS API Documentation **Request Syntax** response = client.list_pod_identity_associations( clusterName='string', namespace='string', serviceAccount='string', maxResults=123, nextToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of the cluster that the associations are in. * **namespace** (*string*) -- The name of the Kubernetes namespace inside the cluster that the associations are in. * **serviceAccount** (*string*) -- The name of the Kubernetes service account that the associations use. * **maxResults** (*integer*) -- The maximum number of EKS Pod Identity association results returned by "ListPodIdentityAssociations" in paginated output. When you use this parameter, "ListPodIdentityAssociations" returns only "maxResults" results in a single page along with a "nextToken" response element. You can see the remaining results of the initial request by sending another "ListPodIdentityAssociations" request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, "ListPodIdentityAssociations" returns up to 100 results and a "nextToken" value if applicable. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated "ListUpdates" request where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. Return type: dict Returns: **Response Syntax** { 'associations': [ { 'clusterName': 'string', 'namespace': 'string', 'serviceAccount': 'string', 'associationArn': 'string', 'associationId': 'string', 'ownerArn': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **associations** *(list) --* The list of summarized descriptions of the associations that are in the cluster and match any filters that you provided. Each summary is simplified by removing these fields compared to the full PodIdentityAssociation: * The IAM role: "roleArn" * The timestamp that the association was created at: "createdAt" * The most recent timestamp that the association was modified at:. "modifiedAt" * The tags on the association: "tags" * *(dict) --* The summarized description of the association. Each summary is simplified by removing these fields compared to the full PodIdentityAssociation: * The IAM role: "roleArn" * The timestamp that the association was created at: "createdAt" * The most recent timestamp that the association was modified at:. "modifiedAt" * The tags on the association: "tags" * **clusterName** *(string) --* The name of the cluster that the association is in. * **namespace** *(string) --* The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the Pods that use the service account must be in this namespace. * **serviceAccount** *(string) --* The name of the Kubernetes service account inside the cluster to associate the IAM credentials with. * **associationArn** *(string) --* The Amazon Resource Name (ARN) of the association. * **associationId** *(string) --* The ID of the association. * **ownerArn** *(string) --* If defined, the association is owned by an Amazon EKS add-on. * **nextToken** *(string) --* The "nextToken" value to include in a future "ListPodIdentityAssociations" request. When the results of a "ListPodIdentityAssociations" request exceed "maxResults", you can use this value to retrieve the next page of results. This value is "null" when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" EKS / Client / get_waiter get_waiter ********** EKS.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" EKS / Client / update_eks_anywhere_subscription update_eks_anywhere_subscription ******************************** EKS.Client.update_eks_anywhere_subscription(**kwargs) Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation. See also: AWS API Documentation **Request Syntax** response = client.update_eks_anywhere_subscription( id='string', autoRenew=True|False, clientRequestToken='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the subscription. * **autoRenew** (*boolean*) -- **[REQUIRED]** A boolean indicating whether or not to automatically renew the subscription. * **clientRequestToken** (*string*) -- Unique, case-sensitive identifier to ensure the idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'subscription': { 'id': 'string', 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'effectiveDate': datetime(2015, 1, 1), 'expirationDate': datetime(2015, 1, 1), 'licenseQuantity': 123, 'licenseType': 'Cluster', 'term': { 'duration': 123, 'unit': 'MONTHS' }, 'status': 'string', 'autoRenew': True|False, 'licenseArns': [ 'string', ], 'licenses': [ { 'id': 'string', 'token': 'string' }, ], 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **subscription** *(dict) --* The full description of the updated subscription. * **id** *(string) --* UUID identifying a subscription. * **arn** *(string) --* The Amazon Resource Name (ARN) for the subscription. * **createdAt** *(datetime) --* The Unix timestamp in seconds for when the subscription was created. * **effectiveDate** *(datetime) --* The Unix timestamp in seconds for when the subscription is effective. * **expirationDate** *(datetime) --* The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object. * **licenseQuantity** *(integer) --* The number of licenses included in a subscription. Valid values are between 1 and 100. * **licenseType** *(string) --* The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster. * **term** *(dict) --* An EksAnywhereSubscriptionTerm object. * **duration** *(integer) --* The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription. * **unit** *(string) --* The term unit of the subscription. Valid value is "MONTHS". * **status** *(string) --* The status of a subscription. * **autoRenew** *(boolean) --* A boolean indicating whether or not a subscription will auto renew when it expires. * **licenseArns** *(list) --* Amazon Web Services License Manager ARN associated with the subscription. * *(string) --* * **licenses** *(list) --* Includes all of the claims in the license token necessary to validate the license for extended support. * *(dict) --* An EKS Anywhere license associated with a subscription. * **id** *(string) --* An id associated with an EKS Anywhere subscription license. * **token** *(string) --* An optional license token that can be used for extended support verification. * **tags** *(dict) --* The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription. * *(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). **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" EKS / Client / list_addons list_addons *********** EKS.Client.list_addons(**kwargs) Lists the installed add-ons. See also: AWS API Documentation **Request Syntax** response = client.list_addons( clusterName='string', maxResults=123, nextToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **maxResults** (*integer*) -- The maximum number of results, returned in paginated output. You receive "maxResults" in a single page, along with a "nextToken" response element. You can see the remaining results of the initial request by sending another request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a "nextToken" value, if applicable, are returned. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. Return type: dict Returns: **Response Syntax** { 'addons': [ 'string', ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **addons** *(list) --* A list of installed add-ons. * *(string) --* * **nextToken** *(string) --* The "nextToken" value to include in a future "ListAddons" request. When the results of a "ListAddons" request exceed "maxResults", you can use this value to retrieve the next page of results. This value is "null" when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ServerException" EKS / Client / describe_pod_identity_association describe_pod_identity_association ********************************* EKS.Client.describe_pod_identity_association(**kwargs) Returns descriptive information about an EKS Pod Identity association. This action requires the ID of the association. You can get the ID from the response to the "CreatePodIdentityAssocation" for newly created associations. Or, you can list the IDs for associations with "ListPodIdentityAssociations" and filter the list by namespace or service account. See also: AWS API Documentation **Request Syntax** response = client.describe_pod_identity_association( clusterName='string', associationId='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of the cluster that the association is in. * **associationId** (*string*) -- **[REQUIRED]** The ID of the association that you want the description of. Return type: dict Returns: **Response Syntax** { 'association': { 'clusterName': 'string', 'namespace': 'string', 'serviceAccount': 'string', 'roleArn': 'string', 'associationArn': 'string', 'associationId': 'string', 'tags': { 'string': 'string' }, 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'ownerArn': 'string', 'disableSessionTags': True|False, 'targetRoleArn': 'string', 'externalId': 'string' } } **Response Structure** * *(dict) --* * **association** *(dict) --* The full description of the EKS Pod Identity association. * **clusterName** *(string) --* The name of the cluster that the association is in. * **namespace** *(string) --* The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the Pods that use the service account must be in this namespace. * **serviceAccount** *(string) --* The name of the Kubernetes service account inside the cluster to associate the IAM credentials with. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the Pods that use this service account. * **associationArn** *(string) --* The Amazon Resource Name (ARN) of the association. * **associationId** *(string) --* The ID of the association. * **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. The following basic restrictions apply to tags: * Maximum number of tags per resource – 50 * For each resource, each tag key must be unique, and each tag key can have only one value. * Maximum key length – 128 Unicode characters in UTF-8 * Maximum value length – 256 Unicode characters in UTF-8 * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. * Tag keys and values are case-sensitive. * Do not use "aws:", "AWS:", or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. * *(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). * **createdAt** *(datetime) --* The timestamp that the association was created at. * **modifiedAt** *(datetime) --* The most recent timestamp that the association was modified at. * **ownerArn** *(string) --* If defined, the EKS Pod Identity association is owned by an Amazon EKS add-on. * **disableSessionTags** *(boolean) --* The state of the automatic sessions tags. The value of *true* disables these tags. EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to Amazon Web Services resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see List of session tags added by EKS Pod Identity in the *Amazon EKS User Guide*. * **targetRoleArn** *(string) --* The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod. * **externalId** *(string) --* The unique identifier for this EKS Pod Identity association for a target IAM role. You put this value in the trust policy of the target role, in a "Condition" to match the "sts.ExternalId". This ensures that the target role can only be assumed by this association. This prevents the *confused deputy problem*. For more information about the confused deputy problem, see The confused deputy problem in the *IAM User Guide*. If you want to use the same target role with multiple associations or other roles, use independent statements in the trust policy to allow "sts:AssumeRole" access from each role. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" EKS / Client / delete_nodegroup delete_nodegroup **************** EKS.Client.delete_nodegroup(**kwargs) Deletes a managed node group. See also: AWS API Documentation **Request Syntax** response = client.delete_nodegroup( clusterName='string', nodegroupName='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **nodegroupName** (*string*) -- **[REQUIRED]** The name of the node group to delete. Return type: dict Returns: **Response Syntax** { 'nodegroup': { 'nodegroupName': 'string', 'nodegroupArn': 'string', 'clusterName': 'string', 'version': 'string', 'releaseVersion': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'|'DEGRADED', 'capacityType': 'ON_DEMAND'|'SPOT'|'CAPACITY_BLOCK', 'scalingConfig': { 'minSize': 123, 'maxSize': 123, 'desiredSize': 123 }, 'instanceTypes': [ 'string', ], 'subnets': [ 'string', ], 'remoteAccess': { 'ec2SshKey': 'string', 'sourceSecurityGroups': [ 'string', ] }, 'amiType': 'AL2_x86_64'|'AL2_x86_64_GPU'|'AL2_ARM_64'|'CUSTOM'|'BOTTLEROCKET_ARM_64'|'BOTTLEROCKET_x86_64'|'BOTTLEROCKET_ARM_64_FIPS'|'BOTTLEROCKET_x86_64_FIPS'|'BOTTLEROCKET_ARM_64_NVIDIA'|'BOTTLEROCKET_x86_64_NVIDIA'|'WINDOWS_CORE_2019_x86_64'|'WINDOWS_FULL_2019_x86_64'|'WINDOWS_CORE_2022_x86_64'|'WINDOWS_FULL_2022_x86_64'|'AL2023_x86_64_STANDARD'|'AL2023_ARM_64_STANDARD'|'AL2023_x86_64_NEURON'|'AL2023_x86_64_NVIDIA'|'AL2023_ARM_64_NVIDIA', 'nodeRole': 'string', 'labels': { 'string': 'string' }, 'taints': [ { 'key': 'string', 'value': 'string', 'effect': 'NO_SCHEDULE'|'NO_EXECUTE'|'PREFER_NO_SCHEDULE' }, ], 'resources': { 'autoScalingGroups': [ { 'name': 'string' }, ], 'remoteAccessSecurityGroup': 'string' }, 'diskSize': 123, 'health': { 'issues': [ { 'code': 'AutoScalingGroupNotFound'|'AutoScalingGroupInvalidConfiguration'|'Ec2SecurityGroupNotFound'|'Ec2SecurityGroupDeletionFailure'|'Ec2LaunchTemplateNotFound'|'Ec2LaunchTemplateVersionMismatch'|'Ec2SubnetNotFound'|'Ec2SubnetInvalidConfiguration'|'IamInstanceProfileNotFound'|'Ec2SubnetMissingIpv6Assignment'|'IamLimitExceeded'|'IamNodeRoleNotFound'|'NodeCreationFailure'|'AsgInstanceLaunchFailures'|'InstanceLimitExceeded'|'InsufficientFreeAddresses'|'AccessDenied'|'InternalFailure'|'ClusterUnreachable'|'AmiIdNotFound'|'AutoScalingGroupOptInRequired'|'AutoScalingGroupRateLimitExceeded'|'Ec2LaunchTemplateDeletionFailure'|'Ec2LaunchTemplateInvalidConfiguration'|'Ec2LaunchTemplateMaxLimitExceeded'|'Ec2SubnetListTooLong'|'IamThrottling'|'NodeTerminationFailure'|'PodEvictionFailure'|'SourceEc2LaunchTemplateNotFound'|'LimitExceeded'|'Unknown'|'AutoScalingGroupInstanceRefreshActive'|'KubernetesLabelInvalid'|'Ec2LaunchTemplateVersionMaxLimitExceeded'|'Ec2InstanceTypeDoesNotExist', 'message': 'string', 'resourceIds': [ 'string', ] }, ] }, 'updateConfig': { 'maxUnavailable': 123, 'maxUnavailablePercentage': 123, 'updateStrategy': 'DEFAULT'|'MINIMAL' }, 'nodeRepairConfig': { 'enabled': True|False }, 'launchTemplate': { 'name': 'string', 'version': 'string', 'id': 'string' }, 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **nodegroup** *(dict) --* The full description of your deleted node group. * **nodegroupName** *(string) --* The name associated with an Amazon EKS managed node group. * **nodegroupArn** *(string) --* The Amazon Resource Name (ARN) associated with the managed node group. * **clusterName** *(string) --* The name of your cluster. * **version** *(string) --* The Kubernetes version of the managed node group. * **releaseVersion** *(string) --* If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. * **status** *(string) --* The current status of the managed node group. * **capacityType** *(string) --* The capacity type of your managed node group. * **scalingConfig** *(dict) --* The scaling configuration details for the Auto Scaling group that is associated with your node group. * **minSize** *(integer) --* The minimum number of nodes that the managed node group can scale in to. * **maxSize** *(integer) --* The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the *Amazon EKS User Guide*. * **desiredSize** *(integer) --* The current number of nodes that the managed node group should maintain. Warning: If you use the Kubernetes Cluster Autoscaler, you shouldn't change the "desiredSize" value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down. Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template. This parameter can be different from "minSize" in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the "desiredSize" parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than "minSize" or higher than "maxSize". * **instanceTypes** *(list) --* If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is "null". * *(string) --* * **subnets** *(list) --* The subnets that were specified for the Auto Scaling group that is associated with your node group. * *(string) --* * **remoteAccess** *(dict) --* If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is "null". * **ec2SshKey** *(string) --* The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. For Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more information, see Amazon EC2 key pairs and Windows instances in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*. * **sourceSecurityGroups** *(list) --* The security group IDs that are allowed SSH access (port 22) to the nodes. For Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet ( "0.0.0.0/0"). For more information, see Security Groups for Your VPC in the *Amazon Virtual Private Cloud User Guide*. * *(string) --* * **amiType** *(string) --* If the node group was deployed using a launch template with a custom AMI, then this is "CUSTOM". For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration. * **nodeRole** *(string) --* The IAM role associated with your node group. The Amazon EKS node "kubelet" daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. * **labels** *(dict) --* The Kubernetes "labels" applied to the nodes in the node group. Note: Only "labels" that are applied with the Amazon EKS API are shown here. There may be other Kubernetes "labels" applied to the nodes in this group. * *(string) --* * *(string) --* * **taints** *(list) --* The Kubernetes taints to be applied to the nodes in the node group when they are created. Effect is one of "No_Schedule", "Prefer_No_Schedule", or "No_Execute". Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. For more information, see Node taints on managed node groups. * *(dict) --* A property that allows a node to repel a "Pod". For more information, see Node taints on managed node groups in the *Amazon EKS User Guide*. * **key** *(string) --* The key of the taint. * **value** *(string) --* The value of the taint. * **effect** *(string) --* The effect of the taint. * **resources** *(dict) --* The resources associated with the node group, such as Auto Scaling groups and security groups for remote access. * **autoScalingGroups** *(list) --* The Auto Scaling groups associated with the node group. * *(dict) --* An Auto Scaling group that is associated with an Amazon EKS managed node group. * **name** *(string) --* The name of the Auto Scaling group associated with an Amazon EKS managed node group. * **remoteAccessSecurityGroup** *(string) --* The remote access security group associated with the node group. This security group controls SSH access to the nodes. * **diskSize** *(integer) --* If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is "null". * **health** *(dict) --* The health status of the node group. If there are issues with your node group's health, they are listed here. * **issues** *(list) --* Any issues that are associated with the node group. * *(dict) --* An object representing an issue with an Amazon EKS resource. * **code** *(string) --* A brief description of the error. * **AccessDenied**: Amazon EKS or one or more of your managed nodes is failing to authenticate or authorize with your Kubernetes cluster API server. * **AsgInstanceLaunchFailures**: Your Auto Scaling group is experiencing failures while attempting to launch instances. * **AutoScalingGroupNotFound**: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover. * **ClusterUnreachable**: Amazon EKS or one or more of your managed nodes is unable to to communicate with your Kubernetes cluster API server. This can happen if there are network disruptions or if API servers are timing out processing requests. * **Ec2InstanceTypeDoesNotExist**: One or more of the supplied Amazon EC2 instance types do not exist. Amazon EKS checked for the instance types that you provided in this Amazon Web Services Region, and one or more aren't available. * **Ec2LaunchTemplateNotFound**: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover. * **Ec2LaunchTemplateVersionMismatch**: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover. * **Ec2SecurityGroupDeletionFailure**: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group. * **Ec2SecurityGroupNotFound**: We couldn't find the cluster security group for the cluster. You must recreate your cluster. * **Ec2SubnetInvalidConfiguration**: One or more Amazon EC2 subnets specified for a node group do not automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned a public IP address, then you need to enable the "auto-assign public IP address" setting for the subnet. See Modifying the public IPv4 addressing attribute for your subnet in the *Amazon VPC User Guide*. * **IamInstanceProfileNotFound**: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover. * **IamNodeRoleNotFound**: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover. * **InstanceLimitExceeded**: Your Amazon Web Services account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover. * **InsufficientFreeAddresses**: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes. * **InternalFailure**: These errors are usually caused by an Amazon EKS server-side issue. * **NodeCreationFailure**: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient node IAM role permissions or lack of outbound internet access for the nodes. * **message** *(string) --* The error message associated with the issue. * **resourceIds** *(list) --* The Amazon Web Services resources that are afflicted by this issue. * *(string) --* * **updateConfig** *(dict) --* The node group update configuration. * **maxUnavailable** *(integer) --* The maximum number of nodes unavailable at once during a version update. Nodes are updated in parallel. This value or "maxUnavailablePercentage" is required to have a value.The maximum number is 100. * **maxUnavailablePercentage** *(integer) --* The maximum percentage of nodes unavailable during a version update. This percentage of nodes are updated in parallel, up to 100 nodes at once. This value or "maxUnavailable" is required to have a value. * **updateStrategy** *(string) --* The configuration for the behavior to follow during a node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action. An Amazon EKS managed node group updates by replacing nodes with new nodes of newer AMI versions in parallel. The *update strategy* changes the managed node update behavior of the managed node group for each quantity. The *default* strategy has guardrails to protect you from misconfiguration and launches the new instances first, before terminating the old instances. The *minimal* strategy removes the guardrails and terminates the old instances before launching the new instances. This minimal strategy is useful in scenarios where you are constrained to resources or costs (for example, with hardware accelerators such as GPUs). * **nodeRepairConfig** *(dict) --* The node auto repair configuration for the node group. * **enabled** *(boolean) --* Specifies whether to enable node auto repair for the node group. Node auto repair is disabled by default. * **launchTemplate** *(dict) --* If a launch template was used to create the node group, then this is the launch template that was used. * **name** *(string) --* The name of the launch template. You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name. * **version** *(string) --* The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates. * **id** *(string) --* The ID of the launch template. You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID. * **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). **Exceptions** * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" EKS / Client / delete_addon delete_addon ************ EKS.Client.delete_addon(**kwargs) Deletes an Amazon EKS add-on. When you remove an add-on, it's deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API. See also: AWS API Documentation **Request Syntax** response = client.delete_addon( clusterName='string', addonName='string', preserve=True|False ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **addonName** (*string*) -- **[REQUIRED]** The name of the add-on. The name must match one of the names returned by ListAddons. * **preserve** (*boolean*) -- Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it isn't removed. Return type: dict Returns: **Response Syntax** { 'addon': { 'addonName': 'string', 'clusterName': 'string', 'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETE_FAILED'|'DEGRADED'|'UPDATE_FAILED', 'addonVersion': 'string', 'health': { 'issues': [ { 'code': 'AccessDenied'|'InternalFailure'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound'|'AddonSubscriptionNeeded'|'AddonPermissionFailure', 'message': 'string', 'resourceIds': [ 'string', ] }, ] }, 'addonArn': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'serviceAccountRoleArn': 'string', 'tags': { 'string': 'string' }, 'publisher': 'string', 'owner': 'string', 'marketplaceInformation': { 'productId': 'string', 'productUrl': 'string' }, 'configurationValues': 'string', 'podIdentityAssociations': [ 'string', ] } } **Response Structure** * *(dict) --* * **addon** *(dict) --* An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the *Amazon EKS User Guide*. * **addonName** *(string) --* The name of the add-on. * **clusterName** *(string) --* The name of your cluster. * **status** *(string) --* The status of the add-on. * **addonVersion** *(string) --* The version of the add-on. * **health** *(dict) --* An object that represents the health of the add-on. * **issues** *(list) --* An object representing the health issues for an add-on. * *(dict) --* An issue related to an add-on. * **code** *(string) --* A code that describes the type of issue. * **message** *(string) --* A message that provides details about the issue and what might cause it. * **resourceIds** *(list) --* The resource IDs of the issue. * *(string) --* * **addonArn** *(string) --* The Amazon Resource Name (ARN) of the add-on. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. * **serviceAccountRoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that's bound to the Kubernetes "ServiceAccount" object that the add-on uses. * **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). * **publisher** *(string) --* The publisher of the add-on. * **owner** *(string) --* The owner of the add-on. * **marketplaceInformation** *(dict) --* Information about an Amazon EKS add-on from the Amazon Web Services Marketplace. * **productId** *(string) --* The product ID from the Amazon Web Services Marketplace. * **productUrl** *(string) --* The product URL from the Amazon Web Services Marketplace. * **configurationValues** *(string) --* The configuration values that you provided. * **podIdentityAssociations** *(list) --* An array of EKS Pod Identity associations owned by the add-on. Each association maps a role to a service account in a namespace in the cluster. For more information, see Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity in the *Amazon EKS User Guide*. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" EKS / Client / describe_insight describe_insight **************** EKS.Client.describe_insight(**kwargs) Returns details about an insight that you specify using its ID. See also: AWS API Documentation **Request Syntax** response = client.describe_insight( clusterName='string', id='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of the cluster to describe the insight for. * **id** (*string*) -- **[REQUIRED]** The identity of the insight to describe. Return type: dict Returns: **Response Syntax** { 'insight': { 'id': 'string', 'name': 'string', 'category': 'UPGRADE_READINESS'|'MISCONFIGURATION', 'kubernetesVersion': 'string', 'lastRefreshTime': datetime(2015, 1, 1), 'lastTransitionTime': datetime(2015, 1, 1), 'description': 'string', 'insightStatus': { 'status': 'PASSING'|'WARNING'|'ERROR'|'UNKNOWN', 'reason': 'string' }, 'recommendation': 'string', 'additionalInfo': { 'string': 'string' }, 'resources': [ { 'insightStatus': { 'status': 'PASSING'|'WARNING'|'ERROR'|'UNKNOWN', 'reason': 'string' }, 'kubernetesResourceUri': 'string', 'arn': 'string' }, ], 'categorySpecificSummary': { 'deprecationDetails': [ { 'usage': 'string', 'replacedWith': 'string', 'stopServingVersion': 'string', 'startServingReplacementVersion': 'string', 'clientStats': [ { 'userAgent': 'string', 'numberOfRequestsLast30Days': 123, 'lastRequestTime': datetime(2015, 1, 1) }, ] }, ], 'addonCompatibilityDetails': [ { 'name': 'string', 'compatibleVersions': [ 'string', ] }, ] } } } **Response Structure** * *(dict) --* * **insight** *(dict) --* The full description of the insight. * **id** *(string) --* The ID of the insight. * **name** *(string) --* The name of the insight. * **category** *(string) --* The category of the insight. * **kubernetesVersion** *(string) --* The Kubernetes minor version associated with an insight if applicable. * **lastRefreshTime** *(datetime) --* The time Amazon EKS last successfully completed a refresh of this insight check on the cluster. * **lastTransitionTime** *(datetime) --* The time the status of the insight last changed. * **description** *(string) --* The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown). * **insightStatus** *(dict) --* An object containing more detail on the status of the insight resource. * **status** *(string) --* The status of the resource. * **reason** *(string) --* Explanation on the reasoning for the status of the resource. * **recommendation** *(string) --* A summary of how to remediate the finding of this insight if applicable. * **additionalInfo** *(dict) --* Links to sources that provide additional context on the insight. * *(string) --* * *(string) --* * **resources** *(list) --* The details about each resource listed in the insight check result. * *(dict) --* Returns information about the resource being evaluated. * **insightStatus** *(dict) --* An object containing more detail on the status of the insight resource. * **status** *(string) --* The status of the resource. * **reason** *(string) --* Explanation on the reasoning for the status of the resource. * **kubernetesResourceUri** *(string) --* The Kubernetes resource URI if applicable. * **arn** *(string) --* The Amazon Resource Name (ARN) if applicable. * **categorySpecificSummary** *(dict) --* Summary information that relates to the category of the insight. Currently only returned with certain insights having category "UPGRADE_READINESS". * **deprecationDetails** *(list) --* The summary information about deprecated resource usage for an insight check in the "UPGRADE_READINESS" category. * *(dict) --* The summary information about deprecated resource usage for an insight check in the "UPGRADE_READINESS" category. * **usage** *(string) --* The deprecated version of the resource. * **replacedWith** *(string) --* The newer version of the resource to migrate to if applicable. * **stopServingVersion** *(string) --* The version of the software where the deprecated resource version will stop being served. * **startServingReplacementVersion** *(string) --* The version of the software where the newer resource version became available to migrate to if applicable. * **clientStats** *(list) --* Details about Kubernetes clients using the deprecated resources. * *(dict) --* Details about clients using the deprecated resources. * **userAgent** *(string) --* The user agent of the Kubernetes client using the deprecated resource. * **numberOfRequestsLast30Days** *(integer) --* The number of requests from the Kubernetes client seen over the last 30 days. * **lastRequestTime** *(datetime) --* The timestamp of the last request seen from the Kubernetes client. * **addonCompatibilityDetails** *(list) --* A list of "AddonCompatibilityDetail" objects for Amazon EKS add-ons. * *(dict) --* The summary information about the Amazon EKS add-on compatibility for the next Kubernetes version for an insight check in the "UPGRADE_READINESS" category. * **name** *(string) --* The name of the Amazon EKS add-on. * **compatibleVersions** *(list) --* The list of compatible Amazon EKS add-on versions for the next Kubernetes version. * *(string) --* **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" EKS / Client / list_eks_anywhere_subscriptions list_eks_anywhere_subscriptions ******************************* EKS.Client.list_eks_anywhere_subscriptions(**kwargs) Displays the full description of the subscription. See also: AWS API Documentation **Request Syntax** response = client.list_eks_anywhere_subscriptions( maxResults=123, nextToken='string', includeStatus=[ 'CREATING'|'ACTIVE'|'UPDATING'|'EXPIRING'|'EXPIRED'|'DELETING', ] ) Parameters: * **maxResults** (*integer*) -- The maximum number of cluster results returned by ListEksAnywhereSubscriptions in paginated output. When you use this parameter, ListEksAnywhereSubscriptions returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListEksAnywhereSubscriptions request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListEksAnywhereSubscriptions returns up to 10 results and a nextToken value if applicable. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated "ListEksAnywhereSubscriptions" request where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. * **includeStatus** (*list*) -- An array of subscription statuses to filter on. * *(string) --* Return type: dict Returns: **Response Syntax** { 'subscriptions': [ { 'id': 'string', 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'effectiveDate': datetime(2015, 1, 1), 'expirationDate': datetime(2015, 1, 1), 'licenseQuantity': 123, 'licenseType': 'Cluster', 'term': { 'duration': 123, 'unit': 'MONTHS' }, 'status': 'string', 'autoRenew': True|False, 'licenseArns': [ 'string', ], 'licenses': [ { 'id': 'string', 'token': 'string' }, ], 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **subscriptions** *(list) --* A list of all subscription objects in the region, filtered by includeStatus and paginated by nextToken and maxResults. * *(dict) --* An EKS Anywhere subscription authorizing the customer to support for licensed clusters and access to EKS Anywhere Curated Packages. * **id** *(string) --* UUID identifying a subscription. * **arn** *(string) --* The Amazon Resource Name (ARN) for the subscription. * **createdAt** *(datetime) --* The Unix timestamp in seconds for when the subscription was created. * **effectiveDate** *(datetime) --* The Unix timestamp in seconds for when the subscription is effective. * **expirationDate** *(datetime) --* The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object. * **licenseQuantity** *(integer) --* The number of licenses included in a subscription. Valid values are between 1 and 100. * **licenseType** *(string) --* The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster. * **term** *(dict) --* An EksAnywhereSubscriptionTerm object. * **duration** *(integer) --* The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription. * **unit** *(string) --* The term unit of the subscription. Valid value is "MONTHS". * **status** *(string) --* The status of a subscription. * **autoRenew** *(boolean) --* A boolean indicating whether or not a subscription will auto renew when it expires. * **licenseArns** *(list) --* Amazon Web Services License Manager ARN associated with the subscription. * *(string) --* * **licenses** *(list) --* Includes all of the claims in the license token necessary to validate the license for extended support. * *(dict) --* An EKS Anywhere license associated with a subscription. * **id** *(string) --* An id associated with an EKS Anywhere subscription license. * **token** *(string) --* An optional license token that can be used for extended support verification. * **tags** *(dict) --* The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription. * *(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). * **nextToken** *(string) --* The nextToken value to include in a future ListEksAnywhereSubscriptions request. When the results of a ListEksAnywhereSubscriptions request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return. **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" EKS / Client / describe_nodegroup describe_nodegroup ****************** EKS.Client.describe_nodegroup(**kwargs) Describes a managed node group. See also: AWS API Documentation **Request Syntax** response = client.describe_nodegroup( clusterName='string', nodegroupName='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **nodegroupName** (*string*) -- **[REQUIRED]** The name of the node group to describe. Return type: dict Returns: **Response Syntax** { 'nodegroup': { 'nodegroupName': 'string', 'nodegroupArn': 'string', 'clusterName': 'string', 'version': 'string', 'releaseVersion': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'|'DEGRADED', 'capacityType': 'ON_DEMAND'|'SPOT'|'CAPACITY_BLOCK', 'scalingConfig': { 'minSize': 123, 'maxSize': 123, 'desiredSize': 123 }, 'instanceTypes': [ 'string', ], 'subnets': [ 'string', ], 'remoteAccess': { 'ec2SshKey': 'string', 'sourceSecurityGroups': [ 'string', ] }, 'amiType': 'AL2_x86_64'|'AL2_x86_64_GPU'|'AL2_ARM_64'|'CUSTOM'|'BOTTLEROCKET_ARM_64'|'BOTTLEROCKET_x86_64'|'BOTTLEROCKET_ARM_64_FIPS'|'BOTTLEROCKET_x86_64_FIPS'|'BOTTLEROCKET_ARM_64_NVIDIA'|'BOTTLEROCKET_x86_64_NVIDIA'|'WINDOWS_CORE_2019_x86_64'|'WINDOWS_FULL_2019_x86_64'|'WINDOWS_CORE_2022_x86_64'|'WINDOWS_FULL_2022_x86_64'|'AL2023_x86_64_STANDARD'|'AL2023_ARM_64_STANDARD'|'AL2023_x86_64_NEURON'|'AL2023_x86_64_NVIDIA'|'AL2023_ARM_64_NVIDIA', 'nodeRole': 'string', 'labels': { 'string': 'string' }, 'taints': [ { 'key': 'string', 'value': 'string', 'effect': 'NO_SCHEDULE'|'NO_EXECUTE'|'PREFER_NO_SCHEDULE' }, ], 'resources': { 'autoScalingGroups': [ { 'name': 'string' }, ], 'remoteAccessSecurityGroup': 'string' }, 'diskSize': 123, 'health': { 'issues': [ { 'code': 'AutoScalingGroupNotFound'|'AutoScalingGroupInvalidConfiguration'|'Ec2SecurityGroupNotFound'|'Ec2SecurityGroupDeletionFailure'|'Ec2LaunchTemplateNotFound'|'Ec2LaunchTemplateVersionMismatch'|'Ec2SubnetNotFound'|'Ec2SubnetInvalidConfiguration'|'IamInstanceProfileNotFound'|'Ec2SubnetMissingIpv6Assignment'|'IamLimitExceeded'|'IamNodeRoleNotFound'|'NodeCreationFailure'|'AsgInstanceLaunchFailures'|'InstanceLimitExceeded'|'InsufficientFreeAddresses'|'AccessDenied'|'InternalFailure'|'ClusterUnreachable'|'AmiIdNotFound'|'AutoScalingGroupOptInRequired'|'AutoScalingGroupRateLimitExceeded'|'Ec2LaunchTemplateDeletionFailure'|'Ec2LaunchTemplateInvalidConfiguration'|'Ec2LaunchTemplateMaxLimitExceeded'|'Ec2SubnetListTooLong'|'IamThrottling'|'NodeTerminationFailure'|'PodEvictionFailure'|'SourceEc2LaunchTemplateNotFound'|'LimitExceeded'|'Unknown'|'AutoScalingGroupInstanceRefreshActive'|'KubernetesLabelInvalid'|'Ec2LaunchTemplateVersionMaxLimitExceeded'|'Ec2InstanceTypeDoesNotExist', 'message': 'string', 'resourceIds': [ 'string', ] }, ] }, 'updateConfig': { 'maxUnavailable': 123, 'maxUnavailablePercentage': 123, 'updateStrategy': 'DEFAULT'|'MINIMAL' }, 'nodeRepairConfig': { 'enabled': True|False }, 'launchTemplate': { 'name': 'string', 'version': 'string', 'id': 'string' }, 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **nodegroup** *(dict) --* The full description of your node group. * **nodegroupName** *(string) --* The name associated with an Amazon EKS managed node group. * **nodegroupArn** *(string) --* The Amazon Resource Name (ARN) associated with the managed node group. * **clusterName** *(string) --* The name of your cluster. * **version** *(string) --* The Kubernetes version of the managed node group. * **releaseVersion** *(string) --* If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. * **status** *(string) --* The current status of the managed node group. * **capacityType** *(string) --* The capacity type of your managed node group. * **scalingConfig** *(dict) --* The scaling configuration details for the Auto Scaling group that is associated with your node group. * **minSize** *(integer) --* The minimum number of nodes that the managed node group can scale in to. * **maxSize** *(integer) --* The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the *Amazon EKS User Guide*. * **desiredSize** *(integer) --* The current number of nodes that the managed node group should maintain. Warning: If you use the Kubernetes Cluster Autoscaler, you shouldn't change the "desiredSize" value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down. Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template. This parameter can be different from "minSize" in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the "desiredSize" parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than "minSize" or higher than "maxSize". * **instanceTypes** *(list) --* If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is "null". * *(string) --* * **subnets** *(list) --* The subnets that were specified for the Auto Scaling group that is associated with your node group. * *(string) --* * **remoteAccess** *(dict) --* If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is "null". * **ec2SshKey** *(string) --* The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. For Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more information, see Amazon EC2 key pairs and Windows instances in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*. * **sourceSecurityGroups** *(list) --* The security group IDs that are allowed SSH access (port 22) to the nodes. For Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet ( "0.0.0.0/0"). For more information, see Security Groups for Your VPC in the *Amazon Virtual Private Cloud User Guide*. * *(string) --* * **amiType** *(string) --* If the node group was deployed using a launch template with a custom AMI, then this is "CUSTOM". For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration. * **nodeRole** *(string) --* The IAM role associated with your node group. The Amazon EKS node "kubelet" daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. * **labels** *(dict) --* The Kubernetes "labels" applied to the nodes in the node group. Note: Only "labels" that are applied with the Amazon EKS API are shown here. There may be other Kubernetes "labels" applied to the nodes in this group. * *(string) --* * *(string) --* * **taints** *(list) --* The Kubernetes taints to be applied to the nodes in the node group when they are created. Effect is one of "No_Schedule", "Prefer_No_Schedule", or "No_Execute". Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. For more information, see Node taints on managed node groups. * *(dict) --* A property that allows a node to repel a "Pod". For more information, see Node taints on managed node groups in the *Amazon EKS User Guide*. * **key** *(string) --* The key of the taint. * **value** *(string) --* The value of the taint. * **effect** *(string) --* The effect of the taint. * **resources** *(dict) --* The resources associated with the node group, such as Auto Scaling groups and security groups for remote access. * **autoScalingGroups** *(list) --* The Auto Scaling groups associated with the node group. * *(dict) --* An Auto Scaling group that is associated with an Amazon EKS managed node group. * **name** *(string) --* The name of the Auto Scaling group associated with an Amazon EKS managed node group. * **remoteAccessSecurityGroup** *(string) --* The remote access security group associated with the node group. This security group controls SSH access to the nodes. * **diskSize** *(integer) --* If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is "null". * **health** *(dict) --* The health status of the node group. If there are issues with your node group's health, they are listed here. * **issues** *(list) --* Any issues that are associated with the node group. * *(dict) --* An object representing an issue with an Amazon EKS resource. * **code** *(string) --* A brief description of the error. * **AccessDenied**: Amazon EKS or one or more of your managed nodes is failing to authenticate or authorize with your Kubernetes cluster API server. * **AsgInstanceLaunchFailures**: Your Auto Scaling group is experiencing failures while attempting to launch instances. * **AutoScalingGroupNotFound**: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover. * **ClusterUnreachable**: Amazon EKS or one or more of your managed nodes is unable to to communicate with your Kubernetes cluster API server. This can happen if there are network disruptions or if API servers are timing out processing requests. * **Ec2InstanceTypeDoesNotExist**: One or more of the supplied Amazon EC2 instance types do not exist. Amazon EKS checked for the instance types that you provided in this Amazon Web Services Region, and one or more aren't available. * **Ec2LaunchTemplateNotFound**: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover. * **Ec2LaunchTemplateVersionMismatch**: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover. * **Ec2SecurityGroupDeletionFailure**: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group. * **Ec2SecurityGroupNotFound**: We couldn't find the cluster security group for the cluster. You must recreate your cluster. * **Ec2SubnetInvalidConfiguration**: One or more Amazon EC2 subnets specified for a node group do not automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned a public IP address, then you need to enable the "auto-assign public IP address" setting for the subnet. See Modifying the public IPv4 addressing attribute for your subnet in the *Amazon VPC User Guide*. * **IamInstanceProfileNotFound**: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover. * **IamNodeRoleNotFound**: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover. * **InstanceLimitExceeded**: Your Amazon Web Services account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover. * **InsufficientFreeAddresses**: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes. * **InternalFailure**: These errors are usually caused by an Amazon EKS server-side issue. * **NodeCreationFailure**: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient node IAM role permissions or lack of outbound internet access for the nodes. * **message** *(string) --* The error message associated with the issue. * **resourceIds** *(list) --* The Amazon Web Services resources that are afflicted by this issue. * *(string) --* * **updateConfig** *(dict) --* The node group update configuration. * **maxUnavailable** *(integer) --* The maximum number of nodes unavailable at once during a version update. Nodes are updated in parallel. This value or "maxUnavailablePercentage" is required to have a value.The maximum number is 100. * **maxUnavailablePercentage** *(integer) --* The maximum percentage of nodes unavailable during a version update. This percentage of nodes are updated in parallel, up to 100 nodes at once. This value or "maxUnavailable" is required to have a value. * **updateStrategy** *(string) --* The configuration for the behavior to follow during a node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action. An Amazon EKS managed node group updates by replacing nodes with new nodes of newer AMI versions in parallel. The *update strategy* changes the managed node update behavior of the managed node group for each quantity. The *default* strategy has guardrails to protect you from misconfiguration and launches the new instances first, before terminating the old instances. The *minimal* strategy removes the guardrails and terminates the old instances before launching the new instances. This minimal strategy is useful in scenarios where you are constrained to resources or costs (for example, with hardware accelerators such as GPUs). * **nodeRepairConfig** *(dict) --* The node auto repair configuration for the node group. * **enabled** *(boolean) --* Specifies whether to enable node auto repair for the node group. Node auto repair is disabled by default. * **launchTemplate** *(dict) --* If a launch template was used to create the node group, then this is the launch template that was used. * **name** *(string) --* The name of the launch template. You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name. * **version** *(string) --* The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates. * **id** *(string) --* The ID of the launch template. You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID. * **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). **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" EKS / Client / list_nodegroups list_nodegroups *************** EKS.Client.list_nodegroups(**kwargs) Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren't listed. See also: AWS API Documentation **Request Syntax** response = client.list_nodegroups( clusterName='string', maxResults=123, nextToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **maxResults** (*integer*) -- The maximum number of results, returned in paginated output. You receive "maxResults" in a single page, along with a "nextToken" response element. You can see the remaining results of the initial request by sending another request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a "nextToken" value, if applicable, are returned. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. Return type: dict Returns: **Response Syntax** { 'nodegroups': [ 'string', ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **nodegroups** *(list) --* A list of all of the node groups associated with the specified cluster. * *(string) --* * **nextToken** *(string) --* The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" * "EKS.Client.exceptions.ResourceNotFoundException" EKS / Client / create_addon create_addon ************ EKS.Client.create_addon(**kwargs) Creates an Amazon EKS add-on. Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see Amazon EKS add-ons in the *Amazon EKS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_addon( clusterName='string', addonName='string', addonVersion='string', serviceAccountRoleArn='string', resolveConflicts='OVERWRITE'|'NONE'|'PRESERVE', clientRequestToken='string', tags={ 'string': 'string' }, configurationValues='string', podIdentityAssociations=[ { 'serviceAccount': 'string', 'roleArn': 'string' }, ] ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **addonName** (*string*) -- **[REQUIRED]** The name of the add-on. The name must match one of the names returned by "DescribeAddonVersions". * **addonVersion** (*string*) -- The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions. * **serviceAccountRoleArn** (*string*) -- The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the *Amazon EKS User Guide*. Note: To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the *Amazon EKS User Guide*. * **resolveConflicts** (*string*) -- How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are handled based on the value you choose: * **None** – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail. * **Overwrite** – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value. * **Preserve** – This is similar to the NONE option. If the self-managed version of the add-on is installed on your cluster Amazon EKS doesn't change the add-on resource properties. Creation of the add-on might fail if conflicts are detected. This option works differently during the update operation. For more information, see UpdateAddon. If you don't currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify. * **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). * **configurationValues** (*string*) -- The set of configuration values for the add-on that's created. The values that you provide are validated against the schema returned by "DescribeAddonConfiguration". * **podIdentityAssociations** (*list*) -- An array of EKS Pod Identity associations to be created. Each association maps a Kubernetes service account to an IAM role. For more information, see Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity in the *Amazon EKS User Guide*. * *(dict) --* A type of EKS Pod Identity association owned by an Amazon EKS add-on. Each association maps a role to a service account in a namespace in the cluster. For more information, see Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity in the *Amazon EKS User Guide*. * **serviceAccount** *(string) --* **[REQUIRED]** The name of a Kubernetes Service Account. * **roleArn** *(string) --* **[REQUIRED]** The ARN of an IAM Role. Return type: dict Returns: **Response Syntax** { 'addon': { 'addonName': 'string', 'clusterName': 'string', 'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETE_FAILED'|'DEGRADED'|'UPDATE_FAILED', 'addonVersion': 'string', 'health': { 'issues': [ { 'code': 'AccessDenied'|'InternalFailure'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound'|'AddonSubscriptionNeeded'|'AddonPermissionFailure', 'message': 'string', 'resourceIds': [ 'string', ] }, ] }, 'addonArn': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'serviceAccountRoleArn': 'string', 'tags': { 'string': 'string' }, 'publisher': 'string', 'owner': 'string', 'marketplaceInformation': { 'productId': 'string', 'productUrl': 'string' }, 'configurationValues': 'string', 'podIdentityAssociations': [ 'string', ] } } **Response Structure** * *(dict) --* * **addon** *(dict) --* An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the *Amazon EKS User Guide*. * **addonName** *(string) --* The name of the add-on. * **clusterName** *(string) --* The name of your cluster. * **status** *(string) --* The status of the add-on. * **addonVersion** *(string) --* The version of the add-on. * **health** *(dict) --* An object that represents the health of the add-on. * **issues** *(list) --* An object representing the health issues for an add-on. * *(dict) --* An issue related to an add-on. * **code** *(string) --* A code that describes the type of issue. * **message** *(string) --* A message that provides details about the issue and what might cause it. * **resourceIds** *(list) --* The resource IDs of the issue. * *(string) --* * **addonArn** *(string) --* The Amazon Resource Name (ARN) of the add-on. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. * **serviceAccountRoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that's bound to the Kubernetes "ServiceAccount" object that the add-on uses. * **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). * **publisher** *(string) --* The publisher of the add-on. * **owner** *(string) --* The owner of the add-on. * **marketplaceInformation** *(dict) --* Information about an Amazon EKS add-on from the Amazon Web Services Marketplace. * **productId** *(string) --* The product ID from the Amazon Web Services Marketplace. * **productUrl** *(string) --* The product URL from the Amazon Web Services Marketplace. * **configurationValues** *(string) --* The configuration values that you provided. * **podIdentityAssociations** *(list) --* An array of EKS Pod Identity associations owned by the add-on. Each association maps a role to a service account in a namespace in the cluster. For more information, see Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity in the *Amazon EKS User Guide*. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" EKS / Client / list_access_policies list_access_policies ******************** EKS.Client.list_access_policies(**kwargs) Lists the available access policies. See also: AWS API Documentation **Request Syntax** response = client.list_access_policies( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results, returned in paginated output. You receive "maxResults" in a single page, along with a "nextToken" response element. You can see the remaining results of the initial request by sending another request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a "nextToken" value, if applicable, are returned. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. Return type: dict Returns: **Response Syntax** { 'accessPolicies': [ { 'name': 'string', 'arn': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **accessPolicies** *(list) --* The list of available access policies. You can't view the contents of an access policy using the API. To view the contents, see Access policy permissions in the *Amazon EKS User Guide*. * *(dict) --* An access policy includes permissions that allow Amazon EKS to authorize an IAM principal to work with Kubernetes objects on your cluster. The policies are managed by Amazon EKS, but they're not IAM policies. You can't view the permissions in the policies using the API. The permissions for many of the policies are similar to the Kubernetes "cluster-admin", "admin", "edit", and "view" cluster roles. For more information about these cluster roles, see User-facing roles in the Kubernetes documentation. To view the contents of the policies, see Access policy permissions in the *Amazon EKS User Guide*. * **name** *(string) --* The name of the access policy. * **arn** *(string) --* The ARN of the access policy. * **nextToken** *(string) --* The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. **Exceptions** * "EKS.Client.exceptions.ServerException" EKS / Client / create_access_entry create_access_entry ******************* EKS.Client.create_access_entry(**kwargs) Creates an access entry. An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain entries in the "aws-auth" "ConfigMap" for authentication. You have the following options for authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you to create and manage Kubernetes "Role", "ClusterRole", "RoleBinding", and "ClusterRoleBinding" objects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need to create and manage Kubernetes "Role", "ClusterRole", "RoleBinding", and "ClusterRoleBinding" objects. For more information about access entries, see Access entries in the *Amazon EKS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_access_entry( clusterName='string', principalArn='string', kubernetesGroups=[ 'string', ], tags={ 'string': 'string' }, clientRequestToken='string', username='string', type='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **principalArn** (*string*) -- **[REQUIRED]** The ARN of the IAM principal for the "AccessEntry". You can specify one ARN for each access entry. You can't specify the same ARN in more than one access entry. This value can't be changed after access entry creation. The valid principals differ depending on the type of the access entry in the "type" field. For "STANDARD" access entries, you can use every IAM principal type. For nodes ( "EC2" (for EKS Auto Mode), "EC2_LINUX", "EC2_WINDOWS", "FARGATE_LINUX", and "HYBRID_LINUX"), the only valid ARN is IAM roles. You can't use the STS session principal type with access entries because this is a temporary principal for each session and not a permanent identity that can be assigned permissions. IAM best practices recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials. * **kubernetesGroups** (*list*) -- The value for "name" that you've specified for "kind: Group" as a "subject" in a Kubernetes "RoleBinding" or "ClusterRoleBinding" object. Amazon EKS doesn't confirm that the value for "name" exists in any bindings on your cluster. You can specify one or more names. Kubernetes authorizes the "principalArn" of the access entry to access any cluster objects that you've specified in a Kubernetes "Role" or "ClusterRole" object that is also specified in a binding's "roleRef". For more information about creating Kubernetes "RoleBinding", "ClusterRoleBinding", "Role", or "ClusterRole" objects, see Using RBAC Authorization in the Kubernetes documentation. If you want Amazon EKS to authorize the "principalArn" (instead of, or in addition to Kubernetes authorizing the "principalArn"), you can associate one or more access policies to the access entry using "AssociateAccessPolicy". If you associate any access policies, the "principalARN" has all permissions assigned in the associated access policies and all permissions in any Kubernetes "Role" or "ClusterRole" objects that the group names are bound to. * *(string) --* * **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). * **clientRequestToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. * **username** (*string*) -- The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see Creating access entries in the *Amazon EKS User Guide*. * **type** (*string*) -- The type of the new access entry. Valid values are "STANDARD", "FARGATE_LINUX", "EC2_LINUX", "EC2_WINDOWS", "EC2" (for EKS Auto Mode), "HYBRID_LINUX", and "HYPERPOD_LINUX". If the "principalArn" is for an IAM role that's used for self- managed Amazon EC2 nodes, specify "EC2_LINUX" or "EC2_WINDOWS". Amazon EKS grants the necessary permissions to the node for you. If the "principalArn" is for any other purpose, specify "STANDARD". If you don't specify a value, Amazon EKS sets the value to "STANDARD". If you have the access mode of the cluster set to "API_AND_CONFIG_MAP", it's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the "aws-auth" "ConfigMap" for the roles. You can't change this value once you've created the access entry. If you set the value to "EC2_LINUX" or "EC2_WINDOWS", you can't specify values for "kubernetesGroups", or associate an "AccessPolicy" to the access entry. Return type: dict Returns: **Response Syntax** { 'accessEntry': { 'clusterName': 'string', 'principalArn': 'string', 'kubernetesGroups': [ 'string', ], 'accessEntryArn': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'username': 'string', 'type': 'string' } } **Response Structure** * *(dict) --* * **accessEntry** *(dict) --* An access entry allows an IAM principal (user or role) to access your cluster. Access entries can replace the need to maintain the "aws-auth" "ConfigMap" for authentication. For more information about access entries, see Access entries in the *Amazon EKS User Guide*. * **clusterName** *(string) --* The name of your cluster. * **principalArn** *(string) --* The ARN of the IAM principal for the access entry. If you ever delete the IAM principal with this ARN, the access entry isn't automatically deleted. We recommend that you delete the access entry with an ARN for an IAM principal that you delete. If you don't delete the access entry and ever recreate the IAM principal, even if it has the same ARN, the access entry won't work. This is because even though the ARN is the same for the recreated IAM principal, the "roleID" or "userID" (you can see this with the Security Token Service "GetCallerIdentity" API) is different for the recreated IAM principal than it was for the original IAM principal. Even though you don't see the IAM principal's "roleID" or "userID" for an access entry, Amazon EKS stores it with the access entry. * **kubernetesGroups** *(list) --* A "name" that you've specified in a Kubernetes "RoleBinding" or "ClusterRoleBinding" object so that Kubernetes authorizes the "principalARN" access to cluster objects. * *(string) --* * **accessEntryArn** *(string) --* The ARN of the access entry. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. * **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). * **username** *(string) --* The "name" of a user that can authenticate to your cluster. * **type** *(string) --* The type of the access entry. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ResourceLimitExceededException" * "EKS.Client.exceptions.ResourceInUseException" EKS / Client / update_nodegroup_config update_nodegroup_config *********************** EKS.Client.update_nodegroup_config(**kwargs) Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. You can update the Kubernetes labels and taints for a node group and the scaling and version update configuration. See also: AWS API Documentation **Request Syntax** response = client.update_nodegroup_config( clusterName='string', nodegroupName='string', labels={ 'addOrUpdateLabels': { 'string': 'string' }, 'removeLabels': [ 'string', ] }, taints={ 'addOrUpdateTaints': [ { 'key': 'string', 'value': 'string', 'effect': 'NO_SCHEDULE'|'NO_EXECUTE'|'PREFER_NO_SCHEDULE' }, ], 'removeTaints': [ { 'key': 'string', 'value': 'string', 'effect': 'NO_SCHEDULE'|'NO_EXECUTE'|'PREFER_NO_SCHEDULE' }, ] }, scalingConfig={ 'minSize': 123, 'maxSize': 123, 'desiredSize': 123 }, updateConfig={ 'maxUnavailable': 123, 'maxUnavailablePercentage': 123, 'updateStrategy': 'DEFAULT'|'MINIMAL' }, nodeRepairConfig={ 'enabled': True|False }, clientRequestToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **nodegroupName** (*string*) -- **[REQUIRED]** The name of the managed node group to update. * **labels** (*dict*) -- The Kubernetes "labels" to apply to the nodes in the node group after the update. * **addOrUpdateLabels** *(dict) --* The Kubernetes "labels" to add or update. * *(string) --* * *(string) --* * **removeLabels** *(list) --* The Kubernetes "labels" to remove. * *(string) --* * **taints** (*dict*) -- The Kubernetes taints to be applied to the nodes in the node group after the update. For more information, see Node taints on managed node groups. * **addOrUpdateTaints** *(list) --* Kubernetes taints to be added or updated. * *(dict) --* A property that allows a node to repel a "Pod". For more information, see Node taints on managed node groups in the *Amazon EKS User Guide*. * **key** *(string) --* The key of the taint. * **value** *(string) --* The value of the taint. * **effect** *(string) --* The effect of the taint. * **removeTaints** *(list) --* Kubernetes taints to remove. * *(dict) --* A property that allows a node to repel a "Pod". For more information, see Node taints on managed node groups in the *Amazon EKS User Guide*. * **key** *(string) --* The key of the taint. * **value** *(string) --* The value of the taint. * **effect** *(string) --* The effect of the taint. * **scalingConfig** (*dict*) -- The scaling configuration details for the Auto Scaling group after the update. * **minSize** *(integer) --* The minimum number of nodes that the managed node group can scale in to. * **maxSize** *(integer) --* The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the *Amazon EKS User Guide*. * **desiredSize** *(integer) --* The current number of nodes that the managed node group should maintain. Warning: If you use the Kubernetes Cluster Autoscaler, you shouldn't change the "desiredSize" value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down. Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template. This parameter can be different from "minSize" in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the "desiredSize" parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than "minSize" or higher than "maxSize". * **updateConfig** (*dict*) -- The node group update configuration. * **maxUnavailable** *(integer) --* The maximum number of nodes unavailable at once during a version update. Nodes are updated in parallel. This value or "maxUnavailablePercentage" is required to have a value.The maximum number is 100. * **maxUnavailablePercentage** *(integer) --* The maximum percentage of nodes unavailable during a version update. This percentage of nodes are updated in parallel, up to 100 nodes at once. This value or "maxUnavailable" is required to have a value. * **updateStrategy** *(string) --* The configuration for the behavior to follow during a node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action. An Amazon EKS managed node group updates by replacing nodes with new nodes of newer AMI versions in parallel. The *update strategy* changes the managed node update behavior of the managed node group for each quantity. The *default* strategy has guardrails to protect you from misconfiguration and launches the new instances first, before terminating the old instances. The *minimal* strategy removes the guardrails and terminates the old instances before launching the new instances. This minimal strategy is useful in scenarios where you are constrained to resources or costs (for example, with hardware accelerators such as GPUs). * **nodeRepairConfig** (*dict*) -- The node auto repair configuration for the node group. * **enabled** *(boolean) --* Specifies whether to enable node auto repair for the node group. Node auto repair is disabled by default. * **clientRequestToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'update': { 'id': 'string', 'status': 'InProgress'|'Failed'|'Cancelled'|'Successful', 'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate'|'AccessConfigUpdate'|'UpgradePolicyUpdate'|'ZonalShiftConfigUpdate'|'AutoModeUpdate'|'RemoteNetworkConfigUpdate'|'DeletionProtectionUpdate', 'params': [ { 'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'TaintsToAdd'|'TaintsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'LaunchTemplateName'|'LaunchTemplateVersion'|'IdentityProviderConfig'|'EncryptionConfig'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts'|'MaxUnavailable'|'MaxUnavailablePercentage'|'NodeRepairEnabled'|'UpdateStrategy'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig'|'ComputeConfig'|'StorageConfig'|'KubernetesNetworkConfig'|'RemoteNetworkConfig'|'DeletionProtection', 'value': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'errors': [ { 'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound', 'errorMessage': 'string', 'resourceIds': [ 'string', ] }, ] } } **Response Structure** * *(dict) --* * **update** *(dict) --* An object representing an asynchronous update. * **id** *(string) --* A UUID that is used to track the update. * **status** *(string) --* The current status of the update. * **type** *(string) --* The type of the update. * **params** *(list) --* A key-value map that contains the parameters associated with the update. * *(dict) --* An object representing the details of an update request. * **type** *(string) --* The keys associated with an update request. * **value** *(string) --* The value of the keys submitted as part of an update request. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **errors** *(list) --* Any errors associated with a "Failed" update. * *(dict) --* An object representing an error when an asynchronous operation fails. * **errorCode** *(string) --* A brief description of the error. * **SubnetNotFound**: We couldn't find one of the subnets associated with the cluster. * **SecurityGroupNotFound**: We couldn't find one of the security groups associated with the cluster. * **EniLimitReached**: You have reached the elastic network interface limit for your account. * **IpNotAvailable**: A subnet associated with the cluster doesn't have any available IP addresses. * **AccessDenied**: You don't have permissions to perform the specified operation. * **OperationNotPermitted**: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS. * **VpcIdNotFound**: We couldn't find the VPC associated with the cluster. * **errorMessage** *(string) --* A more complete description of the error. * **resourceIds** *(list) --* An optional field that contains the resource IDs associated with the error. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" EKS / Client / disassociate_identity_provider_config disassociate_identity_provider_config ************************************* EKS.Client.disassociate_identity_provider_config(**kwargs) Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with IAM principals. See also: AWS API Documentation **Request Syntax** response = client.disassociate_identity_provider_config( clusterName='string', identityProviderConfig={ 'type': 'string', 'name': 'string' }, clientRequestToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **identityProviderConfig** (*dict*) -- **[REQUIRED]** An object representing an identity provider configuration. * **type** *(string) --* **[REQUIRED]** The type of the identity provider configuration. The only type available is "oidc". * **name** *(string) --* **[REQUIRED]** The name of the identity provider configuration. * **clientRequestToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'update': { 'id': 'string', 'status': 'InProgress'|'Failed'|'Cancelled'|'Successful', 'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate'|'AccessConfigUpdate'|'UpgradePolicyUpdate'|'ZonalShiftConfigUpdate'|'AutoModeUpdate'|'RemoteNetworkConfigUpdate'|'DeletionProtectionUpdate', 'params': [ { 'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'TaintsToAdd'|'TaintsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'LaunchTemplateName'|'LaunchTemplateVersion'|'IdentityProviderConfig'|'EncryptionConfig'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts'|'MaxUnavailable'|'MaxUnavailablePercentage'|'NodeRepairEnabled'|'UpdateStrategy'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig'|'ComputeConfig'|'StorageConfig'|'KubernetesNetworkConfig'|'RemoteNetworkConfig'|'DeletionProtection', 'value': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'errors': [ { 'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound', 'errorMessage': 'string', 'resourceIds': [ 'string', ] }, ] } } **Response Structure** * *(dict) --* * **update** *(dict) --* An object representing an asynchronous update. * **id** *(string) --* A UUID that is used to track the update. * **status** *(string) --* The current status of the update. * **type** *(string) --* The type of the update. * **params** *(list) --* A key-value map that contains the parameters associated with the update. * *(dict) --* An object representing the details of an update request. * **type** *(string) --* The keys associated with an update request. * **value** *(string) --* The value of the keys submitted as part of an update request. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **errors** *(list) --* Any errors associated with a "Failed" update. * *(dict) --* An object representing an error when an asynchronous operation fails. * **errorCode** *(string) --* A brief description of the error. * **SubnetNotFound**: We couldn't find one of the subnets associated with the cluster. * **SecurityGroupNotFound**: We couldn't find one of the security groups associated with the cluster. * **EniLimitReached**: You have reached the elastic network interface limit for your account. * **IpNotAvailable**: A subnet associated with the cluster doesn't have any available IP addresses. * **AccessDenied**: You don't have permissions to perform the specified operation. * **OperationNotPermitted**: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS. * **VpcIdNotFound**: We couldn't find the VPC associated with the cluster. * **errorMessage** *(string) --* A more complete description of the error. * **resourceIds** *(list) --* An optional field that contains the resource IDs associated with the error. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ThrottlingException" EKS / Client / associate_access_policy associate_access_policy *********************** EKS.Client.associate_access_policy(**kwargs) Associates an access policy and its scope to an access entry. For more information about associating access policies, see Associating and disassociating access policies to and from access entries in the *Amazon EKS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.associate_access_policy( clusterName='string', principalArn='string', policyArn='string', accessScope={ 'type': 'cluster'|'namespace', 'namespaces': [ 'string', ] } ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **principalArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM user or role for the "AccessEntry" that you're associating the access policy to. * **policyArn** (*string*) -- **[REQUIRED]** The ARN of the "AccessPolicy" that you're associating. For a list of ARNs, use "ListAccessPolicies". * **accessScope** (*dict*) -- **[REQUIRED]** The scope for the "AccessPolicy". You can scope access policies to an entire cluster or to specific Kubernetes namespaces. * **type** *(string) --* The scope type of an access policy. * **namespaces** *(list) --* A Kubernetes "namespace" that an access policy is scoped to. A value is required if you specified "namespace" for "Type". * *(string) --* Return type: dict Returns: **Response Syntax** { 'clusterName': 'string', 'principalArn': 'string', 'associatedAccessPolicy': { 'policyArn': 'string', 'accessScope': { 'type': 'cluster'|'namespace', 'namespaces': [ 'string', ] }, 'associatedAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **clusterName** *(string) --* The name of your cluster. * **principalArn** *(string) --* The ARN of the IAM principal for the "AccessEntry". * **associatedAccessPolicy** *(dict) --* The "AccessPolicy" and scope associated to the "AccessEntry". * **policyArn** *(string) --* The ARN of the "AccessPolicy". * **accessScope** *(dict) --* The scope of the access policy. * **type** *(string) --* The scope type of an access policy. * **namespaces** *(list) --* A Kubernetes "namespace" that an access policy is scoped to. A value is required if you specified "namespace" for "Type". * *(string) --* * **associatedAt** *(datetime) --* The date and time the "AccessPolicy" was associated with an "AccessEntry". * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" EKS / Client / list_associated_access_policies list_associated_access_policies ******************************* EKS.Client.list_associated_access_policies(**kwargs) Lists the access policies associated with an access entry. See also: AWS API Documentation **Request Syntax** response = client.list_associated_access_policies( clusterName='string', principalArn='string', maxResults=123, nextToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **principalArn** (*string*) -- **[REQUIRED]** The ARN of the IAM principal for the "AccessEntry". * **maxResults** (*integer*) -- The maximum number of results, returned in paginated output. You receive "maxResults" in a single page, along with a "nextToken" response element. You can see the remaining results of the initial request by sending another request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a "nextToken" value, if applicable, are returned. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. Return type: dict Returns: **Response Syntax** { 'clusterName': 'string', 'principalArn': 'string', 'nextToken': 'string', 'associatedAccessPolicies': [ { 'policyArn': 'string', 'accessScope': { 'type': 'cluster'|'namespace', 'namespaces': [ 'string', ] }, 'associatedAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **clusterName** *(string) --* The name of your cluster. * **principalArn** *(string) --* The ARN of the IAM principal for the "AccessEntry". * **nextToken** *(string) --* The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. * **associatedAccessPolicies** *(list) --* The list of access policies associated with the access entry. * *(dict) --* An access policy association. * **policyArn** *(string) --* The ARN of the "AccessPolicy". * **accessScope** *(dict) --* The scope of the access policy. * **type** *(string) --* The scope type of an access policy. * **namespaces** *(list) --* A Kubernetes "namespace" that an access policy is scoped to. A value is required if you specified "namespace" for "Type". * *(string) --* * **associatedAt** *(datetime) --* The date and time the "AccessPolicy" was associated with an "AccessEntry". * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" EKS / Client / describe_access_entry describe_access_entry ********************* EKS.Client.describe_access_entry(**kwargs) Describes an access entry. See also: AWS API Documentation **Request Syntax** response = client.describe_access_entry( clusterName='string', principalArn='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **principalArn** (*string*) -- **[REQUIRED]** The ARN of the IAM principal for the "AccessEntry". Return type: dict Returns: **Response Syntax** { 'accessEntry': { 'clusterName': 'string', 'principalArn': 'string', 'kubernetesGroups': [ 'string', ], 'accessEntryArn': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'username': 'string', 'type': 'string' } } **Response Structure** * *(dict) --* * **accessEntry** *(dict) --* Information about the access entry. * **clusterName** *(string) --* The name of your cluster. * **principalArn** *(string) --* The ARN of the IAM principal for the access entry. If you ever delete the IAM principal with this ARN, the access entry isn't automatically deleted. We recommend that you delete the access entry with an ARN for an IAM principal that you delete. If you don't delete the access entry and ever recreate the IAM principal, even if it has the same ARN, the access entry won't work. This is because even though the ARN is the same for the recreated IAM principal, the "roleID" or "userID" (you can see this with the Security Token Service "GetCallerIdentity" API) is different for the recreated IAM principal than it was for the original IAM principal. Even though you don't see the IAM principal's "roleID" or "userID" for an access entry, Amazon EKS stores it with the access entry. * **kubernetesGroups** *(list) --* A "name" that you've specified in a Kubernetes "RoleBinding" or "ClusterRoleBinding" object so that Kubernetes authorizes the "principalARN" access to cluster objects. * *(string) --* * **accessEntryArn** *(string) --* The ARN of the access entry. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. * **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). * **username** *(string) --* The "name" of a user that can authenticate to your cluster. * **type** *(string) --* The type of the access entry. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" EKS / Client / close close ***** EKS.Client.close() Closes underlying endpoint connections. EKS / Client / list_fargate_profiles list_fargate_profiles ********************* EKS.Client.list_fargate_profiles(**kwargs) Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.list_fargate_profiles( clusterName='string', maxResults=123, nextToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **maxResults** (*integer*) -- The maximum number of results, returned in paginated output. You receive "maxResults" in a single page, along with a "nextToken" response element. You can see the remaining results of the initial request by sending another request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a "nextToken" value, if applicable, are returned. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. Return type: dict Returns: **Response Syntax** { 'fargateProfileNames': [ 'string', ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **fargateProfileNames** *(list) --* A list of all of the Fargate profiles associated with the specified cluster. * *(string) --* * **nextToken** *(string) --* The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" EKS / Client / list_updates list_updates ************ EKS.Client.list_updates(**kwargs) Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.list_updates( name='string', nodegroupName='string', addonName='string', nextToken='string', maxResults=123 ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the Amazon EKS cluster to list updates for. * **nodegroupName** (*string*) -- The name of the Amazon EKS managed node group to list updates for. * **addonName** (*string*) -- The names of the installed add-ons that have available updates. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. * **maxResults** (*integer*) -- The maximum number of results, returned in paginated output. You receive "maxResults" in a single page, along with a "nextToken" response element. You can see the remaining results of the initial request by sending another request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a "nextToken" value, if applicable, are returned. Return type: dict Returns: **Response Syntax** { 'updateIds': [ 'string', ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **updateIds** *(list) --* A list of all the updates for the specified cluster and Region. * *(string) --* * **nextToken** *(string) --* The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" EKS / Client / create_pod_identity_association create_pod_identity_association ******************************* EKS.Client.create_pod_identity_association(**kwargs) Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with *EKS Pod Identity*. Use EKS Pod Identity to give temporary IAM credentials to Pods and the credentials are rotated automatically. Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances. If a Pod uses a service account that has an association, Amazon EKS sets environment variables in the containers of the Pod. The environment variables configure the Amazon Web Services SDKs, including the Command Line Interface, to use the EKS Pod Identity credentials. EKS Pod Identity is a simpler method than *IAM roles for service accounts*, as this method doesn't use OIDC identity providers. Additionally, you can configure a role for EKS Pod Identity once, and reuse it across clusters. Similar to Amazon Web Services IAM behavior, EKS Pod Identity associations are eventually consistent, and may take several seconds to be effective after the initial API call returns successfully. You must design your applications to account for these potential delays. We recommend that you don’t include association create/updates in the critical, high-availability code paths of your application. Instead, make changes in a separate initialization or setup routine that you run less frequently. You can set a *target IAM role* in the same or a different account for advanced scenarios. With a target role, EKS Pod Identity automatically performs two role assumptions in sequence: first assuming the role in the association that is in this account, then using those credentials to assume the target IAM role. This process provides your Pod with temporary credentials that have the permissions defined in the target role, allowing secure access to resources in another Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.create_pod_identity_association( clusterName='string', namespace='string', serviceAccount='string', roleArn='string', clientRequestToken='string', tags={ 'string': 'string' }, disableSessionTags=True|False, targetRoleArn='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of the cluster to create the EKS Pod Identity association in. * **namespace** (*string*) -- **[REQUIRED]** The name of the Kubernetes namespace inside the cluster to create the EKS Pod Identity association in. The service account and the Pods that use the service account must be in this namespace. * **serviceAccount** (*string*) -- **[REQUIRED]** The name of the Kubernetes service account inside the cluster to associate the IAM credentials with. * **roleArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the Pods that use this service account. * **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. The following basic restrictions apply to tags: * Maximum number of tags per resource – 50 * For each resource, each tag key must be unique, and each tag key can have only one value. * Maximum key length – 128 Unicode characters in UTF-8 * Maximum value length – 256 Unicode characters in UTF-8 * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. * Tag keys and values are case-sensitive. * Do not use "aws:", "AWS:", or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. * *(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). * **disableSessionTags** (*boolean*) -- Disable the automatic sessions tags that are appended by EKS Pod Identity. EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to Amazon Web Services resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see List of session tags added by EKS Pod Identity in the *Amazon EKS User Guide*. Amazon Web Services compresses inline session policies, managed policy ARNs, and session tags into a packed binary format that has a separate limit. If you receive a "PackedPolicyTooLarge" error indicating the packed binary format has exceeded the size limit, you can attempt to reduce the size by disabling the session tags added by EKS Pod Identity. * **targetRoleArn** (*string*) -- The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod. When you run applications on Amazon EKS, your application might need to access Amazon Web Services resources from a different role that exists in the same or different Amazon Web Services account. For example, your application running in “Account A” might need to access resources, such as Amazon S3 buckets in “Account B” or within “Account A” itself. You can create a association to access Amazon Web Services resources in “Account B” by creating two IAM roles: a role in “Account A” and a role in “Account B” (which can be the same or different account), each with the necessary trust and permission policies. After you provide these roles in the *IAM role* and *Target IAM role* fields, EKS will perform role chaining to ensure your application gets the required permissions. This means Role A will assume Role B, allowing your Pods to securely access resources like S3 buckets in the target account. Return type: dict Returns: **Response Syntax** { 'association': { 'clusterName': 'string', 'namespace': 'string', 'serviceAccount': 'string', 'roleArn': 'string', 'associationArn': 'string', 'associationId': 'string', 'tags': { 'string': 'string' }, 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'ownerArn': 'string', 'disableSessionTags': True|False, 'targetRoleArn': 'string', 'externalId': 'string' } } **Response Structure** * *(dict) --* * **association** *(dict) --* The full description of your new association. The description includes an ID for the association. Use the ID of the association in further actions to manage the association. * **clusterName** *(string) --* The name of the cluster that the association is in. * **namespace** *(string) --* The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the Pods that use the service account must be in this namespace. * **serviceAccount** *(string) --* The name of the Kubernetes service account inside the cluster to associate the IAM credentials with. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the Pods that use this service account. * **associationArn** *(string) --* The Amazon Resource Name (ARN) of the association. * **associationId** *(string) --* The ID of the association. * **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. The following basic restrictions apply to tags: * Maximum number of tags per resource – 50 * For each resource, each tag key must be unique, and each tag key can have only one value. * Maximum key length – 128 Unicode characters in UTF-8 * Maximum value length – 256 Unicode characters in UTF-8 * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. * Tag keys and values are case-sensitive. * Do not use "aws:", "AWS:", or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. * *(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). * **createdAt** *(datetime) --* The timestamp that the association was created at. * **modifiedAt** *(datetime) --* The most recent timestamp that the association was modified at. * **ownerArn** *(string) --* If defined, the EKS Pod Identity association is owned by an Amazon EKS add-on. * **disableSessionTags** *(boolean) --* The state of the automatic sessions tags. The value of *true* disables these tags. EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to Amazon Web Services resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see List of session tags added by EKS Pod Identity in the *Amazon EKS User Guide*. * **targetRoleArn** *(string) --* The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod. * **externalId** *(string) --* The unique identifier for this EKS Pod Identity association for a target IAM role. You put this value in the trust policy of the target role, in a "Condition" to match the "sts.ExternalId". This ensures that the target role can only be assumed by this association. This prevents the *confused deputy problem*. For more information about the confused deputy problem, see The confused deputy problem in the *IAM User Guide*. If you want to use the same target role with multiple associations or other roles, use independent statements in the trust policy to allow "sts:AssumeRole" access from each role. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ResourceLimitExceededException" * "EKS.Client.exceptions.ResourceInUseException" EKS / Client / update_cluster_version update_cluster_version ********************** EKS.Client.update_cluster_version(**kwargs) Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation. Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to "UPDATING" (this status transition is eventually consistent). When the update is complete (either "Failed" or "Successful"), the cluster status moves to "Active". If your cluster has managed node groups attached to it, all of your node groups' Kubernetes versions must match the cluster's Kubernetes version in order to update the cluster to a new Kubernetes version. See also: AWS API Documentation **Request Syntax** response = client.update_cluster_version( name='string', version='string', clientRequestToken='string', force=True|False ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the Amazon EKS cluster to update. * **version** (*string*) -- **[REQUIRED]** The desired Kubernetes version following a successful update. * **clientRequestToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. * **force** (*boolean*) -- Set this value to "true" to override upgrade-blocking readiness checks when updating a cluster. Return type: dict Returns: **Response Syntax** { 'update': { 'id': 'string', 'status': 'InProgress'|'Failed'|'Cancelled'|'Successful', 'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate'|'AccessConfigUpdate'|'UpgradePolicyUpdate'|'ZonalShiftConfigUpdate'|'AutoModeUpdate'|'RemoteNetworkConfigUpdate'|'DeletionProtectionUpdate', 'params': [ { 'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'TaintsToAdd'|'TaintsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'LaunchTemplateName'|'LaunchTemplateVersion'|'IdentityProviderConfig'|'EncryptionConfig'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts'|'MaxUnavailable'|'MaxUnavailablePercentage'|'NodeRepairEnabled'|'UpdateStrategy'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig'|'ComputeConfig'|'StorageConfig'|'KubernetesNetworkConfig'|'RemoteNetworkConfig'|'DeletionProtection', 'value': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'errors': [ { 'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound', 'errorMessage': 'string', 'resourceIds': [ 'string', ] }, ] } } **Response Structure** * *(dict) --* * **update** *(dict) --* The full description of the specified update * **id** *(string) --* A UUID that is used to track the update. * **status** *(string) --* The current status of the update. * **type** *(string) --* The type of the update. * **params** *(list) --* A key-value map that contains the parameters associated with the update. * *(dict) --* An object representing the details of an update request. * **type** *(string) --* The keys associated with an update request. * **value** *(string) --* The value of the keys submitted as part of an update request. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **errors** *(list) --* Any errors associated with a "Failed" update. * *(dict) --* An object representing an error when an asynchronous operation fails. * **errorCode** *(string) --* A brief description of the error. * **SubnetNotFound**: We couldn't find one of the subnets associated with the cluster. * **SecurityGroupNotFound**: We couldn't find one of the security groups associated with the cluster. * **EniLimitReached**: You have reached the elastic network interface limit for your account. * **IpNotAvailable**: A subnet associated with the cluster doesn't have any available IP addresses. * **AccessDenied**: You don't have permissions to perform the specified operation. * **OperationNotPermitted**: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS. * **VpcIdNotFound**: We couldn't find the VPC associated with the cluster. * **errorMessage** *(string) --* A more complete description of the error. * **resourceIds** *(list) --* An optional field that contains the resource IDs associated with the error. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ThrottlingException" * "EKS.Client.exceptions.InvalidStateException" EKS / Client / register_cluster register_cluster **************** EKS.Client.register_cluster(**kwargs) Connects a Kubernetes cluster to the Amazon EKS control plane. Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes. Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to the Amazon EKS control plane. Second, a Manifest containing the "activationID" and "activationCode" must be applied to the Kubernetes cluster through it's native provider to provide visibility. After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using "DeregisterCluster". See also: AWS API Documentation **Request Syntax** response = client.register_cluster( name='string', connectorConfig={ 'roleArn': 'string', 'provider': 'EKS_ANYWHERE'|'ANTHOS'|'GKE'|'AKS'|'OPENSHIFT'|'TANZU'|'RANCHER'|'EC2'|'OTHER' }, clientRequestToken='string', tags={ 'string': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** A unique name for this cluster in your Amazon Web Services Region. * **connectorConfig** (*dict*) -- **[REQUIRED]** The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane. * **roleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the role that is authorized to request the connector configuration. * **provider** *(string) --* **[REQUIRED]** The cloud provider for the target cluster to connect. * **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). 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', 'elasticLoadBalancing': { 'enabled': True|False } }, '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' }, 'upgradePolicy': { 'supportType': 'STANDARD'|'EXTENDED' }, 'zonalShiftConfig': { 'enabled': True|False }, 'remoteNetworkConfig': { 'remoteNodeNetworks': [ { 'cidrs': [ 'string', ] }, ], 'remotePodNetworks': [ { 'cidrs': [ 'string', ] }, ] }, 'computeConfig': { 'enabled': True|False, 'nodePools': [ 'string', ], 'nodeRoleArn': 'string' }, 'storageConfig': { 'blockStorage': { 'enabled': True|False } }, 'deletionProtection': True|False } } **Response Structure** * *(dict) --* * **cluster** *(dict) --* An object representing an Amazon EKS 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 Cluster API server endpoint 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" and additionally "::/0" for dual- stack *IPv6* clusters. 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 Cluster API server endpoint in the *Amazon EKS User Guide* . Note that the public endpoints are dual-stack for only "IPv6" clusters that are made after October 2024. You can't add "IPv6" CIDR blocks to "IPv4" clusters or "IPv6" clusters that were made before October 2024. * *(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. * **elasticLoadBalancing** *(dict) --* Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. * **enabled** *(boolean) --* Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account. * **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 Amazon EKS cluster. * **issues** *(list) --* An object representing the health issues of your Amazon EKS cluster. * *(dict) --* An issue with your Amazon EKS cluster. * **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. * **upgradePolicy** *(dict) --* This value indicates if extended support is enabled or disabled for the cluster. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **supportType** *(string) --* If the cluster is set to "EXTENDED", it will enter extended support at the end of standard support. If the cluster is set to "STANDARD", it will be automatically upgraded at the end of standard support. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **zonalShiftConfig** *(dict) --* The configuration for zonal shift for the cluster. * **enabled** *(boolean) --* Whether the zonal shift is enabled. * **remoteNetworkConfig** *(dict) --* The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. * **remoteNodeNetworks** *(list) --* The list of network CIDRs that can contain hybrid nodes. * *(dict) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * **cidrs** *(list) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * *(string) --* * **remotePodNetworks** *(list) --* The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes. * *(dict) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on- premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * **cidrs** *(list) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * *(string) --* * **computeConfig** *(dict) --* Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the *Amazon EKS User Guide*. * **enabled** *(boolean) --* Indicates if the compute capability is enabled on 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. * **nodePools** *(list) --* Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the *Amazon EKS User Guide*. * *(string) --* * **nodeRoleArn** *(string) --* The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. * **storageConfig** *(dict) --* Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the *Amazon EKS User Guide*. * **blockStorage** *(dict) --* Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. * **enabled** *(boolean) --* Indicates if the block storage capability is enabled on 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. * **deletionProtection** *(boolean) --* The current deletion protection setting for the cluster. When "true", deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When "false", the cluster can be deleted normally. This setting only applies to clusters in an active state. **Exceptions** * "EKS.Client.exceptions.ResourceLimitExceededException" * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" * "EKS.Client.exceptions.AccessDeniedException" * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourcePropagationDelayException" EKS / Client / create_fargate_profile create_fargate_profile ********************** EKS.Client.create_fargate_profile(**kwargs) Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate. The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile's selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate. When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the "kubelet" that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the *Amazon EKS User Guide*. Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating. If any Fargate profiles in a cluster are in the "DELETING" status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster. For more information, see Fargate profile in the *Amazon EKS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_fargate_profile( fargateProfileName='string', clusterName='string', podExecutionRoleArn='string', subnets=[ 'string', ], selectors=[ { 'namespace': 'string', 'labels': { 'string': 'string' } }, ], clientRequestToken='string', tags={ 'string': 'string' } ) Parameters: * **fargateProfileName** (*string*) -- **[REQUIRED]** The name of the Fargate profile. * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **podExecutionRoleArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "Pod" execution role to use for a "Pod" that matches the selectors in the Fargate profile. The "Pod" execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see Pod execution role in the *Amazon EKS User Guide*. * **subnets** (*list*) -- The IDs of subnets to launch a "Pod" into. A "Pod" running on Fargate isn't assigned a public IP address, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter. * *(string) --* * **selectors** (*list*) -- The selectors to match for a "Pod" to use this Fargate profile. Each selector must have an associated Kubernetes "namespace". Optionally, you can also specify "labels" for a "namespace". You may specify up to five selectors in a Fargate profile. * *(dict) --* An object representing an Fargate profile selector. * **namespace** *(string) --* The Kubernetes "namespace" that the selector should match. * **labels** *(dict) --* The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match. * *(string) --* * *(string) --* * **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). Return type: dict Returns: **Response Syntax** { 'fargateProfile': { 'fargateProfileName': 'string', 'fargateProfileArn': 'string', 'clusterName': 'string', 'createdAt': datetime(2015, 1, 1), 'podExecutionRoleArn': 'string', 'subnets': [ 'string', ], 'selectors': [ { 'namespace': 'string', 'labels': { 'string': 'string' } }, ], 'status': 'CREATING'|'ACTIVE'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED', 'tags': { 'string': 'string' }, 'health': { 'issues': [ { 'code': 'PodExecutionRoleAlreadyInUse'|'AccessDenied'|'ClusterUnreachable'|'InternalFailure', 'message': 'string', 'resourceIds': [ 'string', ] }, ] } } } **Response Structure** * *(dict) --* * **fargateProfile** *(dict) --* The full description of your new Fargate profile. * **fargateProfileName** *(string) --* The name of the Fargate profile. * **fargateProfileArn** *(string) --* The full Amazon Resource Name (ARN) of the Fargate profile. * **clusterName** *(string) --* The name of your cluster. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **podExecutionRoleArn** *(string) --* The Amazon Resource Name (ARN) of the "Pod" execution role to use for any "Pod" that matches the selectors in the Fargate profile. For more information, see Pod execution role in the *Amazon EKS User Guide*. * **subnets** *(list) --* The IDs of subnets to launch a "Pod" into. * *(string) --* * **selectors** *(list) --* The selectors to match for a "Pod" to use this Fargate profile. * *(dict) --* An object representing an Fargate profile selector. * **namespace** *(string) --* The Kubernetes "namespace" that the selector should match. * **labels** *(dict) --* The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match. * *(string) --* * *(string) --* * **status** *(string) --* The current status of the Fargate profile. * **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). * **health** *(dict) --* The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here. * **issues** *(list) --* Any issues that are associated with the Fargate profile. * *(dict) --* An issue that is associated with the Fargate profile. * **code** *(string) --* A brief description of the error. * **message** *(string) --* The error message associated with the issue. * **resourceIds** *(list) --* The Amazon Web Services resources that are affected by this issue. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceLimitExceededException" * "EKS.Client.exceptions.UnsupportedAvailabilityZoneException" EKS / Client / update_access_entry update_access_entry ******************* EKS.Client.update_access_entry(**kwargs) Updates an access entry. See also: AWS API Documentation **Request Syntax** response = client.update_access_entry( clusterName='string', principalArn='string', kubernetesGroups=[ 'string', ], clientRequestToken='string', username='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **principalArn** (*string*) -- **[REQUIRED]** The ARN of the IAM principal for the "AccessEntry". * **kubernetesGroups** (*list*) -- The value for "name" that you've specified for "kind: Group" as a "subject" in a Kubernetes "RoleBinding" or "ClusterRoleBinding" object. Amazon EKS doesn't confirm that the value for "name" exists in any bindings on your cluster. You can specify one or more names. Kubernetes authorizes the "principalArn" of the access entry to access any cluster objects that you've specified in a Kubernetes "Role" or "ClusterRole" object that is also specified in a binding's "roleRef". For more information about creating Kubernetes "RoleBinding", "ClusterRoleBinding", "Role", or "ClusterRole" objects, see Using RBAC Authorization in the Kubernetes documentation. If you want Amazon EKS to authorize the "principalArn" (instead of, or in addition to Kubernetes authorizing the "principalArn"), you can associate one or more access policies to the access entry using "AssociateAccessPolicy". If you associate any access policies, the "principalARN" has all permissions assigned in the associated access policies and all permissions in any Kubernetes "Role" or "ClusterRole" objects that the group names are bound to. * *(string) --* * **clientRequestToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. * **username** (*string*) -- The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see Creating access entries in the *Amazon EKS User Guide*. Return type: dict Returns: **Response Syntax** { 'accessEntry': { 'clusterName': 'string', 'principalArn': 'string', 'kubernetesGroups': [ 'string', ], 'accessEntryArn': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'username': 'string', 'type': 'string' } } **Response Structure** * *(dict) --* * **accessEntry** *(dict) --* The ARN of the IAM principal for the "AccessEntry". * **clusterName** *(string) --* The name of your cluster. * **principalArn** *(string) --* The ARN of the IAM principal for the access entry. If you ever delete the IAM principal with this ARN, the access entry isn't automatically deleted. We recommend that you delete the access entry with an ARN for an IAM principal that you delete. If you don't delete the access entry and ever recreate the IAM principal, even if it has the same ARN, the access entry won't work. This is because even though the ARN is the same for the recreated IAM principal, the "roleID" or "userID" (you can see this with the Security Token Service "GetCallerIdentity" API) is different for the recreated IAM principal than it was for the original IAM principal. Even though you don't see the IAM principal's "roleID" or "userID" for an access entry, Amazon EKS stores it with the access entry. * **kubernetesGroups** *(list) --* A "name" that you've specified in a Kubernetes "RoleBinding" or "ClusterRoleBinding" object so that Kubernetes authorizes the "principalARN" access to cluster objects. * *(string) --* * **accessEntryArn** *(string) --* The ARN of the access entry. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **modifiedAt** *(datetime) --* The Unix epoch timestamp for the last modification to the object. * **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). * **username** *(string) --* The "name" of a user that can authenticate to your cluster. * **type** *(string) --* The type of the access entry. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" EKS / Client / list_identity_provider_configs list_identity_provider_configs ****************************** EKS.Client.list_identity_provider_configs(**kwargs) Lists the identity provider configurations for your cluster. See also: AWS API Documentation **Request Syntax** response = client.list_identity_provider_configs( clusterName='string', maxResults=123, nextToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **maxResults** (*integer*) -- The maximum number of results, returned in paginated output. You receive "maxResults" in a single page, along with a "nextToken" response element. You can see the remaining results of the initial request by sending another request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a "nextToken" value, if applicable, are returned. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. Return type: dict Returns: **Response Syntax** { 'identityProviderConfigs': [ { 'type': 'string', 'name': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **identityProviderConfigs** *(list) --* The identity provider configurations for the cluster. * *(dict) --* An object representing an identity provider configuration. * **type** *(string) --* The type of the identity provider configuration. The only type available is "oidc". * **name** *(string) --* The name of the identity provider configuration. * **nextToken** *(string) --* The "nextToken" value to include in a future "ListIdentityProviderConfigsResponse" request. When the results of a "ListIdentityProviderConfigsResponse" request exceed "maxResults", you can use this value to retrieve the next page of results. This value is "null" when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" * "EKS.Client.exceptions.ResourceNotFoundException" EKS / Client / disassociate_access_policy disassociate_access_policy ************************** EKS.Client.disassociate_access_policy(**kwargs) Disassociates an access policy from an access entry. See also: AWS API Documentation **Request Syntax** response = client.disassociate_access_policy( clusterName='string', principalArn='string', policyArn='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **principalArn** (*string*) -- **[REQUIRED]** The ARN of the IAM principal for the "AccessEntry". * **policyArn** (*string*) -- **[REQUIRED]** The ARN of the policy to disassociate from the access entry. For a list of associated policies ARNs, use "ListAssociatedAccessPolicies". Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" EKS / Client / tag_resource tag_resource ************ EKS.Client.tag_resource(**kwargs) Associates the specified tags to an Amazon EKS resource with the specified "resourceArn". If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag doesn't automatically propagate to the subnets and nodes associated with the cluster. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to add tags to. * **tags** (*dict*) -- **[REQUIRED]** 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). Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "EKS.Client.exceptions.BadRequestException" * "EKS.Client.exceptions.NotFoundException" EKS / Client / update_addon update_addon ************ EKS.Client.update_addon(**kwargs) Updates an Amazon EKS add-on. See also: AWS API Documentation **Request Syntax** response = client.update_addon( clusterName='string', addonName='string', addonVersion='string', serviceAccountRoleArn='string', resolveConflicts='OVERWRITE'|'NONE'|'PRESERVE', clientRequestToken='string', configurationValues='string', podIdentityAssociations=[ { 'serviceAccount': 'string', 'roleArn': 'string' }, ] ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **addonName** (*string*) -- **[REQUIRED]** The name of the add-on. The name must match one of the names returned by ListAddons. * **addonVersion** (*string*) -- The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions. * **serviceAccountRoleArn** (*string*) -- The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the *Amazon EKS User Guide*. Note: To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the *Amazon EKS User Guide*. * **resolveConflicts** (*string*) -- How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Conflicts are handled based on the option you choose: * **None** – Amazon EKS doesn't change the value. The update might fail. * **Overwrite** – Amazon EKS overwrites the changed value back to the Amazon EKS default value. * **Preserve** – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add- on on your production cluster. * **clientRequestToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. * **configurationValues** (*string*) -- The set of configuration values for the add-on that's created. The values that you provide are validated against the schema returned by "DescribeAddonConfiguration". * **podIdentityAssociations** (*list*) -- An array of EKS Pod Identity associations to be updated. Each association maps a Kubernetes service account to an IAM role. If this value is left blank, no change. If an empty array is provided, existing associations owned by the add-on are deleted. For more information, see Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity in the *Amazon EKS User Guide*. * *(dict) --* A type of EKS Pod Identity association owned by an Amazon EKS add-on. Each association maps a role to a service account in a namespace in the cluster. For more information, see Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity in the *Amazon EKS User Guide*. * **serviceAccount** *(string) --* **[REQUIRED]** The name of a Kubernetes Service Account. * **roleArn** *(string) --* **[REQUIRED]** The ARN of an IAM Role. Return type: dict Returns: **Response Syntax** { 'update': { 'id': 'string', 'status': 'InProgress'|'Failed'|'Cancelled'|'Successful', 'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate'|'AccessConfigUpdate'|'UpgradePolicyUpdate'|'ZonalShiftConfigUpdate'|'AutoModeUpdate'|'RemoteNetworkConfigUpdate'|'DeletionProtectionUpdate', 'params': [ { 'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'TaintsToAdd'|'TaintsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'LaunchTemplateName'|'LaunchTemplateVersion'|'IdentityProviderConfig'|'EncryptionConfig'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts'|'MaxUnavailable'|'MaxUnavailablePercentage'|'NodeRepairEnabled'|'UpdateStrategy'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig'|'ComputeConfig'|'StorageConfig'|'KubernetesNetworkConfig'|'RemoteNetworkConfig'|'DeletionProtection', 'value': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'errors': [ { 'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound', 'errorMessage': 'string', 'resourceIds': [ 'string', ] }, ] } } **Response Structure** * *(dict) --* * **update** *(dict) --* An object representing an asynchronous update. * **id** *(string) --* A UUID that is used to track the update. * **status** *(string) --* The current status of the update. * **type** *(string) --* The type of the update. * **params** *(list) --* A key-value map that contains the parameters associated with the update. * *(dict) --* An object representing the details of an update request. * **type** *(string) --* The keys associated with an update request. * **value** *(string) --* The value of the keys submitted as part of an update request. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **errors** *(list) --* Any errors associated with a "Failed" update. * *(dict) --* An object representing an error when an asynchronous operation fails. * **errorCode** *(string) --* A brief description of the error. * **SubnetNotFound**: We couldn't find one of the subnets associated with the cluster. * **SecurityGroupNotFound**: We couldn't find one of the security groups associated with the cluster. * **EniLimitReached**: You have reached the elastic network interface limit for your account. * **IpNotAvailable**: A subnet associated with the cluster doesn't have any available IP addresses. * **AccessDenied**: You don't have permissions to perform the specified operation. * **OperationNotPermitted**: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS. * **VpcIdNotFound**: We couldn't find the VPC associated with the cluster. * **errorMessage** *(string) --* A more complete description of the error. * **resourceIds** *(list) --* An optional field that contains the resource IDs associated with the error. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" EKS / Client / list_access_entries list_access_entries ******************* EKS.Client.list_access_entries(**kwargs) Lists the access entries for your cluster. See also: AWS API Documentation **Request Syntax** response = client.list_access_entries( clusterName='string', associatedPolicyArn='string', maxResults=123, nextToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **associatedPolicyArn** (*string*) -- The ARN of an "AccessPolicy". When you specify an access policy ARN, only the access entries associated to that access policy are returned. For a list of available policy ARNs, use "ListAccessPolicies". * **maxResults** (*integer*) -- The maximum number of results, returned in paginated output. You receive "maxResults" in a single page, along with a "nextToken" response element. You can see the remaining results of the initial request by sending another request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a "nextToken" value, if applicable, are returned. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. Return type: dict Returns: **Response Syntax** { 'accessEntries': [ 'string', ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **accessEntries** *(list) --* The list of access entries that exist for the cluster. * *(string) --* * **nextToken** *(string) --* The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" EKS / Client / describe_cluster describe_cluster **************** EKS.Client.describe_cluster(**kwargs) Describes an Amazon EKS cluster. The API server endpoint and certificate authority data returned by this operation are required for "kubelet" and "kubectl" to communicate with your Kubernetes API server. For more information, see Creating or updating a kubeconfig file for an Amazon EKS cluster. Note: The API server endpoint and certificate authority data aren't available until the cluster reaches the "ACTIVE" state. See also: AWS API Documentation **Request Syntax** response = client.describe_cluster( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name of your cluster. 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', 'elasticLoadBalancing': { 'enabled': True|False } }, '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' }, 'upgradePolicy': { 'supportType': 'STANDARD'|'EXTENDED' }, 'zonalShiftConfig': { 'enabled': True|False }, 'remoteNetworkConfig': { 'remoteNodeNetworks': [ { 'cidrs': [ 'string', ] }, ], 'remotePodNetworks': [ { 'cidrs': [ 'string', ] }, ] }, 'computeConfig': { 'enabled': True|False, 'nodePools': [ 'string', ], 'nodeRoleArn': 'string' }, 'storageConfig': { 'blockStorage': { 'enabled': True|False } }, 'deletionProtection': True|False } } **Response Structure** * *(dict) --* * **cluster** *(dict) --* The full description of your specified 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 Cluster API server endpoint 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" and additionally "::/0" for dual- stack *IPv6* clusters. 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 Cluster API server endpoint in the *Amazon EKS User Guide* . Note that the public endpoints are dual-stack for only "IPv6" clusters that are made after October 2024. You can't add "IPv6" CIDR blocks to "IPv4" clusters or "IPv6" clusters that were made before October 2024. * *(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. * **elasticLoadBalancing** *(dict) --* Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. * **enabled** *(boolean) --* Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account. * **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 Amazon EKS cluster. * **issues** *(list) --* An object representing the health issues of your Amazon EKS cluster. * *(dict) --* An issue with your Amazon EKS cluster. * **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. * **upgradePolicy** *(dict) --* This value indicates if extended support is enabled or disabled for the cluster. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **supportType** *(string) --* If the cluster is set to "EXTENDED", it will enter extended support at the end of standard support. If the cluster is set to "STANDARD", it will be automatically upgraded at the end of standard support. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **zonalShiftConfig** *(dict) --* The configuration for zonal shift for the cluster. * **enabled** *(boolean) --* Whether the zonal shift is enabled. * **remoteNetworkConfig** *(dict) --* The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. * **remoteNodeNetworks** *(list) --* The list of network CIDRs that can contain hybrid nodes. * *(dict) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * **cidrs** *(list) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * *(string) --* * **remotePodNetworks** *(list) --* The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes. * *(dict) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on- premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * **cidrs** *(list) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * *(string) --* * **computeConfig** *(dict) --* Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the *Amazon EKS User Guide*. * **enabled** *(boolean) --* Indicates if the compute capability is enabled on 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. * **nodePools** *(list) --* Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the *Amazon EKS User Guide*. * *(string) --* * **nodeRoleArn** *(string) --* The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. * **storageConfig** *(dict) --* Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the *Amazon EKS User Guide*. * **blockStorage** *(dict) --* Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. * **enabled** *(boolean) --* Indicates if the block storage capability is enabled on 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. * **deletionProtection** *(boolean) --* The current deletion protection setting for the cluster. When "true", deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When "false", the cluster can be deleted normally. This setting only applies to clusters in an active state. **Exceptions** * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" **Examples** This example command provides a description of the specified cluster in your default region. response = client.describe_cluster( name='devel', ) print(response) Expected Output: { 'cluster': { 'version': '1.10', 'name': 'devel', 'arn': 'arn:aws:eks:us-west-2:012345678910:cluster/devel', 'certificateAuthority': { 'data': 'LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=', }, 'createdAt': 1527807879.988, 'endpoint': 'https://A0DCCD80A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com', 'resourcesVpcConfig': { 'securityGroupIds': [ 'sg-6979fe18', ], 'subnetIds': [ 'subnet-6782e71e', 'subnet-e7e761ac', ], 'vpcId': 'vpc-950809ec', }, 'roleArn': 'arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI', 'status': 'ACTIVE', }, 'ResponseMetadata': { '...': '...', }, } EKS / Client / create_eks_anywhere_subscription create_eks_anywhere_subscription ******************************** EKS.Client.create_eks_anywhere_subscription(**kwargs) Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages. See also: AWS API Documentation **Request Syntax** response = client.create_eks_anywhere_subscription( name='string', term={ 'duration': 123, 'unit': 'MONTHS' }, licenseQuantity=123, licenseType='Cluster', autoRenew=True|False, clientRequestToken='string', tags={ 'string': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The unique name for your subscription. It must be unique in your Amazon Web Services account in the Amazon Web Services Region you're creating the subscription in. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphabetic character and can't be longer than 100 characters. * **term** (*dict*) -- **[REQUIRED]** An object representing the term duration and term unit type of your subscription. This determines the term length of your subscription. Valid values are MONTHS for term unit and 12 or 36 for term duration, indicating a 12 month or 36 month subscription. This value cannot be changed after creating the subscription. * **duration** *(integer) --* The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription. * **unit** *(string) --* The term unit of the subscription. Valid value is "MONTHS". * **licenseQuantity** (*integer*) -- The number of licenses to purchase with the subscription. Valid values are between 1 and 100. This value can't be changed after creating the subscription. * **licenseType** (*string*) -- The license type for all licenses in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster. * **autoRenew** (*boolean*) -- A boolean indicating whether the subscription auto renews at the end of the term. * **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*) -- The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags don't propagate to any other resources associated with the subscription. * *(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). Return type: dict Returns: **Response Syntax** { 'subscription': { 'id': 'string', 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'effectiveDate': datetime(2015, 1, 1), 'expirationDate': datetime(2015, 1, 1), 'licenseQuantity': 123, 'licenseType': 'Cluster', 'term': { 'duration': 123, 'unit': 'MONTHS' }, 'status': 'string', 'autoRenew': True|False, 'licenseArns': [ 'string', ], 'licenses': [ { 'id': 'string', 'token': 'string' }, ], 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **subscription** *(dict) --* The full description of the subscription. * **id** *(string) --* UUID identifying a subscription. * **arn** *(string) --* The Amazon Resource Name (ARN) for the subscription. * **createdAt** *(datetime) --* The Unix timestamp in seconds for when the subscription was created. * **effectiveDate** *(datetime) --* The Unix timestamp in seconds for when the subscription is effective. * **expirationDate** *(datetime) --* The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object. * **licenseQuantity** *(integer) --* The number of licenses included in a subscription. Valid values are between 1 and 100. * **licenseType** *(string) --* The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster. * **term** *(dict) --* An EksAnywhereSubscriptionTerm object. * **duration** *(integer) --* The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription. * **unit** *(string) --* The term unit of the subscription. Valid value is "MONTHS". * **status** *(string) --* The status of a subscription. * **autoRenew** *(boolean) --* A boolean indicating whether or not a subscription will auto renew when it expires. * **licenseArns** *(list) --* Amazon Web Services License Manager ARN associated with the subscription. * *(string) --* * **licenses** *(list) --* Includes all of the claims in the license token necessary to validate the license for extended support. * *(dict) --* An EKS Anywhere license associated with a subscription. * **id** *(string) --* An id associated with an EKS Anywhere subscription license. * **token** *(string) --* An optional license token that can be used for extended support verification. * **tags** *(dict) --* The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription. * *(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). **Exceptions** * "EKS.Client.exceptions.ResourceLimitExceededException" * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" EKS / Client / list_insights list_insights ************* EKS.Client.list_insights(**kwargs) Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. The default filter lists all categories and every status. The following lists the available categories: * "UPGRADE_READINESS": Amazon EKS identifies issues that could impact your ability to upgrade to new versions of Kubernetes. These are called upgrade insights. * "MISCONFIGURATION": Amazon EKS identifies misconfiguration in your EKS Hybrid Nodes setup that could impair functionality of your cluster or workloads. These are called configuration insights. See also: AWS API Documentation **Request Syntax** response = client.list_insights( clusterName='string', filter={ 'categories': [ 'UPGRADE_READINESS'|'MISCONFIGURATION', ], 'kubernetesVersions': [ 'string', ], 'statuses': [ 'PASSING'|'WARNING'|'ERROR'|'UNKNOWN', ] }, maxResults=123, nextToken='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of the Amazon EKS cluster associated with the insights. * **filter** (*dict*) -- The criteria to filter your list of insights for your cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. * **categories** *(list) --* The categories to use to filter insights. The following lists the available categories: * "UPGRADE_READINESS": Amazon EKS identifies issues that could impact your ability to upgrade to new versions of Kubernetes. These are called upgrade insights. * "MISCONFIGURATION": Amazon EKS identifies misconfiguration in your EKS Hybrid Nodes setup that could impair functionality of your cluster or workloads. These are called configuration insights. * *(string) --* * **kubernetesVersions** *(list) --* The Kubernetes versions to use to filter the insights. * *(string) --* * **statuses** *(list) --* The statuses to use to filter the insights. * *(string) --* * **maxResults** (*integer*) -- The maximum number of identity provider configurations returned by "ListInsights" in paginated output. When you use this parameter, "ListInsights" returns only "maxResults" results in a single page along with a "nextToken" response element. You can see the remaining results of the initial request by sending another "ListInsights" request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, "ListInsights" returns up to 100 results and a "nextToken" value, if applicable. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated "ListInsights" request. When the results of a "ListInsights" request exceed "maxResults", you can use this value to retrieve the next page of results. This value is "null" when there are no more results to return. Return type: dict Returns: **Response Syntax** { 'insights': [ { 'id': 'string', 'name': 'string', 'category': 'UPGRADE_READINESS'|'MISCONFIGURATION', 'kubernetesVersion': 'string', 'lastRefreshTime': datetime(2015, 1, 1), 'lastTransitionTime': datetime(2015, 1, 1), 'description': 'string', 'insightStatus': { 'status': 'PASSING'|'WARNING'|'ERROR'|'UNKNOWN', 'reason': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **insights** *(list) --* The returned list of insights. * *(dict) --* The summarized description of the insight. * **id** *(string) --* The ID of the insight. * **name** *(string) --* The name of the insight. * **category** *(string) --* The category of the insight. * **kubernetesVersion** *(string) --* The Kubernetes minor version associated with an insight if applicable. * **lastRefreshTime** *(datetime) --* The time Amazon EKS last successfully completed a refresh of this insight check on the cluster. * **lastTransitionTime** *(datetime) --* The time the status of the insight last changed. * **description** *(string) --* The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown). * **insightStatus** *(dict) --* An object containing more detail on the status of the insight. * **status** *(string) --* The status of the resource. * **reason** *(string) --* Explanation on the reasoning for the status of the resource. * **nextToken** *(string) --* The "nextToken" value to include in a future "ListInsights" request. When the results of a "ListInsights" request exceed "maxResults", you can use this value to retrieve the next page of results. This value is "null" when there are no more results to return. **Exceptions** * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.InvalidParameterException" EKS / Client / update_cluster_config update_cluster_config ********************* EKS.Client.update_cluster_config(**kwargs) Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with "DescribeUpdate". You can use this operation to do the following actions: * You can use this API operation 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. * You can also use this API operation 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 Cluster API server endpoint in the *Amazon EKS User Guide* . * You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https://docs.aw s.amazon.com/eks/latest/userguide/network_reqs.html in the *Amazon EKS User Guide* . * You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster. * You can also use this API operation to add, change, or remove the configuration in the cluster for EKS Hybrid Nodes. To remove the configuration, use the "remoteNetworkConfig" key with an object containing both subkeys with empty arrays for each. Here is an inline example: ""remoteNetworkConfig": { "remoteNodeNetworks": [], "remotePodNetworks": [] }". Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to "UPDATING" (this status transition is eventually consistent). When the update is complete (either "Failed" or "Successful"), the cluster status moves to "Active". See also: AWS API Documentation **Request Syntax** response = client.update_cluster_config( name='string', resourcesVpcConfig={ 'subnetIds': [ 'string', ], 'securityGroupIds': [ 'string', ], 'endpointPublicAccess': True|False, 'endpointPrivateAccess': True|False, 'publicAccessCidrs': [ 'string', ] }, logging={ 'clusterLogging': [ { 'types': [ 'api'|'audit'|'authenticator'|'controllerManager'|'scheduler', ], 'enabled': True|False }, ] }, clientRequestToken='string', accessConfig={ 'authenticationMode': 'API'|'API_AND_CONFIG_MAP'|'CONFIG_MAP' }, upgradePolicy={ 'supportType': 'STANDARD'|'EXTENDED' }, zonalShiftConfig={ 'enabled': True|False }, computeConfig={ 'enabled': True|False, 'nodePools': [ 'string', ], 'nodeRoleArn': 'string' }, kubernetesNetworkConfig={ 'serviceIpv4Cidr': 'string', 'ipFamily': 'ipv4'|'ipv6', 'elasticLoadBalancing': { 'enabled': True|False } }, storageConfig={ 'blockStorage': { 'enabled': True|False } }, remoteNetworkConfig={ 'remoteNodeNetworks': [ { 'cidrs': [ 'string', ] }, ], 'remotePodNetworks': [ { 'cidrs': [ 'string', ] }, ] }, deletionProtection=True|False ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the Amazon EKS cluster to update. * **resourcesVpcConfig** (*dict*) -- An object representing the VPC configuration to use for an Amazon EKS cluster. * **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. The endpoint domain name and IP address family depends on the value of the "ipFamily" for the cluster. For more information, see Cluster API server endpoint 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 Cluster API server endpoint 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" and additionally "::/0" for dual-stack *IPv6* clusters. 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 Cluster API server endpoint in the *Amazon EKS User Guide* . Note that the public endpoints are dual-stack for only "IPv6" clusters that are made after October 2024. You can't add "IPv6" CIDR blocks to "IPv4" clusters or "IPv6" clusters that were made before October 2024. * *(string) --* * **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. * **accessConfig** (*dict*) -- The access configuration for the cluster. * **authenticationMode** *(string) --* The desired authentication mode for the cluster. * **upgradePolicy** (*dict*) -- You can enable or disable extended support for clusters currently on standard support. You cannot disable extended support once it starts. You must enable extended support before your cluster exits standard support. * **supportType** *(string) --* If the cluster is set to "EXTENDED", it will enter extended support at the end of standard support. If the cluster is set to "STANDARD", it will be automatically upgraded at the end of standard support. Learn more about EKS Extended Support in the Amazon EKS User Guide. * **zonalShiftConfig** (*dict*) -- Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster. 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. You can start a zonal shift for an EKS cluster, or you can allow Amazon Web Services to do it for you by enabling *zonal autoshift*. 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 EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS in the *Amazon EKS User Guide* . * **enabled** *(boolean) --* If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster. * **computeConfig** (*dict*) -- Update the configuration of the compute capability of your EKS Auto Mode cluster. For example, enable the capability. * **enabled** *(boolean) --* Request to enable or disable the compute capability on 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. * **nodePools** *(list) --* Configuration for node pools that defines the compute resources for your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the *Amazon EKS User Guide*. * *(string) --* * **nodeRoleArn** *(string) --* The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. This value cannot be changed after the compute capability of EKS Auto Mode is enabled. For more information, see the IAM Reference in the *Amazon EKS User Guide*. * **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. * **elasticLoadBalancing** *(dict) --* Request to enable or disable the load balancing capability on your EKS Auto Mode cluster. For more information, see EKS Auto Mode load balancing capability in the *Amazon EKS User Guide*. * **enabled** *(boolean) --* Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account. * **storageConfig** (*dict*) -- Update the configuration of the block storage capability of your EKS Auto Mode cluster. For example, enable the capability. * **blockStorage** *(dict) --* Request to configure EBS Block Storage settings for your EKS Auto Mode cluster. * **enabled** *(boolean) --* Indicates if the block storage capability is enabled on 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. * **remoteNetworkConfig** (*dict*) -- The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. * **remoteNodeNetworks** *(list) --* The list of network CIDRs that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * *(dict) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * **cidrs** *(list) --* A network CIDR that can contain hybrid nodes. These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to- Site VPN, or Direct Connect. * Each host must allow outbound connection to the EKS cluster control plane on TCP ports "443" and "10250". * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. * Each host must allow TCP and UDP network connectivity to and from other hosts that are running "CoreDNS" on UDP port "53" for service and pod DNS names. * *(string) --* * **remotePodNetworks** *(list) --* The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * *(dict) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * **cidrs** *(list) --* A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on- premises and edge locations. Enter one or more IPv4 CIDR blocks in decimal dotted- quad notation (for example, "10.2.0.0/16"). It must satisfy the following requirements: * Each block must be within an "IPv4" RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported. * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. * *(string) --* * **deletionProtection** (*boolean*) -- Specifies whether to enable or disable deletion protection for the cluster. When enabled ( "true"), the cluster cannot be deleted until deletion protection is explicitly disabled. When disabled ( "false"), the cluster can be deleted normally. Return type: dict Returns: **Response Syntax** { 'update': { 'id': 'string', 'status': 'InProgress'|'Failed'|'Cancelled'|'Successful', 'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate'|'AccessConfigUpdate'|'UpgradePolicyUpdate'|'ZonalShiftConfigUpdate'|'AutoModeUpdate'|'RemoteNetworkConfigUpdate'|'DeletionProtectionUpdate', 'params': [ { 'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'TaintsToAdd'|'TaintsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'LaunchTemplateName'|'LaunchTemplateVersion'|'IdentityProviderConfig'|'EncryptionConfig'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts'|'MaxUnavailable'|'MaxUnavailablePercentage'|'NodeRepairEnabled'|'UpdateStrategy'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig'|'ComputeConfig'|'StorageConfig'|'KubernetesNetworkConfig'|'RemoteNetworkConfig'|'DeletionProtection', 'value': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'errors': [ { 'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound', 'errorMessage': 'string', 'resourceIds': [ 'string', ] }, ] } } **Response Structure** * *(dict) --* * **update** *(dict) --* An object representing an asynchronous update. * **id** *(string) --* A UUID that is used to track the update. * **status** *(string) --* The current status of the update. * **type** *(string) --* The type of the update. * **params** *(list) --* A key-value map that contains the parameters associated with the update. * *(dict) --* An object representing the details of an update request. * **type** *(string) --* The keys associated with an update request. * **value** *(string) --* The value of the keys submitted as part of an update request. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **errors** *(list) --* Any errors associated with a "Failed" update. * *(dict) --* An object representing an error when an asynchronous operation fails. * **errorCode** *(string) --* A brief description of the error. * **SubnetNotFound**: We couldn't find one of the subnets associated with the cluster. * **SecurityGroupNotFound**: We couldn't find one of the security groups associated with the cluster. * **EniLimitReached**: You have reached the elastic network interface limit for your account. * **IpNotAvailable**: A subnet associated with the cluster doesn't have any available IP addresses. * **AccessDenied**: You don't have permissions to perform the specified operation. * **OperationNotPermitted**: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS. * **VpcIdNotFound**: We couldn't find the VPC associated with the cluster. * **errorMessage** *(string) --* A more complete description of the error. * **resourceIds** *(list) --* An optional field that contains the resource IDs associated with the error. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceInUseException" * "EKS.Client.exceptions.ResourceNotFoundException" * "EKS.Client.exceptions.InvalidRequestException" * "EKS.Client.exceptions.ThrottlingException" EKS / Client / delete_fargate_profile delete_fargate_profile ********************** EKS.Client.delete_fargate_profile(**kwargs) Deletes an Fargate profile. When you delete a Fargate profile, any "Pod" running on Fargate that was created with the profile is deleted. If the "Pod" matches another Fargate profile, then it is scheduled on Fargate with that profile. If it no longer matches any Fargate profiles, then it's not scheduled on Fargate and may remain in a pending state. Only one Fargate profile in a cluster can be in the "DELETING" status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster. See also: AWS API Documentation **Request Syntax** response = client.delete_fargate_profile( clusterName='string', fargateProfileName='string' ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of your cluster. * **fargateProfileName** (*string*) -- **[REQUIRED]** The name of the Fargate profile to delete. Return type: dict Returns: **Response Syntax** { 'fargateProfile': { 'fargateProfileName': 'string', 'fargateProfileArn': 'string', 'clusterName': 'string', 'createdAt': datetime(2015, 1, 1), 'podExecutionRoleArn': 'string', 'subnets': [ 'string', ], 'selectors': [ { 'namespace': 'string', 'labels': { 'string': 'string' } }, ], 'status': 'CREATING'|'ACTIVE'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED', 'tags': { 'string': 'string' }, 'health': { 'issues': [ { 'code': 'PodExecutionRoleAlreadyInUse'|'AccessDenied'|'ClusterUnreachable'|'InternalFailure', 'message': 'string', 'resourceIds': [ 'string', ] }, ] } } } **Response Structure** * *(dict) --* * **fargateProfile** *(dict) --* The deleted Fargate profile. * **fargateProfileName** *(string) --* The name of the Fargate profile. * **fargateProfileArn** *(string) --* The full Amazon Resource Name (ARN) of the Fargate profile. * **clusterName** *(string) --* The name of your cluster. * **createdAt** *(datetime) --* The Unix epoch timestamp at object creation. * **podExecutionRoleArn** *(string) --* The Amazon Resource Name (ARN) of the "Pod" execution role to use for any "Pod" that matches the selectors in the Fargate profile. For more information, see Pod execution role in the *Amazon EKS User Guide*. * **subnets** *(list) --* The IDs of subnets to launch a "Pod" into. * *(string) --* * **selectors** *(list) --* The selectors to match for a "Pod" to use this Fargate profile. * *(dict) --* An object representing an Fargate profile selector. * **namespace** *(string) --* The Kubernetes "namespace" that the selector should match. * **labels** *(dict) --* The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match. * *(string) --* * *(string) --* * **status** *(string) --* The current status of the Fargate profile. * **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). * **health** *(dict) --* The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here. * **issues** *(list) --* Any issues that are associated with the Fargate profile. * *(dict) --* An issue that is associated with the Fargate profile. * **code** *(string) --* A brief description of the error. * **message** *(string) --* The error message associated with the issue. * **resourceIds** *(list) --* The Amazon Web Services resources that are affected by this issue. * *(string) --* **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ResourceNotFoundException" EKS / Client / list_clusters list_clusters ************* EKS.Client.list_clusters(**kwargs) Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.list_clusters( maxResults=123, nextToken='string', include=[ 'string', ] ) Parameters: * **maxResults** (*integer*) -- The maximum number of results, returned in paginated output. You receive "maxResults" in a single page, along with a "nextToken" response element. You can see the remaining results of the initial request by sending another request with the returned "nextToken" value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a "nextToken" value, if applicable, are returned. * **nextToken** (*string*) -- The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. * **include** (*list*) -- Indicates whether external clusters are included in the returned list. Use ' "all"' to return *https://docs.aws.amazon.com/eks/latest/userguide/eks- connector.html `__connected clusters, or blank to return only Amazon EKS clusters. ' ``all`*' must be in lowercase otherwise an error occurs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'clusters': [ 'string', ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **clusters** *(list) --* A list of all of the clusters for your account in the specified Amazon Web Services Region . * *(string) --* * **nextToken** *(string) --* The "nextToken" value returned from a previous paginated request, where "maxResults" was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the "nextToken" value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. **Exceptions** * "EKS.Client.exceptions.InvalidParameterException" * "EKS.Client.exceptions.ClientException" * "EKS.Client.exceptions.ServerException" * "EKS.Client.exceptions.ServiceUnavailableException" **Examples** This example command lists all of your available clusters in your default region. response = client.list_clusters( ) print(response) Expected Output: { 'clusters': [ 'devel', 'prod', ], 'ResponseMetadata': { '...': '...', }, }