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

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

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 .

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>',
    'zonalShiftConfig' => [
        'enabled' => true || false,
    ],
]);

Parameter Details

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>',
        'zonalShiftConfig' => [
            'enabled' => true || false,
        ],
    ],
]

Result Details

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

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

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

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

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.

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

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|Ec2InstanceTypeDoesNotExist',
                    '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

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

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

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

Result Syntax

[]

Result Details

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

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

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

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>',
        'zonalShiftConfig' => [
            'enabled' => true || false,
        ],
    ],
]

Result Details

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

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

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

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

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

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|Ec2InstanceTypeDoesNotExist',
                    '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

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

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

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

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>',
        'zonalShiftConfig' => [
            'enabled' => true || false,
        ],
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

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

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.

Parameter Syntax

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

Parameter Details

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>',
        'zonalShiftConfig' => [
            'enabled' => true || false,
        ],
    ],
]

Result Details

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

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

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

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

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

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

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

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

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

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|Ec2InstanceTypeDoesNotExist',
                    '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

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

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

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

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|ZonalShiftConfig',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate|ZonalShiftConfigUpdate',
    ],
]

Result Details

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

Result Syntax

[]

Result Details

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

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|ZonalShiftConfig',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate|ZonalShiftConfigUpdate',
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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>',
        'zonalShiftConfig' => [
            'enabled' => true || false,
        ],
    ],
]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

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|ZonalShiftConfig',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate|ZonalShiftConfigUpdate',
    ],
]

Result Details

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 .

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 .

You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.

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',
    ],
    'zonalShiftConfig' => [
        'enabled' => true || false,
    ],
]);

Parameter Details

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|ZonalShiftConfig',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate|ZonalShiftConfigUpdate',
    ],
]

Result Details

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

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|ZonalShiftConfig',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate|ZonalShiftConfigUpdate',
    ],
]

Result Details

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

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

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

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|ZonalShiftConfig',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate|ZonalShiftConfigUpdate',
    ],
]

Result Details

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

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|ZonalShiftConfig',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AssociateIdentityProviderConfig|DisassociateIdentityProviderConfig|AssociateEncryptionConfig|AddonUpdate|VpcConfigUpdate|AccessConfigUpdate|UpgradePolicyUpdate|ZonalShiftConfigUpdate',
    ],
]

Result Details

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

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

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.