SDK for PHP 3.x

Client: Aws\EKS\EKSClient
Service ID: eks
Version: 2017-11-01

This page describes the parameters and results for the operations of the Amazon Elastic Kubernetes Service (2017-11-01), and shows how to use the Aws\EKS\EKSClient object to call the described operations. This documentation is specific to the 2017-11-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateAccessPolicy ( array $params = [] )
Associates an access policy and its scope to an access entry.
AssociateEncryptionConfig ( array $params = [] )
Associates an encryption configuration to an existing cluster.
AssociateIdentityProviderConfig ( array $params = [] )
Associates an identity provider configuration to a cluster.
CreateAccessEntry ( array $params = [] )
Creates an access entry.
CreateAddon ( array $params = [] )
Creates an Amazon EKS add-on.
CreateCluster ( array $params = [] )
Creates an Amazon EKS control plane.
CreateEksAnywhereSubscription ( array $params = [] )
Creates an EKS Anywhere subscription.
CreateFargateProfile ( array $params = [] )
Creates an Fargate profile for your Amazon EKS cluster.
CreateNodegroup ( array $params = [] )
Creates a managed node group for an Amazon EKS cluster.
CreatePodIdentityAssociation ( array $params = [] )
Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity.
DeleteAccessEntry ( array $params = [] )
Deletes an access entry.
DeleteAddon ( array $params = [] )
Deletes an Amazon EKS add-on.
DeleteCluster ( array $params = [] )
Deletes an Amazon EKS cluster control plane.
DeleteEksAnywhereSubscription ( array $params = [] )
Deletes an expired or inactive subscription.
DeleteFargateProfile ( array $params = [] )
Deletes an Fargate profile.
DeleteNodegroup ( array $params = [] )
Deletes a managed node group.
DeletePodIdentityAssociation ( array $params = [] )
Deletes a EKS Pod Identity association.
DeregisterCluster ( array $params = [] )
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
DescribeAccessEntry ( array $params = [] )
Describes an access entry.
DescribeAddon ( array $params = [] )
Describes an Amazon EKS add-on.
DescribeAddonConfiguration ( array $params = [] )
Returns configuration options.
DescribeAddonVersions ( array $params = [] )
Describes the versions for an add-on.
DescribeCluster ( array $params = [] )
Describes an Amazon EKS cluster.
DescribeEksAnywhereSubscription ( array $params = [] )
Returns descriptive information about a subscription.
DescribeFargateProfile ( array $params = [] )
Describes an Fargate profile.
DescribeIdentityProviderConfig ( array $params = [] )
Describes an identity provider configuration.
DescribeInsight ( array $params = [] )
Returns details about an insight that you specify using its ID.
DescribeNodegroup ( array $params = [] )
Describes a managed node group.
DescribePodIdentityAssociation ( array $params = [] )
Returns descriptive information about an EKS Pod Identity association.
DescribeUpdate ( array $params = [] )
Describes an update to an Amazon EKS resource.
DisassociateAccessPolicy ( array $params = [] )
Disassociates an access policy from an access entry.
DisassociateIdentityProviderConfig ( array $params = [] )
Disassociates an identity provider configuration from a cluster.
ListAccessEntries ( array $params = [] )
Lists the access entries for your cluster.
ListAccessPolicies ( array $params = [] )
Lists the available access policies.
ListAddons ( array $params = [] )
Lists the installed add-ons.
ListAssociatedAccessPolicies ( array $params = [] )
Lists the access policies associated with an access entry.
ListClusters ( array $params = [] )
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.
ListEksAnywhereSubscriptions ( array $params = [] )
Displays the full description of the subscription.
ListFargateProfiles ( array $params = [] )
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.
ListIdentityProviderConfigs ( array $params = [] )
Lists the identity provider configurations for your cluster.
ListInsights ( array $params = [] )
Returns a list of all insights checked for against the specified cluster.
ListNodegroups ( array $params = [] )
Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.
ListPodIdentityAssociations ( array $params = [] )
List the EKS Pod Identity associations in a cluster.
ListTagsForResource ( array $params = [] )
List the tags for an Amazon EKS resource.
ListUpdates ( array $params = [] )
Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.
RegisterCluster ( array $params = [] )
Connects a Kubernetes cluster to the Amazon EKS control plane.
TagResource ( array $params = [] )
Associates the specified tags to an Amazon EKS resource with the specified resourceArn.
UntagResource ( array $params = [] )
Deletes specified tags from an Amazon EKS resource.
UpdateAccessEntry ( array $params = [] )
Updates an access entry.
UpdateAddon ( array $params = [] )
Updates an Amazon EKS add-on.
UpdateClusterConfig ( array $params = [] )
Updates an Amazon EKS cluster configuration.
UpdateClusterVersion ( array $params = [] )
Updates an Amazon EKS cluster to the specified Kubernetes version.
UpdateEksAnywhereSubscription ( array $params = [] )
Update an EKS Anywhere Subscription.
UpdateNodegroupConfig ( array $params = [] )
Updates an Amazon EKS managed node group configuration.
UpdateNodegroupVersion ( array $params = [] )
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
UpdatePodIdentityAssociation ( array $params = [] )
Updates a EKS Pod Identity association.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeAddonVersions
ListAccessEntries
ListAccessPolicies
ListAddons
ListAssociatedAccessPolicies
ListClusters
ListEksAnywhereSubscriptions
ListFargateProfiles
ListIdentityProviderConfigs
ListInsights
ListNodegroups
ListPodIdentityAssociations
ListUpdates

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
ClusterActive DescribeCluster 30 40
ClusterDeleted DescribeCluster 30 40
NodegroupActive DescribeNodegroup 30 80
NodegroupDeleted DescribeNodegroup 30 40
AddonActive DescribeAddon 10 60
AddonDeleted DescribeAddon 10 60
FargateProfileActive DescribeFargateProfile 10 60
FargateProfileDeleted DescribeFargateProfile 30 60

Operations

AssociateAccessPolicy

$result = $client->associateAccessPolicy([/* ... */]);
$promise = $client->associateAccessPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateAccessPolicy([
    'accessScope' => [ // REQUIRED
        'namespaces' => ['<string>', ...],
        'type' => 'cluster|namespace',
    ],
    'clusterName' => '<string>', // REQUIRED
    'policyArn' => '<string>', // REQUIRED
    'principalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
accessScope
Required: Yes
Type: AccessScope structure

The scope for the AccessPolicy. You can scope access policies to an entire cluster or to specific Kubernetes namespaces.

clusterName
Required: Yes
Type: string

The name of your cluster.

policyArn
Required: Yes
Type: string

The ARN of the AccessPolicy that you're associating. For a list of ARNs, use ListAccessPolicies.

principalArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM user or role for the AccessEntry that you're associating the access policy to.

Result Syntax

[
    'associatedAccessPolicy' => [
        'accessScope' => [
            'namespaces' => ['<string>', ...],
            'type' => 'cluster|namespace',
        ],
        'associatedAt' => <DateTime>,
        'modifiedAt' => <DateTime>,
        'policyArn' => '<string>',
    ],
    'clusterName' => '<string>',
    'principalArn' => '<string>',
]

Result Details

Members
associatedAccessPolicy
Type: AssociatedAccessPolicy structure

The AccessPolicy and scope associated to the AccessEntry.

clusterName
Type: string

The name of your cluster.

principalArn
Type: string

The ARN of the IAM principal for the AccessEntry.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

AssociateEncryptionConfig

$result = $client->associateEncryptionConfig([/* ... */]);
$promise = $client->associateEncryptionConfigAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateEncryptionConfig([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'encryptionConfig' => [ // REQUIRED
        [
            'provider' => [
                'keyArn' => '<string>',
            ],
            'resources' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Members
clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of your cluster.

encryptionConfig
Required: Yes
Type: Array of EncryptionConfig structures

The configuration you are using for encryption.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        '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|ConfigurationValues|SecurityGroups|Subnets|AuthenticationMode|PodIdentityAssociations|UpgradePolicy',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate',
    ],
]

Result Details

Members
update
Type: Update structure

An object representing an asynchronous update.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

AssociateIdentityProviderConfig

$result = $client->associateIdentityProviderConfig([/* ... */]);
$promise = $client->associateIdentityProviderConfigAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateIdentityProviderConfig([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'oidc' => [ // REQUIRED
        'clientId' => '<string>', // REQUIRED
        'groupsClaim' => '<string>',
        'groupsPrefix' => '<string>',
        'identityProviderConfigName' => '<string>', // REQUIRED
        'issuerUrl' => '<string>', // REQUIRED
        'requiredClaims' => ['<string>', ...],
        'usernameClaim' => '<string>',
        'usernamePrefix' => '<string>',
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of your cluster.

oidc
Required: Yes
Type: OidcIdentityProviderConfigRequest structure

An object representing an OpenID Connect (OIDC) identity provider configuration.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'tags' => ['<string>', ...],
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        '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|ConfigurationValues|SecurityGroups|Subnets|AuthenticationMode|PodIdentityAssociations|UpgradePolicy',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate',
    ],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags for the resource.

update
Type: Update structure

An object representing an asynchronous update.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

CreateAccessEntry

$result = $client->createAccessEntry([/* ... */]);
$promise = $client->createAccessEntryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAccessEntry([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'kubernetesGroups' => ['<string>', ...],
    'principalArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'type' => '<string>',
    'username' => '<string>',
]);

Parameter Details

Members
clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of your cluster.

kubernetesGroups
Type: Array of strings

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.

principalArn
Required: Yes
Type: string

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. The only valid ARN is IAM roles for the types of access entries for nodes: . You can use every IAM principal type for STANDARD access entries. 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.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

type
Type: string

The type of the new access entry. Valid values are Standard, FARGATE_LINUX, EC2_LINUX, and EC2_WINDOWS.

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

username
Type: 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.

Result Syntax

[
    'accessEntry' => [
        'accessEntryArn' => '<string>',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'kubernetesGroups' => ['<string>', ...],
        'modifiedAt' => <DateTime>,
        'principalArn' => '<string>',
        'tags' => ['<string>', ...],
        'type' => '<string>',
        'username' => '<string>',
    ],
]

Result Details

Members
accessEntry
Type: AccessEntry structure

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.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ResourceLimitExceededException:

You have encountered a service limit on the specified resource.

ResourceInUseException:

The specified resource is in use.

CreateAddon

$result = $client->createAddon([/* ... */]);
$promise = $client->createAddonAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAddon([
    'addonName' => '<string>', // REQUIRED
    'addonVersion' => '<string>',
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'configurationValues' => '<string>',
    'podIdentityAssociations' => [
        [
            'roleArn' => '<string>', // REQUIRED
            'serviceAccount' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'resolveConflicts' => 'OVERWRITE|NONE|PRESERVE',
    'serviceAccountRoleArn' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
addonName
Required: Yes
Type: string

The name of the add-on. The name must match one of the names returned by DescribeAddonVersions.

addonVersion
Type: string

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of your cluster.

configurationValues
Type: 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
Type: Array of AddonPodIdentityAssociations structures

An array of Pod Identity Assocations to be created. Each EKS Pod Identity 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 Pod Identity in the EKS User Guide.

resolveConflicts
Type: 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.

serviceAccountRoleArn
Type: 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.

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.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'addon' => [
        'addonArn' => '<string>',
        'addonName' => '<string>',
        'addonVersion' => '<string>',
        'clusterName' => '<string>',
        'configurationValues' => '<string>',
        'createdAt' => <DateTime>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AccessDenied|InternalFailure|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound|AddonSubscriptionNeeded|AddonPermissionFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'marketplaceInformation' => [
            'productId' => '<string>',
            'productUrl' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'owner' => '<string>',
        'podIdentityAssociations' => ['<string>', ...],
        'publisher' => '<string>',
        'serviceAccountRoleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|CREATE_FAILED|UPDATING|DELETING|DELETE_FAILED|DEGRADED|UPDATE_FAILED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
addon
Type: Addon structure

An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ResourceInUseException:

The specified resource is in use.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

Creates an Amazon EKS control plane.

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

The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support kubectl exec, logs, and proxy data flows).

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

You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

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.

Parameter Syntax

$result = $client->createCluster([
    'accessConfig' => [
        'authenticationMode' => 'API|API_AND_CONFIG_MAP|CONFIG_MAP',
        'bootstrapClusterCreatorAdminPermissions' => true || false,
    ],
    'bootstrapSelfManagedAddons' => true || false,
    'clientRequestToken' => '<string>',
    'encryptionConfig' => [
        [
            'provider' => [
                'keyArn' => '<string>',
            ],
            'resources' => ['<string>', ...],
        ],
        // ...
    ],
    'kubernetesNetworkConfig' => [
        'ipFamily' => 'ipv4|ipv6',
        'serviceIpv4Cidr' => '<string>',
    ],
    'logging' => [
        'clusterLogging' => [
            [
                'enabled' => true || false,
                'types' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'outpostConfig' => [
        'controlPlaneInstanceType' => '<string>', // REQUIRED
        'controlPlanePlacement' => [
            'groupName' => '<string>',
        ],
        'outpostArns' => ['<string>', ...], // REQUIRED
    ],
    'resourcesVpcConfig' => [ // REQUIRED
        'endpointPrivateAccess' => true || false,
        'endpointPublicAccess' => true || false,
        'publicAccessCidrs' => ['<string>', ...],
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'upgradePolicy' => [
        'supportType' => 'STANDARD|EXTENDED',
    ],
    'version' => '<string>',
]);

Parameter Details

Members
accessConfig
Type: CreateAccessConfigRequest structure

The access configuration for the cluster.

bootstrapSelfManagedAddons
Type: boolean

If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

The default networking addons 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.

clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

encryptionConfig
Type: Array of EncryptionConfig structures

The encryption configuration for the cluster.

kubernetesNetworkConfig

The Kubernetes network configuration for the cluster.

logging
Type: Logging structure

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 .

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

name
Required: Yes
Type: string

The unique name to give to your cluster.

outpostConfig
Type: OutpostConfigRequest structure

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.

resourcesVpcConfig
Required: Yes
Type: VpcConfigRequest structure

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.

roleArn
Required: Yes
Type: 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. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

upgradePolicy
Type: UpgradePolicyRequest structure

New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to STANDARD.

version
Type: 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.

The default version might not be the latest version available.

Result Syntax

[
    'cluster' => [
        'accessConfig' => [
            'authenticationMode' => 'API|API_AND_CONFIG_MAP|CONFIG_MAP',
            'bootstrapClusterCreatorAdminPermissions' => true || false,
        ],
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'connectorConfig' => [
            'activationCode' => '<string>',
            'activationExpiry' => <DateTime>,
            'activationId' => '<string>',
            'provider' => '<string>',
            'roleArn' => '<string>',
        ],
        'createdAt' => <DateTime>,
        'encryptionConfig' => [
            [
                'provider' => [
                    'keyArn' => '<string>',
                ],
                'resources' => ['<string>', ...],
            ],
            // ...
        ],
        'endpoint' => '<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>', ...],
                ],
                // ...
            ],
        ],
        'id' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'kubernetesNetworkConfig' => [
            'ipFamily' => 'ipv4|ipv6',
            'serviceIpv4Cidr' => '<string>',
            'serviceIpv6Cidr' => '<string>',
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'outpostConfig' => [
            'controlPlaneInstanceType' => '<string>',
            'controlPlanePlacement' => [
                'groupName' => '<string>',
            ],
            'outpostArns' => ['<string>', ...],
        ],
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'publicAccessCidrs' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|PENDING',
        'tags' => ['<string>', ...],
        'upgradePolicy' => [
            'supportType' => 'STANDARD|EXTENDED',
        ],
        'version' => '<string>',
    ],
]

Result Details

Members
cluster
Type: Cluster structure

The full description of your new cluster.

Errors

ResourceInUseException:

The specified resource is in use.

ResourceLimitExceededException:

You have encountered a service limit on the specified resource.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

UnsupportedAvailabilityZoneException:

At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

Examples

Example 1: To create a new cluster

The following example creates an Amazon EKS cluster called prod.

$result = $client->createCluster([
    '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',
]);

Result syntax:

[
]

CreateEksAnywhereSubscription

$result = $client->createEksAnywhereSubscription([/* ... */]);
$promise = $client->createEksAnywhereSubscriptionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createEksAnywhereSubscription([
    'autoRenew' => true || false,
    'clientRequestToken' => '<string>',
    'licenseQuantity' => <integer>,
    'licenseType' => 'Cluster',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'term' => [ // REQUIRED
        'duration' => <integer>,
        'unit' => 'MONTHS',
    ],
]);

Parameter Details

Members
autoRenew
Type: boolean

A boolean indicating whether the subscription auto renews at the end of the term.

clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

licenseQuantity
Type: int

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

name
Required: Yes
Type: string

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.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

term
Required: Yes
Type: EksAnywhereSubscriptionTerm structure

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.

Result Syntax

[
    'subscription' => [
        'arn' => '<string>',
        'autoRenew' => true || false,
        'createdAt' => <DateTime>,
        'effectiveDate' => <DateTime>,
        'expirationDate' => <DateTime>,
        'id' => '<string>',
        'licenseArns' => ['<string>', ...],
        'licenseQuantity' => <integer>,
        'licenseType' => 'Cluster',
        'status' => '<string>',
        'tags' => ['<string>', ...],
        'term' => [
            'duration' => <integer>,
            'unit' => 'MONTHS',
        ],
    ],
]

Result Details

Members
subscription
Type: EksAnywhereSubscription structure

The full description of the subscription.

Errors

ResourceLimitExceededException:

You have encountered a service limit on the specified resource.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

CreateFargateProfile

$result = $client->createFargateProfile([/* ... */]);
$promise = $client->createFargateProfileAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createFargateProfile([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'fargateProfileName' => '<string>', // REQUIRED
    'podExecutionRoleArn' => '<string>', // REQUIRED
    'selectors' => [
        [
            'labels' => ['<string>', ...],
            'namespace' => '<string>',
        ],
        // ...
    ],
    'subnets' => ['<string>', ...],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of your cluster.

fargateProfileName
Required: Yes
Type: string

The name of the Fargate profile.

podExecutionRoleArn
Required: Yes
Type: string

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.

selectors
Type: Array of FargateProfileSelector structures

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.

subnets
Type: Array of strings

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.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'fargateProfile' => [
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'fargateProfileArn' => '<string>',
        'fargateProfileName' => '<string>',
        'health' => [
            'issues' => [
                [
                    'code' => 'PodExecutionRoleAlreadyInUse|AccessDenied|ClusterUnreachable|InternalFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'podExecutionRoleArn' => '<string>',
        'selectors' => [
            [
                'labels' => ['<string>', ...],
                'namespace' => '<string>',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|CREATE_FAILED|DELETE_FAILED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
fargateProfile
Type: FargateProfile structure

The full description of your new Fargate profile.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceLimitExceededException:

You have encountered a service limit on the specified resource.

UnsupportedAvailabilityZoneException:

At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

CreateNodegroup

$result = $client->createNodegroup([/* ... */]);
$promise = $client->createNodegroupAsync([/* ... */]);

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

Windows AMI types are only supported for commercial Amazon Web Services Regions that support Windows on Amazon EKS.

Parameter Syntax

$result = $client->createNodegroup([
    'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64|CUSTOM|BOTTLEROCKET_ARM_64|BOTTLEROCKET_x86_64|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',
    'capacityType' => 'ON_DEMAND|SPOT|CAPACITY_BLOCK',
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'diskSize' => <integer>,
    'instanceTypes' => ['<string>', ...],
    'labels' => ['<string>', ...],
    'launchTemplate' => [
        'id' => '<string>',
        'name' => '<string>',
        'version' => '<string>',
    ],
    'nodeRole' => '<string>', // REQUIRED
    'nodegroupName' => '<string>', // REQUIRED
    'releaseVersion' => '<string>',
    'remoteAccess' => [
        'ec2SshKey' => '<string>',
        'sourceSecurityGroups' => ['<string>', ...],
    ],
    'scalingConfig' => [
        'desiredSize' => <integer>,
        'maxSize' => <integer>,
        'minSize' => <integer>,
    ],
    'subnets' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
    'taints' => [
        [
            'effect' => 'NO_SCHEDULE|NO_EXECUTE|PREFER_NO_SCHEDULE',
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'updateConfig' => [
        'maxUnavailable' => <integer>,
        'maxUnavailablePercentage' => <integer>,
    ],
    'version' => '<string>',
]);

Parameter Details

Members
amiType
Type: 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.

capacityType
Type: string

The capacity type for your node group.

clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of your cluster.

diskSize
Type: int

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.

instanceTypes
Type: Array of strings

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.

labels
Type: Associative array of custom strings keys (labelKey) to strings

The Kubernetes labels to apply to the nodes in the node group when they are created.

launchTemplate
Type: LaunchTemplateSpecification structure

An object representing a node group's launch template specification. When using this object, don't directly specify instanceTypes, diskSize, or remoteAccess. 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.

nodeRole
Required: Yes
Type: string

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.

nodegroupName
Required: Yes
Type: string

The unique name to give your node group.

releaseVersion
Type: 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.

remoteAccess
Type: RemoteAccessConfig structure

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.

scalingConfig
Type: NodegroupScalingConfig structure

The scaling configuration details for the Auto Scaling group that is created for your node group.

subnets
Required: Yes
Type: Array of strings

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.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

taints
Type: Array of Taint structures

The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

updateConfig
Type: NodegroupUpdateConfig structure

The node group update configuration.

version
Type: 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.

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64|CUSTOM|BOTTLEROCKET_ARM_64|BOTTLEROCKET_x86_64|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',
        'capacityType' => 'ON_DEMAND|SPOT|CAPACITY_BLOCK',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        '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',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<string>', ...],
        'launchTemplate' => [
            'id' => '<string>',
            'name' => '<string>',
            'version' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'nodeRole' => '<string>',
        'nodegroupArn' => '<string>',
        'nodegroupName' => '<string>',
        'releaseVersion' => '<string>',
        'remoteAccess' => [
            'ec2SshKey' => '<string>',
            'sourceSecurityGroups' => ['<string>', ...],
        ],
        'resources' => [
            'autoScalingGroups' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'remoteAccessSecurityGroup' => '<string>',
        ],
        'scalingConfig' => [
            'desiredSize' => <integer>,
            'maxSize' => <integer>,
            'minSize' => <integer>,
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|DEGRADED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'taints' => [
            [
                'effect' => 'NO_SCHEDULE|NO_EXECUTE|PREFER_NO_SCHEDULE',
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'updateConfig' => [
            'maxUnavailable' => <integer>,
            'maxUnavailablePercentage' => <integer>,
        ],
        'version' => '<string>',
    ],
]

Result Details

Members
nodegroup
Type: Nodegroup structure

The full description of your new node group.

Errors

ResourceInUseException:

The specified resource is in use.

ResourceLimitExceededException:

You have encountered a service limit on the specified resource.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

CreatePodIdentityAssociation

$result = $client->createPodIdentityAssociation([/* ... */]);
$promise = $client->createPodIdentityAssociationAsync([/* ... */]);

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.

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 Pod Identity once, and reuse it across clusters.

Parameter Syntax

$result = $client->createPodIdentityAssociation([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'serviceAccount' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of the cluster to create the association in.

namespace
Required: Yes
Type: 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.

roleArn
Required: Yes
Type: 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.

serviceAccount
Required: Yes
Type: string

The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'association' => [
        'associationArn' => '<string>',
        'associationId' => '<string>',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'modifiedAt' => <DateTime>,
        'namespace' => '<string>',
        'ownerArn' => '<string>',
        'roleArn' => '<string>',
        'serviceAccount' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
association
Type: PodIdentityAssociation structure

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.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ResourceLimitExceededException:

You have encountered a service limit on the specified resource.

ResourceInUseException:

The specified resource is in use.

DeleteAccessEntry

$result = $client->deleteAccessEntry([/* ... */]);
$promise = $client->deleteAccessEntryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteAccessEntry([
    'clusterName' => '<string>', // REQUIRED
    'principalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

principalArn
Required: Yes
Type: string

The ARN of the IAM principal for the AccessEntry.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

DeleteAddon

$result = $client->deleteAddon([/* ... */]);
$promise = $client->deleteAddonAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteAddon([
    'addonName' => '<string>', // REQUIRED
    'clusterName' => '<string>', // REQUIRED
    'preserve' => true || false,
]);

Parameter Details

Members
addonName
Required: Yes
Type: string

The name of the add-on. The name must match one of the names returned by ListAddons .

clusterName
Required: Yes
Type: string

The name of your cluster.

preserve
Type: 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.

Result Syntax

[
    'addon' => [
        'addonArn' => '<string>',
        'addonName' => '<string>',
        'addonVersion' => '<string>',
        'clusterName' => '<string>',
        'configurationValues' => '<string>',
        'createdAt' => <DateTime>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AccessDenied|InternalFailure|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound|AddonSubscriptionNeeded|AddonPermissionFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'marketplaceInformation' => [
            'productId' => '<string>',
            'productUrl' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'owner' => '<string>',
        'podIdentityAssociations' => ['<string>', ...],
        'publisher' => '<string>',
        'serviceAccountRoleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|CREATE_FAILED|UPDATING|DELETING|DELETE_FAILED|DEGRADED|UPDATE_FAILED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
addon
Type: Addon structure

An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

DeleteCluster

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteCluster([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the cluster to delete.

Result Syntax

[
    'cluster' => [
        'accessConfig' => [
            'authenticationMode' => 'API|API_AND_CONFIG_MAP|CONFIG_MAP',
            'bootstrapClusterCreatorAdminPermissions' => true || false,
        ],
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'connectorConfig' => [
            'activationCode' => '<string>',
            'activationExpiry' => <DateTime>,
            'activationId' => '<string>',
            'provider' => '<string>',
            'roleArn' => '<string>',
        ],
        'createdAt' => <DateTime>,
        'encryptionConfig' => [
            [
                'provider' => [
                    'keyArn' => '<string>',
                ],
                'resources' => ['<string>', ...],
            ],
            // ...
        ],
        'endpoint' => '<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>', ...],
                ],
                // ...
            ],
        ],
        'id' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'kubernetesNetworkConfig' => [
            'ipFamily' => 'ipv4|ipv6',
            'serviceIpv4Cidr' => '<string>',
            'serviceIpv6Cidr' => '<string>',
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'outpostConfig' => [
            'controlPlaneInstanceType' => '<string>',
            'controlPlanePlacement' => [
                'groupName' => '<string>',
            ],
            'outpostArns' => ['<string>', ...],
        ],
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'publicAccessCidrs' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|PENDING',
        'tags' => ['<string>', ...],
        'upgradePolicy' => [
            'supportType' => 'STANDARD|EXTENDED',
        ],
        'version' => '<string>',
    ],
]

Result Details

Members
cluster
Type: Cluster structure

The full description of the cluster to delete.

Errors

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

Examples

Example 1: To delete a cluster

This example command deletes a cluster named `devel` in your default region.

$result = $client->deleteCluster([
    'name' => 'devel',
]);

Result syntax:

[
]

DeleteEksAnywhereSubscription

$result = $client->deleteEksAnywhereSubscription([/* ... */]);
$promise = $client->deleteEksAnywhereSubscriptionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteEksAnywhereSubscription([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the subscription.

Result Syntax

[
    'subscription' => [
        'arn' => '<string>',
        'autoRenew' => true || false,
        'createdAt' => <DateTime>,
        'effectiveDate' => <DateTime>,
        'expirationDate' => <DateTime>,
        'id' => '<string>',
        'licenseArns' => ['<string>', ...],
        'licenseQuantity' => <integer>,
        'licenseType' => 'Cluster',
        'status' => '<string>',
        'tags' => ['<string>', ...],
        'term' => [
            'duration' => <integer>,
            'unit' => 'MONTHS',
        ],
    ],
]

Result Details

Members
subscription
Type: EksAnywhereSubscription structure

The full description of the subscription to be deleted.

Errors

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ServerException:

These errors are usually caused by a server-side issue.

DeleteFargateProfile

$result = $client->deleteFargateProfile([/* ... */]);
$promise = $client->deleteFargateProfileAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteFargateProfile([
    'clusterName' => '<string>', // REQUIRED
    'fargateProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

fargateProfileName
Required: Yes
Type: string

The name of the Fargate profile to delete.

Result Syntax

[
    'fargateProfile' => [
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'fargateProfileArn' => '<string>',
        'fargateProfileName' => '<string>',
        'health' => [
            'issues' => [
                [
                    'code' => 'PodExecutionRoleAlreadyInUse|AccessDenied|ClusterUnreachable|InternalFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'podExecutionRoleArn' => '<string>',
        'selectors' => [
            [
                'labels' => ['<string>', ...],
                'namespace' => '<string>',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|CREATE_FAILED|DELETE_FAILED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
fargateProfile
Type: FargateProfile structure

The deleted Fargate profile.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

DeleteNodegroup

$result = $client->deleteNodegroup([/* ... */]);
$promise = $client->deleteNodegroupAsync([/* ... */]);

Deletes a managed node group.

Parameter Syntax

$result = $client->deleteNodegroup([
    'clusterName' => '<string>', // REQUIRED
    'nodegroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

nodegroupName
Required: Yes
Type: string

The name of the node group to delete.

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64|CUSTOM|BOTTLEROCKET_ARM_64|BOTTLEROCKET_x86_64|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',
        'capacityType' => 'ON_DEMAND|SPOT|CAPACITY_BLOCK',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        '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',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<string>', ...],
        'launchTemplate' => [
            'id' => '<string>',
            'name' => '<string>',
            'version' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'nodeRole' => '<string>',
        'nodegroupArn' => '<string>',
        'nodegroupName' => '<string>',
        'releaseVersion' => '<string>',
        'remoteAccess' => [
            'ec2SshKey' => '<string>',
            'sourceSecurityGroups' => ['<string>', ...],
        ],
        'resources' => [
            'autoScalingGroups' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'remoteAccessSecurityGroup' => '<string>',
        ],
        'scalingConfig' => [
            'desiredSize' => <integer>,
            'maxSize' => <integer>,
            'minSize' => <integer>,
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|DEGRADED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'taints' => [
            [
                'effect' => 'NO_SCHEDULE|NO_EXECUTE|PREFER_NO_SCHEDULE',
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'updateConfig' => [
            'maxUnavailable' => <integer>,
            'maxUnavailablePercentage' => <integer>,
        ],
        'version' => '<string>',
    ],
]

Result Details

Members
nodegroup
Type: Nodegroup structure

The full description of your deleted node group.

Errors

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

DeletePodIdentityAssociation

$result = $client->deletePodIdentityAssociation([/* ... */]);
$promise = $client->deletePodIdentityAssociationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deletePodIdentityAssociation([
    'associationId' => '<string>', // REQUIRED
    'clusterName' => '<string>', // REQUIRED
]);

Parameter Details

Members
associationId
Required: Yes
Type: string

The ID of the association to be deleted.

clusterName
Required: Yes
Type: string

The cluster name that

Result Syntax

[
    'association' => [
        'associationArn' => '<string>',
        'associationId' => '<string>',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'modifiedAt' => <DateTime>,
        'namespace' => '<string>',
        'ownerArn' => '<string>',
        'roleArn' => '<string>',
        'serviceAccount' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
association
Type: PodIdentityAssociation structure

The full description of the EKS Pod Identity association that was deleted.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

DeregisterCluster

$result = $client->deregisterCluster([/* ... */]);
$promise = $client->deregisterClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deregisterCluster([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the connected cluster to deregister.

Result Syntax

[
    'cluster' => [
        'accessConfig' => [
            'authenticationMode' => 'API|API_AND_CONFIG_MAP|CONFIG_MAP',
            'bootstrapClusterCreatorAdminPermissions' => true || false,
        ],
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'connectorConfig' => [
            'activationCode' => '<string>',
            'activationExpiry' => <DateTime>,
            'activationId' => '<string>',
            'provider' => '<string>',
            'roleArn' => '<string>',
        ],
        'createdAt' => <DateTime>,
        'encryptionConfig' => [
            [
                'provider' => [
                    'keyArn' => '<string>',
                ],
                'resources' => ['<string>', ...],
            ],
            // ...
        ],
        'endpoint' => '<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>', ...],
                ],
                // ...
            ],
        ],
        'id' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'kubernetesNetworkConfig' => [
            'ipFamily' => 'ipv4|ipv6',
            'serviceIpv4Cidr' => '<string>',
            'serviceIpv6Cidr' => '<string>',
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'outpostConfig' => [
            'controlPlaneInstanceType' => '<string>',
            'controlPlanePlacement' => [
                'groupName' => '<string>',
            ],
            'outpostArns' => ['<string>', ...],
        ],
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'publicAccessCidrs' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|PENDING',
        'tags' => ['<string>', ...],
        'upgradePolicy' => [
            'supportType' => 'STANDARD|EXTENDED',
        ],
        'version' => '<string>',
    ],
]

Result Details

Members
cluster
Type: Cluster structure

An object representing an Amazon EKS cluster.

Errors

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

AccessDeniedException:

You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.

DescribeAccessEntry

$result = $client->describeAccessEntry([/* ... */]);
$promise = $client->describeAccessEntryAsync([/* ... */]);

Describes an access entry.

Parameter Syntax

$result = $client->describeAccessEntry([
    'clusterName' => '<string>', // REQUIRED
    'principalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

principalArn
Required: Yes
Type: string

The ARN of the IAM principal for the AccessEntry.

Result Syntax

[
    'accessEntry' => [
        'accessEntryArn' => '<string>',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'kubernetesGroups' => ['<string>', ...],
        'modifiedAt' => <DateTime>,
        'principalArn' => '<string>',
        'tags' => ['<string>', ...],
        'type' => '<string>',
        'username' => '<string>',
    ],
]

Result Details

Members
accessEntry
Type: AccessEntry structure

Information about the access entry.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

DescribeAddon

$result = $client->describeAddon([/* ... */]);
$promise = $client->describeAddonAsync([/* ... */]);

Describes an Amazon EKS add-on.

Parameter Syntax

$result = $client->describeAddon([
    'addonName' => '<string>', // REQUIRED
    'clusterName' => '<string>', // REQUIRED
]);

Parameter Details

Members
addonName
Required: Yes
Type: string

The name of the add-on. The name must match one of the names returned by ListAddons .

clusterName
Required: Yes
Type: string

The name of your cluster.

Result Syntax

[
    'addon' => [
        'addonArn' => '<string>',
        'addonName' => '<string>',
        'addonVersion' => '<string>',
        'clusterName' => '<string>',
        'configurationValues' => '<string>',
        'createdAt' => <DateTime>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AccessDenied|InternalFailure|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound|AddonSubscriptionNeeded|AddonPermissionFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'marketplaceInformation' => [
            'productId' => '<string>',
            'productUrl' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'owner' => '<string>',
        'podIdentityAssociations' => ['<string>', ...],
        'publisher' => '<string>',
        'serviceAccountRoleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|CREATE_FAILED|UPDATING|DELETING|DELETE_FAILED|DEGRADED|UPDATE_FAILED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
addon
Type: Addon structure

An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

DescribeAddonConfiguration

$result = $client->describeAddonConfiguration([/* ... */]);
$promise = $client->describeAddonConfigurationAsync([/* ... */]);

Returns configuration options.

Parameter Syntax

$result = $client->describeAddonConfiguration([
    'addonName' => '<string>', // REQUIRED
    'addonVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members
addonName
Required: Yes
Type: string

The name of the add-on. The name must match one of the names returned by DescribeAddonVersions.

addonVersion
Required: Yes
Type: string

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

Result Syntax

[
    'addonName' => '<string>',
    'addonVersion' => '<string>',
    'configurationSchema' => '<string>',
    'podIdentityConfiguration' => [
        [
            'recommendedManagedPolicies' => ['<string>', ...],
            'serviceAccount' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
addonName
Type: string

The name of the add-on.

addonVersion
Type: string

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

configurationSchema
Type: string

A JSON schema that's used to validate the configuration values you provide when an add-on is created or updated.

podIdentityConfiguration
Type: Array of AddonPodIdentityConfiguration structures

The Kubernetes service account name used by the addon, and any suggested IAM policies. Use this information to create an IAM Role for the Addon.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

DescribeAddonVersions

$result = $client->describeAddonVersions([/* ... */]);
$promise = $client->describeAddonVersionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeAddonVersions([
    'addonName' => '<string>',
    'kubernetesVersion' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'owners' => ['<string>', ...],
    'publishers' => ['<string>', ...],
    'types' => ['<string>', ...],
]);

Parameter Details

Members
addonName
Type: string

The name of the add-on. The name must match one of the names returned by ListAddons .

kubernetesVersion
Type: string

The Kubernetes versions that you can use the add-on with.

maxResults
Type: int

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

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.

owners
Type: Array of strings

The owner of the add-on. For valid owners, don't specify a value for this property.

publishers
Type: Array of strings

The publisher of the add-on. For valid publishers, don't specify a value for this property.

types
Type: Array of strings

The type of the add-on. For valid types, don't specify a value for this property.

Result Syntax

[
    'addons' => [
        [
            'addonName' => '<string>',
            'addonVersions' => [
                [
                    'addonVersion' => '<string>',
                    'architecture' => ['<string>', ...],
                    'compatibilities' => [
                        [
                            'clusterVersion' => '<string>',
                            'defaultVersion' => true || false,
                            'platformVersions' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'requiresConfiguration' => true || false,
                    'requiresIamPermissions' => true || false,
                ],
                // ...
            ],
            'marketplaceInformation' => [
                'productId' => '<string>',
                'productUrl' => '<string>',
            ],
            'owner' => '<string>',
            'publisher' => '<string>',
            'type' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
addons
Type: Array of AddonInfo structures

The list of available versions with Kubernetes version compatibility and other properties.

nextToken
Type: 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.

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.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

DescribeCluster

$result = $client->describeCluster([/* ... */]);
$promise = $client->describeClusterAsync([/* ... */]);

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.

The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

Parameter Syntax

$result = $client->describeCluster([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of your cluster.

Result Syntax

[
    'cluster' => [
        'accessConfig' => [
            'authenticationMode' => 'API|API_AND_CONFIG_MAP|CONFIG_MAP',
            'bootstrapClusterCreatorAdminPermissions' => true || false,
        ],
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'connectorConfig' => [
            'activationCode' => '<string>',
            'activationExpiry' => <DateTime>,
            'activationId' => '<string>',
            'provider' => '<string>',
            'roleArn' => '<string>',
        ],
        'createdAt' => <DateTime>,
        'encryptionConfig' => [
            [
                'provider' => [
                    'keyArn' => '<string>',
                ],
                'resources' => ['<string>', ...],
            ],
            // ...
        ],
        'endpoint' => '<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>', ...],
                ],
                // ...
            ],
        ],
        'id' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'kubernetesNetworkConfig' => [
            'ipFamily' => 'ipv4|ipv6',
            'serviceIpv4Cidr' => '<string>',
            'serviceIpv6Cidr' => '<string>',
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'outpostConfig' => [
            'controlPlaneInstanceType' => '<string>',
            'controlPlanePlacement' => [
                'groupName' => '<string>',
            ],
            'outpostArns' => ['<string>', ...],
        ],
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'publicAccessCidrs' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|PENDING',
        'tags' => ['<string>', ...],
        'upgradePolicy' => [
            'supportType' => 'STANDARD|EXTENDED',
        ],
        'version' => '<string>',
    ],
]

Result Details

Members
cluster
Type: Cluster structure

The full description of your specified cluster.

Errors

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

Examples

Example 1: To describe a cluster

This example command provides a description of the specified cluster in your default region.

$result = $client->describeCluster([
    'name' => 'devel',
]);

Result syntax:

[
    'cluster' => [
        'version' => '1.10',
        'name' => 'devel',
        'arn' => 'arn:aws:eks:us-west-2:012345678910:cluster/devel',
        'certificateAuthority' => [
            'data' => 'LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=',
        ],
        'createdAt' => ,
        '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',
    ],
]

DescribeEksAnywhereSubscription

$result = $client->describeEksAnywhereSubscription([/* ... */]);
$promise = $client->describeEksAnywhereSubscriptionAsync([/* ... */]);

Returns descriptive information about a subscription.

Parameter Syntax

$result = $client->describeEksAnywhereSubscription([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the subscription.

Result Syntax

[
    'subscription' => [
        'arn' => '<string>',
        'autoRenew' => true || false,
        'createdAt' => <DateTime>,
        'effectiveDate' => <DateTime>,
        'expirationDate' => <DateTime>,
        'id' => '<string>',
        'licenseArns' => ['<string>', ...],
        'licenseQuantity' => <integer>,
        'licenseType' => 'Cluster',
        'status' => '<string>',
        'tags' => ['<string>', ...],
        'term' => [
            'duration' => <integer>,
            'unit' => 'MONTHS',
        ],
    ],
]

Result Details

Members
subscription
Type: EksAnywhereSubscription structure

The full description of the subscription.

Errors

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

DescribeFargateProfile

$result = $client->describeFargateProfile([/* ... */]);
$promise = $client->describeFargateProfileAsync([/* ... */]);

Describes an Fargate profile.

Parameter Syntax

$result = $client->describeFargateProfile([
    'clusterName' => '<string>', // REQUIRED
    'fargateProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

fargateProfileName
Required: Yes
Type: string

The name of the Fargate profile to describe.

Result Syntax

[
    'fargateProfile' => [
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'fargateProfileArn' => '<string>',
        'fargateProfileName' => '<string>',
        'health' => [
            'issues' => [
                [
                    'code' => 'PodExecutionRoleAlreadyInUse|AccessDenied|ClusterUnreachable|InternalFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'podExecutionRoleArn' => '<string>',
        'selectors' => [
            [
                'labels' => ['<string>', ...],
                'namespace' => '<string>',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|CREATE_FAILED|DELETE_FAILED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
fargateProfile
Type: FargateProfile structure

The full description of your Fargate profile.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

DescribeIdentityProviderConfig

$result = $client->describeIdentityProviderConfig([/* ... */]);
$promise = $client->describeIdentityProviderConfigAsync([/* ... */]);

Describes an identity provider configuration.

Parameter Syntax

$result = $client->describeIdentityProviderConfig([
    'clusterName' => '<string>', // REQUIRED
    'identityProviderConfig' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'type' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

identityProviderConfig
Required: Yes
Type: IdentityProviderConfig structure

An object representing an identity provider configuration.

Result Syntax

[
    'identityProviderConfig' => [
        'oidc' => [
            'clientId' => '<string>',
            'clusterName' => '<string>',
            'groupsClaim' => '<string>',
            'groupsPrefix' => '<string>',
            'identityProviderConfigArn' => '<string>',
            'identityProviderConfigName' => '<string>',
            'issuerUrl' => '<string>',
            'requiredClaims' => ['<string>', ...],
            'status' => 'CREATING|DELETING|ACTIVE',
            'tags' => ['<string>', ...],
            'usernameClaim' => '<string>',
            'usernamePrefix' => '<string>',
        ],
    ],
]

Result Details

Members
identityProviderConfig

The object that represents an OpenID Connect (OIDC) identity provider configuration.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

DescribeInsight

$result = $client->describeInsight([/* ... */]);
$promise = $client->describeInsightAsync([/* ... */]);

Returns details about an insight that you specify using its ID.

Parameter Syntax

$result = $client->describeInsight([
    'clusterName' => '<string>', // REQUIRED
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of the cluster to describe the insight for.

id
Required: Yes
Type: string

The identity of the insight to describe.

Result Syntax

[
    'insight' => [
        'additionalInfo' => ['<string>', ...],
        'category' => 'UPGRADE_READINESS',
        'categorySpecificSummary' => [
            'deprecationDetails' => [
                [
                    'clientStats' => [
                        [
                            'lastRequestTime' => <DateTime>,
                            'numberOfRequestsLast30Days' => <integer>,
                            'userAgent' => '<string>',
                        ],
                        // ...
                    ],
                    'replacedWith' => '<string>',
                    'startServingReplacementVersion' => '<string>',
                    'stopServingVersion' => '<string>',
                    'usage' => '<string>',
                ],
                // ...
            ],
        ],
        'description' => '<string>',
        'id' => '<string>',
        'insightStatus' => [
            'reason' => '<string>',
            'status' => 'PASSING|WARNING|ERROR|UNKNOWN',
        ],
        'kubernetesVersion' => '<string>',
        'lastRefreshTime' => <DateTime>,
        'lastTransitionTime' => <DateTime>,
        'name' => '<string>',
        'recommendation' => '<string>',
        'resources' => [
            [
                'arn' => '<string>',
                'insightStatus' => [
                    'reason' => '<string>',
                    'status' => 'PASSING|WARNING|ERROR|UNKNOWN',
                ],
                'kubernetesResourceUri' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
insight
Type: Insight structure

The full description of the insight.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

DescribeNodegroup

$result = $client->describeNodegroup([/* ... */]);
$promise = $client->describeNodegroupAsync([/* ... */]);

Describes a managed node group.

Parameter Syntax

$result = $client->describeNodegroup([
    'clusterName' => '<string>', // REQUIRED
    'nodegroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

nodegroupName
Required: Yes
Type: string

The name of the node group to describe.

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64|CUSTOM|BOTTLEROCKET_ARM_64|BOTTLEROCKET_x86_64|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',
        'capacityType' => 'ON_DEMAND|SPOT|CAPACITY_BLOCK',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        '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',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<string>', ...],
        'launchTemplate' => [
            'id' => '<string>',
            'name' => '<string>',
            'version' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'nodeRole' => '<string>',
        'nodegroupArn' => '<string>',
        'nodegroupName' => '<string>',
        'releaseVersion' => '<string>',
        'remoteAccess' => [
            'ec2SshKey' => '<string>',
            'sourceSecurityGroups' => ['<string>', ...],
        ],
        'resources' => [
            'autoScalingGroups' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'remoteAccessSecurityGroup' => '<string>',
        ],
        'scalingConfig' => [
            'desiredSize' => <integer>,
            'maxSize' => <integer>,
            'minSize' => <integer>,
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|DEGRADED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'taints' => [
            [
                'effect' => 'NO_SCHEDULE|NO_EXECUTE|PREFER_NO_SCHEDULE',
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'updateConfig' => [
            'maxUnavailable' => <integer>,
            'maxUnavailablePercentage' => <integer>,
        ],
        'version' => '<string>',
    ],
]

Result Details

Members
nodegroup
Type: Nodegroup structure

The full description of your node group.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

DescribePodIdentityAssociation

$result = $client->describePodIdentityAssociation([/* ... */]);
$promise = $client->describePodIdentityAssociationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describePodIdentityAssociation([
    'associationId' => '<string>', // REQUIRED
    'clusterName' => '<string>', // REQUIRED
]);

Parameter Details

Members
associationId
Required: Yes
Type: string

The ID of the association that you want the description of.

clusterName
Required: Yes
Type: string

The name of the cluster that the association is in.

Result Syntax

[
    'association' => [
        'associationArn' => '<string>',
        'associationId' => '<string>',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'modifiedAt' => <DateTime>,
        'namespace' => '<string>',
        'ownerArn' => '<string>',
        'roleArn' => '<string>',
        'serviceAccount' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
association
Type: PodIdentityAssociation structure

The full description of the EKS Pod Identity association.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

DescribeUpdate

$result = $client->describeUpdate([/* ... */]);
$promise = $client->describeUpdateAsync([/* ... */]);

Describes an update to an Amazon EKS resource.

When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

Parameter Syntax

$result = $client->describeUpdate([
    'addonName' => '<string>',
    'name' => '<string>', // REQUIRED
    'nodegroupName' => '<string>',
    'updateId' => '<string>', // REQUIRED
]);

Parameter Details

Members
addonName
Type: 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.

name
Required: Yes
Type: string

The name of the Amazon EKS cluster associated with the update.

nodegroupName
Type: 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.

updateId
Required: Yes
Type: string

The ID of the update to describe.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        '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|ConfigurationValues|SecurityGroups|Subnets|AuthenticationMode|PodIdentityAssociations|UpgradePolicy',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate',
    ],
]

Result Details

Members
update
Type: Update structure

The full description of the specified update.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

DisassociateAccessPolicy

$result = $client->disassociateAccessPolicy([/* ... */]);
$promise = $client->disassociateAccessPolicyAsync([/* ... */]);

Disassociates an access policy from an access entry.

Parameter Syntax

$result = $client->disassociateAccessPolicy([
    'clusterName' => '<string>', // REQUIRED
    'policyArn' => '<string>', // REQUIRED
    'principalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

policyArn
Required: Yes
Type: string

The ARN of the policy to disassociate from the access entry. For a list of associated policies ARNs, use ListAssociatedAccessPolicies.

principalArn
Required: Yes
Type: string

The ARN of the IAM principal for the AccessEntry.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

DisassociateIdentityProviderConfig

$result = $client->disassociateIdentityProviderConfig([/* ... */]);
$promise = $client->disassociateIdentityProviderConfigAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disassociateIdentityProviderConfig([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'identityProviderConfig' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'type' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of your cluster.

identityProviderConfig
Required: Yes
Type: IdentityProviderConfig structure

An object representing an identity provider configuration.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        '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|ConfigurationValues|SecurityGroups|Subnets|AuthenticationMode|PodIdentityAssociations|UpgradePolicy',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate',
    ],
]

Result Details

Members
update
Type: Update structure

An object representing an asynchronous update.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ListAccessEntries

$result = $client->listAccessEntries([/* ... */]);
$promise = $client->listAccessEntriesAsync([/* ... */]);

Lists the access entries for your cluster.

Parameter Syntax

$result = $client->listAccessEntries([
    'associatedPolicyArn' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
associatedPolicyArn
Type: 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.

clusterName
Required: Yes
Type: string

The name of your cluster.

maxResults
Type: int

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

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.

Result Syntax

[
    'accessEntries' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Members
accessEntries
Type: Array of strings

The list of access entries that exist for the cluster.

nextToken
Type: 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.

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.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ListAccessPolicies

$result = $client->listAccessPolicies([/* ... */]);
$promise = $client->listAccessPoliciesAsync([/* ... */]);

Lists the available access policies.

Parameter Syntax

$result = $client->listAccessPolicies([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

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

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.

Result Syntax

[
    'accessPolicies' => [
        [
            'arn' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
accessPolicies
Type: Array of AccessPolicy structures

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.

nextToken
Type: 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.

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.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ListAddons

$result = $client->listAddons([/* ... */]);
$promise = $client->listAddonsAsync([/* ... */]);

Lists the installed add-ons.

Parameter Syntax

$result = $client->listAddons([
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

maxResults
Type: int

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

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.

Result Syntax

[
    'addons' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Members
addons
Type: Array of strings

A list of installed add-ons.

nextToken
Type: 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.

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.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ServerException:

These errors are usually caused by a server-side issue.

ListAssociatedAccessPolicies

$result = $client->listAssociatedAccessPolicies([/* ... */]);
$promise = $client->listAssociatedAccessPoliciesAsync([/* ... */]);

Lists the access policies associated with an access entry.

Parameter Syntax

$result = $client->listAssociatedAccessPolicies([
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'principalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

maxResults
Type: int

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

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.

principalArn
Required: Yes
Type: string

The ARN of the IAM principal for the AccessEntry.

Result Syntax

[
    'associatedAccessPolicies' => [
        [
            'accessScope' => [
                'namespaces' => ['<string>', ...],
                'type' => 'cluster|namespace',
            ],
            'associatedAt' => <DateTime>,
            'modifiedAt' => <DateTime>,
            'policyArn' => '<string>',
        ],
        // ...
    ],
    'clusterName' => '<string>',
    'nextToken' => '<string>',
    'principalArn' => '<string>',
]

Result Details

Members
associatedAccessPolicies
Type: Array of AssociatedAccessPolicy structures

The list of access policies associated with the access entry.

clusterName
Type: string

The name of your cluster.

nextToken
Type: 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.

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.

principalArn
Type: string

The ARN of the IAM principal for the AccessEntry.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ListClusters

$result = $client->listClusters([/* ... */]);
$promise = $client->listClustersAsync([/* ... */]);

Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.

Parameter Syntax

$result = $client->listClusters([
    'include' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
include
Type: Array of strings

Indicates whether external clusters are included in the returned list. Use 'all' to return https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.htmlconnected clusters, or blank to return only Amazon EKS clusters. 'all' must be in lowercase otherwise an error occurs.

maxResults
Type: int

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

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.

Result Syntax

[
    'clusters' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Members
clusters
Type: Array of strings

A list of all of the clusters for your account in the specified Amazon Web Services Region.

nextToken
Type: 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.

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.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

Examples

Example 1: To list your available clusters

This example command lists all of your available clusters in your default region.

$result = $client->listClusters([
]);

Result syntax:

[
    'clusters' => [
        'devel',
        'prod',
    ],
]

ListEksAnywhereSubscriptions

$result = $client->listEksAnywhereSubscriptions([/* ... */]);
$promise = $client->listEksAnywhereSubscriptionsAsync([/* ... */]);

Displays the full description of the subscription.

Parameter Syntax

$result = $client->listEksAnywhereSubscriptions([
    'includeStatus' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
includeStatus
Type: Array of strings

An array of subscription statuses to filter on.

maxResults
Type: int

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

Result Syntax

[
    'nextToken' => '<string>',
    'subscriptions' => [
        [
            'arn' => '<string>',
            'autoRenew' => true || false,
            'createdAt' => <DateTime>,
            'effectiveDate' => <DateTime>,
            'expirationDate' => <DateTime>,
            'id' => '<string>',
            'licenseArns' => ['<string>', ...],
            'licenseQuantity' => <integer>,
            'licenseType' => 'Cluster',
            'status' => '<string>',
            'tags' => ['<string>', ...],
            'term' => [
                'duration' => <integer>,
                'unit' => 'MONTHS',
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: 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.

subscriptions
Type: Array of EksAnywhereSubscription structures

A list of all subscription objects in the region, filtered by includeStatus and paginated by nextToken and maxResults.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

ListFargateProfiles

$result = $client->listFargateProfiles([/* ... */]);
$promise = $client->listFargateProfilesAsync([/* ... */]);

Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.

Parameter Syntax

$result = $client->listFargateProfiles([
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

maxResults
Type: int

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

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.

Result Syntax

[
    'fargateProfileNames' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Members
fargateProfileNames
Type: Array of strings

A list of all of the Fargate profiles associated with the specified cluster.

nextToken
Type: 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.

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.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ListIdentityProviderConfigs

$result = $client->listIdentityProviderConfigs([/* ... */]);
$promise = $client->listIdentityProviderConfigsAsync([/* ... */]);

Lists the identity provider configurations for your cluster.

Parameter Syntax

$result = $client->listIdentityProviderConfigs([
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

maxResults
Type: int

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

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.

Result Syntax

[
    'identityProviderConfigs' => [
        [
            'name' => '<string>',
            'type' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
identityProviderConfigs
Type: Array of IdentityProviderConfig structures

The identity provider configurations for the cluster.

nextToken
Type: 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.

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.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ListInsights

$result = $client->listInsights([/* ... */]);
$promise = $client->listInsightsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listInsights([
    'clusterName' => '<string>', // REQUIRED
    'filter' => [
        'categories' => ['<string>', ...],
        'kubernetesVersions' => ['<string>', ...],
        'statuses' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of the Amazon EKS cluster associated with the insights.

filter
Type: InsightsFilter structure

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.

maxResults
Type: int

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

Result Syntax

[
    'insights' => [
        [
            'category' => 'UPGRADE_READINESS',
            'description' => '<string>',
            'id' => '<string>',
            'insightStatus' => [
                'reason' => '<string>',
                'status' => 'PASSING|WARNING|ERROR|UNKNOWN',
            ],
            'kubernetesVersion' => '<string>',
            'lastRefreshTime' => <DateTime>,
            'lastTransitionTime' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
insights
Type: Array of InsightSummary structures

The returned list of insights.

nextToken
Type: 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.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ListNodegroups

$result = $client->listNodegroups([/* ... */]);
$promise = $client->listNodegroupsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listNodegroups([
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of your cluster.

maxResults
Type: int

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

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.

Result Syntax

[
    'nextToken' => '<string>',
    'nodegroups' => ['<string>', ...],
]

Result Details

Members
nextToken
Type: 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.

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.

nodegroups
Type: Array of strings

A list of all of the node groups associated with the specified cluster.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ListPodIdentityAssociations

$result = $client->listPodIdentityAssociations([/* ... */]);
$promise = $client->listPodIdentityAssociationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listPodIdentityAssociations([
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'namespace' => '<string>',
    'nextToken' => '<string>',
    'serviceAccount' => '<string>',
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of the cluster that the associations are in.

maxResults
Type: int

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.

namespace
Type: string

The name of the Kubernetes namespace inside the cluster that the associations are in.

nextToken
Type: 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.

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.

serviceAccount
Type: string

The name of the Kubernetes service account that the associations use.

Result Syntax

[
    'associations' => [
        [
            'associationArn' => '<string>',
            'associationId' => '<string>',
            'clusterName' => '<string>',
            'namespace' => '<string>',
            'ownerArn' => '<string>',
            'serviceAccount' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
associations
Type: Array of PodIdentityAssociationSummary structures

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

nextToken
Type: 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.

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.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List the tags for an Amazon EKS resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that identifies the resource to list tags for.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags for the resource.

Errors

BadRequestException:

This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

NotFoundException:

A service resource associated with the request could not be found. Clients should not retry such requests.

Examples

Example 1: To list tags for a cluster

This example lists all of the tags for the `beta` cluster.

$result = $client->listTagsForResource([
    'resourceArn' => 'arn:aws:eks:us-west-2:012345678910:cluster/beta',
]);

Result syntax:

[
    'tags' => [
        'aws:tag:domain' => 'beta',
    ],
]

ListUpdates

$result = $client->listUpdates([/* ... */]);
$promise = $client->listUpdatesAsync([/* ... */]);

Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.

Parameter Syntax

$result = $client->listUpdates([
    'addonName' => '<string>',
    'maxResults' => <integer>,
    'name' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'nodegroupName' => '<string>',
]);

Parameter Details

Members
addonName
Type: string

The names of the installed add-ons that have available updates.

maxResults
Type: int

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.

name
Required: Yes
Type: string

The name of the Amazon EKS cluster to list updates for.

nextToken
Type: 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.

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.

nodegroupName
Type: string

The name of the Amazon EKS managed node group to list updates for.

Result Syntax

[
    'nextToken' => '<string>',
    'updateIds' => ['<string>', ...],
]

Result Details

Members
nextToken
Type: 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.

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.

updateIds
Type: Array of strings

A list of all the updates for the specified cluster and Region.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

RegisterCluster

$result = $client->registerCluster([/* ... */]);
$promise = $client->registerClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->registerCluster([
    'clientRequestToken' => '<string>',
    'connectorConfig' => [ // REQUIRED
        'provider' => 'EKS_ANYWHERE|ANTHOS|GKE|AKS|OPENSHIFT|TANZU|RANCHER|EC2|OTHER', // REQUIRED
        'roleArn' => '<string>', // REQUIRED
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

connectorConfig
Required: Yes
Type: ConnectorConfigRequest structure

The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane.

name
Required: Yes
Type: string

A unique name for this cluster in your Amazon Web Services Region.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'cluster' => [
        'accessConfig' => [
            'authenticationMode' => 'API|API_AND_CONFIG_MAP|CONFIG_MAP',
            'bootstrapClusterCreatorAdminPermissions' => true || false,
        ],
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'connectorConfig' => [
            'activationCode' => '<string>',
            'activationExpiry' => <DateTime>,
            'activationId' => '<string>',
            'provider' => '<string>',
            'roleArn' => '<string>',
        ],
        'createdAt' => <DateTime>,
        'encryptionConfig' => [
            [
                'provider' => [
                    'keyArn' => '<string>',
                ],
                'resources' => ['<string>', ...],
            ],
            // ...
        ],
        'endpoint' => '<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>', ...],
                ],
                // ...
            ],
        ],
        'id' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'kubernetesNetworkConfig' => [
            'ipFamily' => 'ipv4|ipv6',
            'serviceIpv4Cidr' => '<string>',
            'serviceIpv6Cidr' => '<string>',
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'outpostConfig' => [
            'controlPlaneInstanceType' => '<string>',
            'controlPlanePlacement' => [
                'groupName' => '<string>',
            ],
            'outpostArns' => ['<string>', ...],
        ],
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'publicAccessCidrs' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|PENDING',
        'tags' => ['<string>', ...],
        'upgradePolicy' => [
            'supportType' => 'STANDARD|EXTENDED',
        ],
        'version' => '<string>',
    ],
]

Result Details

Members
cluster
Type: Cluster structure

An object representing an Amazon EKS cluster.

Errors

ResourceLimitExceededException:

You have encountered a service limit on the specified resource.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

AccessDeniedException:

You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.

ResourceInUseException:

The specified resource is in use.

ResourcePropagationDelayException:

Required resources (such as service-linked roles) were created and are still propagating. Retry later.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to add tags to.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

NotFoundException:

A service resource associated with the request could not be found. Clients should not retry such requests.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes specified tags from an Amazon EKS resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to delete tags from.

tagKeys
Required: Yes
Type: Array of strings

The keys of the tags to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

NotFoundException:

A service resource associated with the request could not be found. Clients should not retry such requests.

UpdateAccessEntry

$result = $client->updateAccessEntry([/* ... */]);
$promise = $client->updateAccessEntryAsync([/* ... */]);

Updates an access entry.

Parameter Syntax

$result = $client->updateAccessEntry([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'kubernetesGroups' => ['<string>', ...],
    'principalArn' => '<string>', // REQUIRED
    'username' => '<string>',
]);

Parameter Details

Members
clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of your cluster.

kubernetesGroups
Type: Array of strings

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.

principalArn
Required: Yes
Type: string

The ARN of the IAM principal for the AccessEntry.

username
Type: 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.

Result Syntax

[
    'accessEntry' => [
        'accessEntryArn' => '<string>',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'kubernetesGroups' => ['<string>', ...],
        'modifiedAt' => <DateTime>,
        'principalArn' => '<string>',
        'tags' => ['<string>', ...],
        'type' => '<string>',
        'username' => '<string>',
    ],
]

Result Details

Members
accessEntry
Type: AccessEntry structure

The ARN of the IAM principal for the AccessEntry.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

UpdateAddon

$result = $client->updateAddon([/* ... */]);
$promise = $client->updateAddonAsync([/* ... */]);

Updates an Amazon EKS add-on.

Parameter Syntax

$result = $client->updateAddon([
    'addonName' => '<string>', // REQUIRED
    'addonVersion' => '<string>',
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'configurationValues' => '<string>',
    'podIdentityAssociations' => [
        [
            'roleArn' => '<string>', // REQUIRED
            'serviceAccount' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'resolveConflicts' => 'OVERWRITE|NONE|PRESERVE',
    'serviceAccountRoleArn' => '<string>',
]);

Parameter Details

Members
addonName
Required: Yes
Type: string

The name of the add-on. The name must match one of the names returned by ListAddons .

addonVersion
Type: string

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of your cluster.

configurationValues
Type: 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
Type: Array of AddonPodIdentityAssociations structures

An array of Pod Identity Assocations to be updated. Each EKS Pod Identity 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 Pod Identity Assocations owned by the Addon are deleted.

For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.

resolveConflicts
Type: 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.

serviceAccountRoleArn
Type: 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.

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.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        '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|ConfigurationValues|SecurityGroups|Subnets|AuthenticationMode|PodIdentityAssociations|UpgradePolicy',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate',
    ],
]

Result Details

Members
update
Type: Update structure

An object representing an asynchronous update.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

ResourceInUseException:

The specified resource is in use.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

UpdateClusterConfig

$result = $client->updateClusterConfig([/* ... */]);
$promise = $client->updateClusterConfigAsync([/* ... */]);

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

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 Amazon EKS cluster endpoint access control 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.aws.amazon.com/eks/latest/userguide/network_reqs.html in the Amazon EKS User Guide .

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.

Parameter Syntax

$result = $client->updateClusterConfig([
    'accessConfig' => [
        'authenticationMode' => 'API|API_AND_CONFIG_MAP|CONFIG_MAP',
    ],
    'clientRequestToken' => '<string>',
    'logging' => [
        'clusterLogging' => [
            [
                'enabled' => true || false,
                'types' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'resourcesVpcConfig' => [
        'endpointPrivateAccess' => true || false,
        'endpointPublicAccess' => true || false,
        'publicAccessCidrs' => ['<string>', ...],
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
    'upgradePolicy' => [
        'supportType' => 'STANDARD|EXTENDED',
    ],
]);

Parameter Details

Members
accessConfig
Type: UpdateAccessConfigRequest structure

The access configuration for the cluster.

clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

logging
Type: Logging structure

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 .

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

name
Required: Yes
Type: string

The name of the Amazon EKS cluster to update.

resourcesVpcConfig
Type: VpcConfigRequest structure

An object representing the VPC configuration to use for an Amazon EKS cluster.

upgradePolicy
Type: UpgradePolicyRequest structure

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.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        '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|ConfigurationValues|SecurityGroups|Subnets|AuthenticationMode|PodIdentityAssociations|UpgradePolicy',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate',
    ],
]

Result Details

Members
update
Type: Update structure

An object representing an asynchronous update.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

UpdateClusterVersion

$result = $client->updateClusterVersion([/* ... */]);
$promise = $client->updateClusterVersionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateClusterVersion([
    'clientRequestToken' => '<string>',
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

name
Required: Yes
Type: string

The name of the Amazon EKS cluster to update.

version
Required: Yes
Type: string

The desired Kubernetes version following a successful update.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        '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|ConfigurationValues|SecurityGroups|Subnets|AuthenticationMode|PodIdentityAssociations|UpgradePolicy',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate',
    ],
]

Result Details

Members
update
Type: Update structure

The full description of the specified update

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

UpdateEksAnywhereSubscription

$result = $client->updateEksAnywhereSubscription([/* ... */]);
$promise = $client->updateEksAnywhereSubscriptionAsync([/* ... */]);

Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.

Parameter Syntax

$result = $client->updateEksAnywhereSubscription([
    'autoRenew' => true || false, // REQUIRED
    'clientRequestToken' => '<string>',
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
autoRenew
Required: Yes
Type: boolean

A boolean indicating whether or not to automatically renew the subscription.

clientRequestToken
Type: string

Unique, case-sensitive identifier to ensure the idempotency of the request.

id
Required: Yes
Type: string

The ID of the subscription.

Result Syntax

[
    'subscription' => [
        'arn' => '<string>',
        'autoRenew' => true || false,
        'createdAt' => <DateTime>,
        'effectiveDate' => <DateTime>,
        'expirationDate' => <DateTime>,
        'id' => '<string>',
        'licenseArns' => ['<string>', ...],
        'licenseQuantity' => <integer>,
        'licenseType' => 'Cluster',
        'status' => '<string>',
        'tags' => ['<string>', ...],
        'term' => [
            'duration' => <integer>,
            'unit' => 'MONTHS',
        ],
    ],
]

Result Details

Members
subscription
Type: EksAnywhereSubscription structure

The full description of the updated subscription.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

UpdateNodegroupConfig

$result = $client->updateNodegroupConfig([/* ... */]);
$promise = $client->updateNodegroupConfigAsync([/* ... */]);

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. Currently you can update the Kubernetes labels for a node group or the scaling configuration.

Parameter Syntax

$result = $client->updateNodegroupConfig([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'labels' => [
        'addOrUpdateLabels' => ['<string>', ...],
        'removeLabels' => ['<string>', ...],
    ],
    'nodegroupName' => '<string>', // REQUIRED
    'scalingConfig' => [
        'desiredSize' => <integer>,
        'maxSize' => <integer>,
        'minSize' => <integer>,
    ],
    'taints' => [
        'addOrUpdateTaints' => [
            [
                'effect' => 'NO_SCHEDULE|NO_EXECUTE|PREFER_NO_SCHEDULE',
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'removeTaints' => [
            [
                'effect' => 'NO_SCHEDULE|NO_EXECUTE|PREFER_NO_SCHEDULE',
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
    ],
    'updateConfig' => [
        'maxUnavailable' => <integer>,
        'maxUnavailablePercentage' => <integer>,
    ],
]);

Parameter Details

Members
clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of your cluster.

labels
Type: UpdateLabelsPayload structure

The Kubernetes labels to apply to the nodes in the node group after the update.

nodegroupName
Required: Yes
Type: string

The name of the managed node group to update.

scalingConfig
Type: NodegroupScalingConfig structure

The scaling configuration details for the Auto Scaling group after the update.

taints
Type: UpdateTaintsPayload structure

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.

updateConfig
Type: NodegroupUpdateConfig structure

The node group update configuration.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        '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|ConfigurationValues|SecurityGroups|Subnets|AuthenticationMode|PodIdentityAssociations|UpgradePolicy',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate',
    ],
]

Result Details

Members
update
Type: Update structure

An object representing an asynchronous update.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

UpdateNodegroupVersion

$result = $client->updateNodegroupVersion([/* ... */]);
$promise = $client->updateNodegroupVersionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateNodegroupVersion([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'force' => true || false,
    'launchTemplate' => [
        'id' => '<string>',
        'name' => '<string>',
        'version' => '<string>',
    ],
    'nodegroupName' => '<string>', // REQUIRED
    'releaseVersion' => '<string>',
    'version' => '<string>',
]);

Parameter Details

Members
clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of your cluster.

force
Type: 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.

launchTemplate
Type: LaunchTemplateSpecification structure

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.

nodegroupName
Required: Yes
Type: string

The name of the managed node group to update.

releaseVersion
Type: 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.

version
Type: 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.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict|AdmissionRequestDenied|UnsupportedAddonModification|K8sResourceNotFound',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        '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|ConfigurationValues|SecurityGroups|Subnets|AuthenticationMode|PodIdentityAssociations|UpgradePolicy',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate',
    ],
]

Result Details

Members
update
Type: Update structure

An object representing an asynchronous update.

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ClientException:

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException:

These errors are usually caused by a server-side issue.

ResourceInUseException:

The specified resource is in use.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

UpdatePodIdentityAssociation

$result = $client->updatePodIdentityAssociation([/* ... */]);
$promise = $client->updatePodIdentityAssociationAsync([/* ... */]);

Updates a EKS Pod Identity association. Only the IAM role can be changed; 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.

Parameter Syntax

$result = $client->updatePodIdentityAssociation([
    'associationId' => '<string>', // REQUIRED
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'roleArn' => '<string>',
]);

Parameter Details

Members
associationId
Required: Yes
Type: string

The ID of the association to be updated.

clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

clusterName
Required: Yes
Type: string

The name of the cluster that you want to update the association in.

roleArn
Type: string

The new IAM role to change the

Result Syntax

[
    'association' => [
        'associationArn' => '<string>',
        'associationId' => '<string>',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'modifiedAt' => <DateTime>,
        'namespace' => '<string>',
        'ownerArn' => '<string>',
        'roleArn' => '<string>',
        'serviceAccount' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
association
Type: PodIdentityAssociation structure

The full description of the EKS Pod Identity association that was updated.

Errors

ServerException:

These errors are usually caused by a server-side issue.

ResourceNotFoundException:

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

InvalidRequestException:

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

Shapes

AccessConfigResponse

Description

The access configuration for the cluster.

Members
authenticationMode
Type: string

The current authentication mode of the cluster.

bootstrapClusterCreatorAdminPermissions
Type: boolean

Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.

AccessDeniedException

Description

You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.

Members
message
Type: string

You do not have sufficient access to perform this action.

AccessEntry

Description

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.

Members
accessEntryArn
Type: string

The ARN of the access entry.

clusterName
Type: string

The name of your cluster.

createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix epoch timestamp at object creation.

kubernetesGroups
Type: Array of strings

A name that you've specified in a Kubernetes RoleBinding or ClusterRoleBinding object so that Kubernetes authorizes the principalARN access to cluster objects.

modifiedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix epoch timestamp for the last modification to the object.

principalArn
Type: 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.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

type
Type: string

The type of the access entry.

username
Type: string

The name of a user that can authenticate to your cluster.

AccessPolicy

Description

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.

Members
arn
Type: string

The ARN of the access policy.

name
Type: string

The name of the access policy.

AccessScope

Description

The scope of an AccessPolicy that's associated to an AccessEntry.

Members
namespaces
Type: Array of strings

A Kubernetes namespace that an access policy is scoped to. A value is required if you specified namespace for Type.

type
Type: string

The scope type of an access policy.

Addon

Description

An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

Members
addonArn
Type: string

The Amazon Resource Name (ARN) of the add-on.

addonName
Type: string

The name of the add-on.

addonVersion
Type: string

The version of the add-on.

clusterName
Type: string

The name of your cluster.

configurationValues
Type: string

The configuration values that you provided.

createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix epoch timestamp at object creation.

health
Type: AddonHealth structure

An object that represents the health of the add-on.

marketplaceInformation
Type: MarketplaceInformation structure

Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.

modifiedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix epoch timestamp for the last modification to the object.

owner
Type: string

The owner of the add-on.

podIdentityAssociations
Type: Array of strings

An array of Pod Identity Assocations owned by the Addon. Each EKS Pod Identity 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 Pod Identity in the EKS User Guide.

publisher
Type: string

The publisher of the add-on.

serviceAccountRoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM role that's bound to the Kubernetes ServiceAccount object that the add-on uses.

status
Type: string

The status of the add-on.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

AddonHealth

Description

The health of the add-on.

Members
issues
Type: Array of AddonIssue structures

An object representing the health issues for an add-on.

AddonInfo

Description

Information about an add-on.

Members
addonName
Type: string

The name of the add-on.

addonVersions
Type: Array of AddonVersionInfo structures

An object representing information about available add-on versions and compatible Kubernetes versions.

marketplaceInformation
Type: MarketplaceInformation structure

Information about the add-on from the Amazon Web Services Marketplace.

owner
Type: string

The owner of the add-on.

publisher
Type: string

The publisher of the add-on.

type
Type: string

The type of the add-on.

AddonIssue

Description

An issue related to an add-on.

Members
code
Type: string

A code that describes the type of issue.

message
Type: string

A message that provides details about the issue and what might cause it.

resourceIds
Type: Array of strings

The resource IDs of the issue.

AddonPodIdentityAssociations

Description

A type of Pod Identity Association owned by an Amazon EKS Add-on.

Each EKS Pod Identity 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 Pod Identity in the EKS User Guide.

Members
roleArn
Required: Yes
Type: string

The ARN of an IAM Role.

serviceAccount
Required: Yes
Type: string

The name of a Kubernetes Service Account.

AddonPodIdentityConfiguration

Description

Information about how to configure IAM for an Addon.

Members
recommendedManagedPolicies
Type: Array of strings

A suggested IAM Policy for the addon.

serviceAccount
Type: string

The Kubernetes Service Account name used by the addon.

AddonVersionInfo

Description

Information about an add-on version.

Members
addonVersion
Type: string

The version of the add-on.

architecture
Type: Array of strings

The architectures that the version supports.

compatibilities
Type: Array of Compatibility structures

An object representing the compatibilities of a version.

requiresConfiguration
Type: boolean

Whether the add-on requires configuration.

requiresIamPermissions
Type: boolean

Indicates if the Addon requires IAM Permissions to operate, such as networking permissions.

AssociatedAccessPolicy

Description

An access policy association.

Members
accessScope
Type: AccessScope structure

The scope of the access policy.

associatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the AccessPolicy was associated with an AccessEntry.

modifiedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix epoch timestamp for the last modification to the object.

policyArn
Type: string

The ARN of the AccessPolicy.

AutoScalingGroup

Description

An Auto Scaling group that is associated with an Amazon EKS managed node group.

Members
name
Type: string

The name of the Auto Scaling group associated with an Amazon EKS managed node group.

BadRequestException

Description

This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

Members
message
Type: string

This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

Certificate

Description

An object representing the certificate-authority-data for your cluster.

Members
data
Type: 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.

ClientException

Description

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

Members
addonName
Type: string

The Amazon EKS add-on name associated with the exception.

clusterName
Type: string

The Amazon EKS cluster associated with the exception.

message
Type: string

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

nodegroupName
Type: string

The Amazon EKS managed node group associated with the exception.

subscriptionId
Type: string

The Amazon EKS subscription ID with the exception.

ClientStat

Description

Details about clients using the deprecated resources.

Members
lastRequestTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the last request seen from the Kubernetes client.

numberOfRequestsLast30Days
Type: int

The number of requests from the Kubernetes client seen over the last 30 days.

userAgent
Type: string

The user agent of the Kubernetes client using the deprecated resource.

Cluster

Description

An object representing an Amazon EKS cluster.

Members
accessConfig
Type: AccessConfigResponse structure

The access configuration for the cluster.

arn
Type: string

The Amazon Resource Name (ARN) of the cluster.

certificateAuthority
Type: Certificate structure

The certificate-authority-data for your cluster.

clientRequestToken
Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

connectorConfig
Type: ConnectorConfigResponse structure

The configuration used to connect to a cluster for registration.

createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix epoch timestamp at object creation.

encryptionConfig
Type: Array of EncryptionConfig structures

The encryption configuration for the cluster.

endpoint
Type: string

The endpoint for your Kubernetes API server.

health
Type: ClusterHealth structure

An object representing the health of your Amazon EKS cluster.

id
Type: 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.

identity
Type: Identity structure

The identity provider information for the cluster.

kubernetesNetworkConfig

The Kubernetes network configuration for the cluster.

logging
Type: Logging structure

The logging configuration for your cluster.

name
Type: string

The name of your cluster.

outpostConfig
Type: OutpostConfigResponse structure

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.

platformVersion
Type: 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 .

resourcesVpcConfig
Type: VpcConfigResponse structure

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.

roleArn
Type: 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.

status
Type: string

The current status of the cluster.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

upgradePolicy
Type: UpgradePolicyResponse structure

This value indicates if extended support is enabled or disabled for the cluster.

Learn more about EKS Extended Support in the EKS User Guide.

version
Type: string

The Kubernetes server version for the cluster.

ClusterHealth

Description

An object representing the health of your Amazon EKS cluster.

Members
issues
Type: Array of ClusterIssue structures

An object representing the health issues of your Amazon EKS cluster.

ClusterIssue

Description

An issue with your Amazon EKS cluster.

Members
code
Type: string

The error code of the issue.

message
Type: string

A description of the issue.

resourceIds
Type: Array of strings

The resource IDs that the issue relates to.

Compatibility

Description

Compatibility information.

Members
clusterVersion
Type: string

The supported Kubernetes version of the cluster.

defaultVersion
Type: boolean

The supported default version.

platformVersions
Type: Array of strings

The supported compute platform.

ConnectorConfigRequest

Description

The configuration sent to a cluster for configuration.

Members
provider
Required: Yes
Type: string

The cloud provider for the target cluster to connect.

roleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the role that is authorized to request the connector configuration.

ConnectorConfigResponse

Description

The full description of your connected cluster.

Members
activationCode
Type: string

A unique code associated with the cluster for registration purposes.

activationExpiry
Type: timestamp (string|DateTime or anything parsable by strtotime)

The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.

activationId
Type: string

A unique ID associated with the cluster for registration purposes.

provider
Type: string

The cluster's cloud service provider.

roleArn
Type: string

The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.

ControlPlanePlacementRequest

Description

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.

Members
groupName
Type: string

The name of the placement group for the Kubernetes control plane instances. This setting can't be changed after cluster creation.

ControlPlanePlacementResponse

Description

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.

Members
groupName
Type: string

The name of the placement group for the Kubernetes control plane instances.

CreateAccessConfigRequest

Description

The access configuration information for the cluster.

Members
authenticationMode
Type: 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.

bootstrapClusterCreatorAdminPermissions
Type: 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.

DeprecationDetail

Description

The summary information about deprecated resource usage for an insight check in the UPGRADE_READINESS category.

Members
clientStats
Type: Array of ClientStat structures

Details about Kubernetes clients using the deprecated resources.

replacedWith
Type: string

The newer version of the resource to migrate to if applicable.

startServingReplacementVersion
Type: string

The version of the software where the newer resource version became available to migrate to if applicable.

stopServingVersion
Type: string

The version of the software where the deprecated resource version will stop being served.

usage
Type: string

The deprecated version of the resource.

EksAnywhereSubscription

Description

An EKS Anywhere subscription authorizing the customer to support for licensed clusters and access to EKS Anywhere Curated Packages.

Members
arn
Type: string

The Amazon Resource Name (ARN) for the subscription.

autoRenew
Type: boolean

A boolean indicating whether or not a subscription will auto renew when it expires.

createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix timestamp in seconds for when the subscription was created.

effectiveDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix timestamp in seconds for when the subscription is effective.

expirationDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object.

id
Type: string

UUID identifying a subscription.

licenseArns
Type: Array of strings

Amazon Web Services License Manager ARN associated with the subscription.

licenseQuantity
Type: int

The number of licenses included in a subscription. Valid values are between 1 and 100.

licenseType
Type: 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.

status
Type: string

The status of a subscription.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

term
Type: EksAnywhereSubscriptionTerm structure

An EksAnywhereSubscriptionTerm object.

EksAnywhereSubscriptionTerm

Description

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.

Members
duration
Type: int

The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription.

unit
Type: string

The term unit of the subscription. Valid value is MONTHS.

EncryptionConfig

Description

The encryption configuration for the cluster.

Members
provider
Type: Provider structure

Key Management Service (KMS) key. Either the ARN or the alias can be used.

resources
Type: Array of strings

Specifies the resources to be encrypted. The only supported value is secrets.

ErrorDetail

Description

An object representing an error when an asynchronous operation fails.

Members
errorCode
Type: 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
Type: string

A more complete description of the error.

resourceIds
Type: Array of strings

An optional field that contains the resource IDs associated with the error.

FargateProfile

Description

An object representing an Fargate profile.

Members
clusterName
Type: string

The name of your cluster.

createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix epoch timestamp at object creation.

fargateProfileArn
Type: string

The full Amazon Resource Name (ARN) of the Fargate profile.

fargateProfileName
Type: string

The name of the Fargate profile.

health
Type: FargateProfileHealth structure

The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here.

podExecutionRoleArn
Type: 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.

selectors
Type: Array of FargateProfileSelector structures

The selectors to match for a Pod to use this Fargate profile.

status
Type: string

The current status of the Fargate profile.

subnets
Type: Array of strings

The IDs of subnets to launch a Pod into.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

FargateProfileHealth

Description

The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here.

Members
issues
Type: Array of FargateProfileIssue structures

Any issues that are associated with the Fargate profile.

FargateProfileIssue

Description

An issue that is associated with the Fargate profile.

Members
code
Type: string

A brief description of the error.

message
Type: string

The error message associated with the issue.

resourceIds
Type: Array of strings

The Amazon Web Services resources that are affected by this issue.

FargateProfileSelector

Description

An object representing an Fargate profile selector.

Members
labels
Type: Associative array of custom strings keys (String) to strings

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.

namespace
Type: string

The Kubernetes namespace that the selector should match.

Identity

Description

An object representing an identity provider.

Members
oidc
Type: OIDC structure

An object representing the OpenID Connect identity provider information.

IdentityProviderConfig

Description

An object representing an identity provider configuration.

Members
name
Required: Yes
Type: string

The name of the identity provider configuration.

type
Required: Yes
Type: string

The type of the identity provider configuration. The only type available is oidc.

IdentityProviderConfigResponse

Description

The full description of your identity configuration.

Members
oidc
Type: OidcIdentityProviderConfig structure

An object representing an OpenID Connect (OIDC) identity provider configuration.

Insight

Description

A check that provides recommendations to remedy potential upgrade-impacting issues.

Members
additionalInfo
Type: Associative array of custom strings keys (String) to strings

Links to sources that provide additional context on the insight.

category
Type: string

The category of the insight.

categorySpecificSummary

Summary information that relates to the category of the insight. Currently only returned with certain insights having category UPGRADE_READINESS.

description
Type: string

The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).

id
Type: string

The ID of the insight.

insightStatus
Type: InsightStatus structure

An object containing more detail on the status of the insight resource.

kubernetesVersion
Type: string

The Kubernetes minor version associated with an insight if applicable.

lastRefreshTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.

lastTransitionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the status of the insight last changed.

name
Type: string

The name of the insight.

recommendation
Type: string

A summary of how to remediate the finding of this insight if applicable.

resources
Type: Array of InsightResourceDetail structures

The details about each resource listed in the insight check result.

InsightCategorySpecificSummary

Description

Summary information that relates to the category of the insight. Currently only returned with certain insights having category UPGRADE_READINESS.

Members
deprecationDetails
Type: Array of DeprecationDetail structures

The summary information about deprecated resource usage for an insight check in the UPGRADE_READINESS category.

InsightResourceDetail

Description

Returns information about the resource being evaluated.

Members
arn
Type: string

The Amazon Resource Name (ARN) if applicable.

insightStatus
Type: InsightStatus structure

An object containing more detail on the status of the insight resource.

kubernetesResourceUri
Type: string

The Kubernetes resource URI if applicable.

InsightStatus

Description

The status of the insight.

Members
reason
Type: string

Explanation on the reasoning for the status of the resource.

status
Type: string

The status of the resource.

InsightSummary

Description

The summarized description of the insight.

Members
category
Type: string

The category of the insight.

description
Type: string

The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).

id
Type: string

The ID of the insight.

insightStatus
Type: InsightStatus structure

An object containing more detail on the status of the insight.

kubernetesVersion
Type: string

The Kubernetes minor version associated with an insight if applicable.

lastRefreshTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.

lastTransitionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the status of the insight last changed.

name
Type: string

The name of the insight.

InsightsFilter

Description

The criteria to use for the insights.

Members
categories
Type: Array of strings

The categories to use to filter insights.

kubernetesVersions
Type: Array of strings

The Kubernetes versions to use to filter the insights.

statuses
Type: Array of strings

The statuses to use to filter the insights.

InvalidParameterException

Description

The specified parameter is invalid. Review the available parameters for the API request.

Members
addonName
Type: string

The specified parameter for the add-on name is invalid. Review the available parameters for the API request

clusterName
Type: string

The Amazon EKS cluster associated with the exception.

fargateProfileName
Type: string

The Fargate profile associated with the exception.

message
Type: string

The specified parameter is invalid. Review the available parameters for the API request.

nodegroupName
Type: string

The Amazon EKS managed node group associated with the exception.

subscriptionId
Type: string

The Amazon EKS subscription ID with the exception.

InvalidRequestException

Description

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

Members
addonName
Type: string

The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations.

clusterName
Type: string

The Amazon EKS cluster associated with the exception.

message
Type: string

The Amazon EKS add-on name associated with the exception.

nodegroupName
Type: string

The Amazon EKS managed node group associated with the exception.

subscriptionId
Type: string

The Amazon EKS subscription ID with the exception.

Issue

Description

An object representing an issue with an Amazon EKS resource.

Members
code
Type: 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.

  • 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
Type: string

The error message associated with the issue.

resourceIds
Type: Array of strings

The Amazon Web Services resources that are afflicted by this issue.

KubernetesNetworkConfigRequest

Description

The Kubernetes network configuration for the cluster.

Members
ipFamily
Type: 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.

serviceIpv4Cidr
Type: 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.

You can only specify a custom CIDR block when you create a cluster. You can't change this value after the cluster is created.

KubernetesNetworkConfigResponse

Description

The Kubernetes network configuration for the cluster. The response contains a value for serviceIpv6Cidr or serviceIpv4Cidr, but not both.

Members
ipFamily
Type: 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.

serviceIpv4Cidr
Type: 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
Type: 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.

LaunchTemplateSpecification

Description

An object representing a node group launch template specification. The launch template can't include SubnetId , IamInstanceProfile , RequestSpotInstances , HibernationOptions , or TerminateInstances , or the node group deployment or update will fail. For more information about launch templates, see CreateLaunchTemplate in the Amazon EC2 API Reference. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

You must specify either the launch template ID or the launch template name in the request, but not both.

Members
id
Type: 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.

name
Type: 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.

version
Type: string

The version number of the launch template to use. If no version is specified, then the template's default version is used.

LogSetup

Description

An object representing the enabled or disabled Kubernetes control plane logs for your cluster.

Members
enabled
Type: 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.

types
Type: Array of strings

The available cluster control plane log types.

Logging

Description

An object representing the logging configuration for resources in your cluster.

Members
clusterLogging
Type: Array of LogSetup structures

The cluster control plane logging configuration for your cluster.

MarketplaceInformation

Description

Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.

Members
productId
Type: string

The product ID from the Amazon Web Services Marketplace.

productUrl
Type: string

The product URL from the Amazon Web Services Marketplace.

Nodegroup

Description

An object representing an Amazon EKS managed node group.

Members
amiType
Type: 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.

capacityType
Type: string

The capacity type of your managed node group.

clusterName
Type: string

The name of your cluster.

createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix epoch timestamp at object creation.

diskSize
Type: int

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
Type: NodegroupHealth structure

The health status of the node group. If there are issues with your node group's health, they are listed here.

instanceTypes
Type: Array of strings

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.

labels
Type: Associative array of custom strings keys (labelKey) to strings

The Kubernetes labels applied to the nodes in the node group.

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.

launchTemplate
Type: LaunchTemplateSpecification structure

If a launch template was used to create the node group, then this is the launch template that was used.

modifiedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix epoch timestamp for the last modification to the object.

nodeRole
Type: 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.

nodegroupArn
Type: string

The Amazon Resource Name (ARN) associated with the managed node group.

nodegroupName
Type: string

The name associated with an Amazon EKS managed node group.

releaseVersion
Type: 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.

remoteAccess
Type: RemoteAccessConfig structure

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.

resources
Type: NodegroupResources structure

The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

scalingConfig
Type: NodegroupScalingConfig structure

The scaling configuration details for the Auto Scaling group that is associated with your node group.

status
Type: string

The current status of the managed node group.

subnets
Type: Array of strings

The subnets that were specified for the Auto Scaling group that is associated with your node group.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

taints
Type: Array of Taint structures

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.

updateConfig
Type: NodegroupUpdateConfig structure

The node group update configuration.

version
Type: string

The Kubernetes version of the managed node group.

NodegroupHealth

Description

An object representing the health status of the node group.

Members
issues
Type: Array of Issue structures

Any issues that are associated with the node group.

NodegroupResources

Description

An object representing the resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

Members
autoScalingGroups
Type: Array of AutoScalingGroup structures

The Auto Scaling groups associated with the node group.

remoteAccessSecurityGroup
Type: string

The remote access security group associated with the node group. This security group controls SSH access to the nodes.

NodegroupScalingConfig

Description

An object representing the scaling configuration details for the Auto Scaling group that is associated with your node group. When creating a node group, you must specify all or none of the properties. When updating a node group, you can specify any or none of the properties.

Members
desiredSize
Type: int

The current number of nodes that the managed node group should maintain.

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.

maxSize
Type: int

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.

minSize
Type: int

The minimum number of nodes that the managed node group can scale in to.

NodegroupUpdateConfig

Description

The node group update configuration.

Members
maxUnavailable
Type: int

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
Type: int

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.

NotFoundException

Description

A service resource associated with the request could not be found. Clients should not retry such requests.

Members
message
Type: string

A service resource associated with the request could not be found. Clients should not retry such requests.

OIDC

Description

An object representing the OpenID Connect (OIDC) identity provider information for the cluster.

Members
issuer
Type: string

The issuer URL for the OIDC identity provider.

OidcIdentityProviderConfig

Description

An object representing the configuration for an OpenID Connect (OIDC) identity provider.

Members
clientId
Type: string

This is also known as audience. The ID of the client application that makes authentication requests to the OIDC identity provider.

clusterName
Type: string

The name of your cluster.

groupsClaim
Type: string

The JSON web token (JWT) claim that the provider uses to return your groups.

groupsPrefix
Type: 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:

identityProviderConfigArn
Type: string

The ARN of the configuration.

identityProviderConfigName
Type: string

The name of the configuration.

issuerUrl
Type: string

The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.

requiredClaims
Type: Associative array of custom strings keys (requiredClaimsKey) to strings

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.

status
Type: string

The status of the OIDC identity provider.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

usernameClaim
Type: string

The JSON Web token (JWT) claim that is used as the username.

usernamePrefix
Type: string

The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system:

OidcIdentityProviderConfigRequest

Description

An object representing an OpenID Connect (OIDC) configuration. Before associating an OIDC identity provider to your cluster, review the considerations in Authenticating users for your cluster from an OIDC identity provider in the Amazon EKS User Guide.

Members
clientId
Required: Yes
Type: string

This is also known as audience. The ID for the client application that makes authentication requests to the OIDC identity provider.

groupsClaim
Type: string

The JWT claim that the provider uses to return your groups.

groupsPrefix
Type: 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.

identityProviderConfigName
Required: Yes
Type: string

The name of the OIDC provider configuration.

issuerUrl
Required: Yes
Type: string

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.

requiredClaims
Type: Associative array of custom strings keys (requiredClaimsKey) to strings

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.

usernameClaim
Type: 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
Type: 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.

OutpostConfigRequest

Description

The configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a cluster on an Outpost, review Creating a local cluster on an Outpost in the Amazon EKS User Guide. This API isn't available for Amazon EKS clusters on the Amazon Web Services cloud.

Members
controlPlaneInstanceType
Required: Yes
Type: string

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

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.

outpostArns
Required: Yes
Type: Array of strings

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.

OutpostConfigResponse

Description

An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This API isn't available for Amazon EKS clusters on the Amazon Web Services cloud.

Members
controlPlaneInstanceType
Required: Yes
Type: string

The Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances.

controlPlanePlacement

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.

outpostArns
Required: Yes
Type: Array of strings

The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.

PodIdentityAssociation

Description

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.

Members
associationArn
Type: string

The Amazon Resource Name (ARN) of the association.

associationId
Type: string

The ID of the association.

clusterName
Type: string

The name of the cluster that the association is in.

createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp that the association was created at.

modifiedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The most recent timestamp that the association was modified at

namespace
Type: 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.

ownerArn
Type: string

If defined, the Pod Identity Association is owned by an Amazon EKS Addon.

roleArn
Type: 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.

serviceAccount
Type: string

The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

PodIdentityAssociationSummary

Description

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

Members
associationArn
Type: string

The Amazon Resource Name (ARN) of the association.

associationId
Type: string

The ID of the association.

clusterName
Type: string

The name of the cluster that the association is in.

namespace
Type: 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.

ownerArn
Type: string

If defined, the Pod Identity Association is owned by an Amazon EKS Addon.

serviceAccount
Type: string

The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

Provider

Description

Identifies the Key Management Service (KMS) key used to encrypt the secrets.

Members
keyArn
Type: 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.

RemoteAccessConfig

Description

An object representing the remote access configuration for the managed node group.

Members
ec2SshKey
Type: 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
Type: Array of strings

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.

ResourceInUseException

Description

The specified resource is in use.

Members
addonName
Type: string

The specified add-on name is in use.

clusterName
Type: string

The Amazon EKS cluster associated with the exception.

message
Type: string

The Amazon EKS message associated with the exception.

nodegroupName
Type: string

The Amazon EKS managed node group associated with the exception.

ResourceLimitExceededException

Description

You have encountered a service limit on the specified resource.

Members
clusterName
Type: string

The Amazon EKS cluster associated with the exception.

message
Type: string

The Amazon EKS message associated with the exception.

nodegroupName
Type: string

The Amazon EKS managed node group associated with the exception.

subscriptionId
Type: string

The Amazon EKS subscription ID with the exception.

ResourceNotFoundException

Description

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

Members
addonName
Type: string

The Amazon EKS add-on name associated with the exception.

clusterName
Type: string

The Amazon EKS cluster associated with the exception.

fargateProfileName
Type: string

The Fargate profile associated with the exception.

message
Type: string

The Amazon EKS message associated with the exception.

nodegroupName
Type: string

The Amazon EKS managed node group associated with the exception.

subscriptionId
Type: string

The Amazon EKS subscription ID with the exception.

ResourcePropagationDelayException

Description

Required resources (such as service-linked roles) were created and are still propagating. Retry later.

Members
message
Type: string

Required resources (such as service-linked roles) were created and are still propagating. Retry later.

ServerException

Description

These errors are usually caused by a server-side issue.

Members
addonName
Type: string

The Amazon EKS add-on name associated with the exception.

clusterName
Type: string

The Amazon EKS cluster associated with the exception.

message
Type: string

These errors are usually caused by a server-side issue.

nodegroupName
Type: string

The Amazon EKS managed node group associated with the exception.

subscriptionId
Type: string

The Amazon EKS subscription ID with the exception.

ServiceUnavailableException

Description

The service is unavailable. Back off and retry the operation.

Members
message
Type: string

The request has failed due to a temporary failure of the server.

Taint

Description

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.

Members
effect
Type: string

The effect of the taint.

key
Type: string

The key of the taint.

value
Type: string

The value of the taint.

UnsupportedAvailabilityZoneException

Description

At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

Members
clusterName
Type: string

The Amazon EKS cluster associated with the exception.

message
Type: string

At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

nodegroupName
Type: string

The Amazon EKS managed node group associated with the exception.

validZones
Type: Array of strings

The supported Availability Zones for your account. Choose subnets in these Availability Zones for your cluster.

Update

Description

An object representing an asynchronous update.

Members
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix epoch timestamp at object creation.

errors
Type: Array of ErrorDetail structures

Any errors associated with a Failed update.

id
Type: string

A UUID that is used to track the update.

params
Type: Array of UpdateParam structures

A key-value map that contains the parameters associated with the update.

status
Type: string

The current status of the update.

type
Type: string

The type of the update.

UpdateAccessConfigRequest

Description

The access configuration information for the cluster.

Members
authenticationMode
Type: string

The desired authentication mode for the cluster.

UpdateLabelsPayload

Description

An object representing a Kubernetes label change for a managed node group.

Members
addOrUpdateLabels
Type: Associative array of custom strings keys (labelKey) to strings

The Kubernetes labels to add or update.

removeLabels
Type: Array of strings

The Kubernetes labels to remove.

UpdateParam

Description

An object representing the details of an update request.

Members
type
Type: string

The keys associated with an update request.

value
Type: string

The value of the keys submitted as part of an update request.

UpdateTaintsPayload

Description

An object representing the details of an update to a taints payload. For more information, see Node taints on managed node groups in the Amazon EKS User Guide.

Members
addOrUpdateTaints
Type: Array of Taint structures

Kubernetes taints to be added or updated.

removeTaints
Type: Array of Taint structures

Kubernetes taints to remove.

UpgradePolicyRequest

Description

The support policy to use for the cluster. Extended support allows you to remain on specific Kubernetes versions for longer. Clusters in extended support have higher costs. The default value is EXTENDED. Use STANDARD to disable extended support.

Learn more about EKS Extended Support in the EKS User Guide.

Members
supportType
Type: 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 EKS User Guide.

VpcConfigRequest

Description

An object representing the VPC configuration to use for an Amazon EKS cluster.

Members
endpointPrivateAccess
Type: boolean

Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

endpointPublicAccess
Type: boolean

Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

publicAccessCidrs
Type: Array of strings

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate Pod in the cluster. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

securityGroupIds
Type: Array of strings

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 .

subnetIds
Type: Array of strings

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.

VpcConfigResponse

Description

An object representing an Amazon EKS cluster VPC configuration response.

Members
clusterSecurityGroupId
Type: 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.

endpointPrivateAccess
Type: boolean

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

endpointPublicAccess
Type: boolean

Whether the public API server endpoint is enabled.

publicAccessCidrs
Type: Array of strings

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint.

securityGroupIds
Type: Array of strings

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.

subnetIds
Type: Array of strings

The subnets associated with your cluster.

vpcId
Type: string

The VPC associated with your cluster.