AWS SDK for PHP 3.x

Service ID: eks

Version: 2017-11-01

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

Operation Summary

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

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

CreateCluster ( array $params = [] )
Creates an Amazon EKS control plane.
CreateNodegroup ( array $params = [] )
Creates a managed worker node group for an Amazon EKS cluster.
DeleteCluster ( array $params = [] )
Deletes the Amazon EKS cluster control plane.
DeleteNodegroup ( array $params = [] )
Deletes an Amazon EKS node group for a cluster.
DescribeCluster ( array $params = [] )
Returns descriptive information about an Amazon EKS cluster.
DescribeNodegroup ( array $params = [] )
Returns descriptive information about an Amazon EKS node group.
DescribeUpdate ( array $params = [] )
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
ListClusters ( array $params = [] )
Lists the Amazon EKS clusters in your AWS account in the specified Region.
ListNodegroups ( array $params = [] )
Lists the Amazon EKS node groups associated with the specified cluster in your AWS account in the specified Region.
ListTagsForResource ( array $params = [] )
List the tags for an Amazon EKS resource.
ListUpdates ( array $params = [] )
Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.
TagResource ( array $params = [] )
Associates the specified tags to a resource with the specified resourceArn.
UntagResource ( array $params = [] )
Deletes specified tags from a resource.
UpdateClusterConfig ( array $params = [] )
Updates an Amazon EKS cluster configuration.
UpdateClusterVersion ( array $params = [] )
Updates an Amazon EKS cluster to the specified Kubernetes version.
UpdateNodegroupConfig ( array $params = [] )
Updates an Amazon EKS managed node group configuration.
UpdateNodegroupVersion ( array $params = [] )
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

Paginators

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

ListClusters
ListNodegroups
ListUpdates

Waiters

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

Waiter name	API Operation	Delay	Max Attempts
ClusterActive	DescribeCluster	30	40
ClusterDeleted	DescribeCluster	30	40
NodegroupActive	DescribeNodegroup	30	80
NodegroupDeleted	DescribeNodegroup	30	40

Operations

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 AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its own set of Amazon EC2 instances.

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

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

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

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

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

Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide.

Parameter Syntax

$result = $client->createCluster([
    'clientRequestToken' => '<string>',
    'logging' => [
        'clusterLogging' => [
            [
                'enabled' => true || false,
                'types' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'resourcesVpcConfig' => [ // REQUIRED
        'endpointPrivateAccess' => true || false,
        'endpointPublicAccess' => true || false,
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'version' => '<string>',
]);

Parameter Details

Members

clientRequestToken

Type: string

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

logging

Type: Logging structure

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

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

name

Required: Yes
Type: string

The unique name to give to your cluster.

resourcesVpcConfig

Required: Yes
Type: VpcConfigRequest structure

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

roleArn

Required: Yes
Type: string

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

tags

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

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

version

Type: string

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

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'createdAt' => <DateTime>,
        'endpoint' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members

cluster

Type: Cluster structure

The full description of your new cluster.

Errors

ResourceInUseException:
The specified resource is in use.
ResourceLimitExceededException:
You have encountered a service limit on the specified resource.
InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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:

[
]

CreateNodegroup

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

Creates a managed worker 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.

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS-optimized Amazon Linux 2 AMI. 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',
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'diskSize' => <integer>,
    'instanceTypes' => ['<string>', ...],
    'labels' => ['<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>', ...],
    'version' => '<string>',
]);

Parameter Details

Members

amiType

Type: string

The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support; non-GPU instances should use the AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI.

clientRequestToken

Type: string

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

clusterName

Required: Yes
Type: string

The name of the cluster to create the node group in.

diskSize

Type: int

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB.

instanceTypes

Type: Array of strings

The instance type to use for your node group. Currently, you can specify a single instance type for a node group. The default value for this parameter is t3.medium. If you choose a GPU instance type, be sure to specify the AL2_x86_64_GPU with the amiType parameter.

labels

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

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

nodeRole

Required: Yes
Type: string

The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM Role in the Amazon EKS User Guide .

nodegroupName

Required: Yes
Type: string

The unique name to give your node group.

releaseVersion

Type: string

The AMI version of the Amazon EKS-optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.

remoteAccess

Type: RemoteAccessConfig structure

The remote access (SSH) configuration to use with your node group.

scalingConfig

Type: NodegroupScalingConfig structure

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

subnets

Required: Yes
Type: Array of strings

The subnets to use for the AutoScaling group that is created for your node group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME with a value of shared, where CLUSTER_NAME is replaced with the name of your cluster.

tags

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

The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

version

Type: string

The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value.

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AutoScalingGroupNotFound|Ec2SecurityGroupNotFound|Ec2SecurityGroupDeletionFailure|Ec2LaunchTemplateNotFound|Ec2LaunchTemplateVersionMismatch|IamInstanceProfileNotFound|IamNodeRoleNotFound|AsgInstanceLaunchFailures|InstanceLimitExceeded|InsufficientFreeAddresses|AccessDenied|InternalFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<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>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members

nodegroup

Type: Nodegroup structure

The full description of your new node group.

Errors

ResourceInUseException:
The specified resource is in use.
ResourceLimitExceededException:
You have encountered a service limit on the specified resource.
InvalidRequestException:
The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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.

DeleteCluster

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

Deletes the 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 attached to the cluster, you must delete them first. For more information, see DeleteNodegroup.

Parameter Syntax

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

Parameter Details

Members

name

Required: Yes
Type: string

The name of the cluster to delete.

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'createdAt' => <DateTime>,
        'endpoint' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members

cluster

Type: Cluster structure

The full description of the cluster to delete.

Errors

ResourceInUseException:
The specified resource is in use.
ResourceNotFoundException:
The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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:

[
]

DeleteNodegroup

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

Deletes an Amazon EKS node group for a cluster.

Parameter Syntax

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

Parameter Details

Members

clusterName

Required: Yes
Type: string

The name of the Amazon EKS cluster that is associated with your node group.

nodegroupName

Required: Yes
Type: string

The name of the node group to delete.

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AutoScalingGroupNotFound|Ec2SecurityGroupNotFound|Ec2SecurityGroupDeletionFailure|Ec2LaunchTemplateNotFound|Ec2LaunchTemplateVersionMismatch|IamInstanceProfileNotFound|IamNodeRoleNotFound|AsgInstanceLaunchFailures|InstanceLimitExceeded|InsufficientFreeAddresses|AccessDenied|InternalFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<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>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members

nodegroup

Type: Nodegroup structure

The full description of your deleted node group.

Errors

ResourceInUseException:
The specified resource is in use.
ResourceNotFoundException:
The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are 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 a user 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.

DescribeCluster

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

Returns descriptive information about 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 Create a kubeconfig for Amazon EKS.

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

Parameter Syntax

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

Parameter Details

Members

name

Required: Yes
Type: string

The name of the cluster to describe.

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'createdAt' => <DateTime>,
        'endpoint' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members

cluster

Type: Cluster structure

The full description of your specified cluster.

Errors

ResourceNotFoundException:
The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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',
    ],
]

DescribeNodegroup

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

Returns descriptive information about an Amazon EKS node group.

Parameter Syntax

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

Parameter Details

Members

clusterName

Required: Yes
Type: string

The name of the Amazon EKS cluster associated with the node group.

nodegroupName

Required: Yes
Type: string

The name of the node group to describe.

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AutoScalingGroupNotFound|Ec2SecurityGroupNotFound|Ec2SecurityGroupDeletionFailure|Ec2LaunchTemplateNotFound|Ec2LaunchTemplateVersionMismatch|IamInstanceProfileNotFound|IamNodeRoleNotFound|AsgInstanceLaunchFailures|InstanceLimitExceeded|InsufficientFreeAddresses|AccessDenied|InternalFailure',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<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>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members

nodegroup

Type: Nodegroup structure

The full description of your node group.

Errors

InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ResourceNotFoundException:
The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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.

DescribeUpdate

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

Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.

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([
    'name' => '<string>', // REQUIRED
    'nodegroupName' => '<string>',
    'updateId' => '<string>', // REQUIRED
]);

Parameter Details

Members

name

Required: Yes
Type: string

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

nodegroupName

Type: string

The name of the Amazon EKS node group associated with the update.

updateId

Required: Yes
Type: string

The ID of the update to describe.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate',
    ],
]

Result Details

Members

update

Type: Update structure

The full description of the specified update.

Errors

InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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 Region-specific.

ListClusters

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

Lists the Amazon EKS clusters in your AWS account in the specified Region.

Parameter Syntax

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

Parameter Details

Members

maxResults

Type: int

The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

nextToken

Type: string

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Result Syntax

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

Result Details

Members

clusters

Type: Array of strings

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

nextToken

Type: string

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Errors

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 a user 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',
    ],
]

ListNodegroups

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

Lists the Amazon EKS node groups associated with the specified cluster in your AWS account in the specified Region.

Parameter Syntax

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

Parameter Details

Members

clusterName

Required: Yes
Type: string

The name of the Amazon EKS cluster that you would like to list node groups in.

maxResults

Type: int

The maximum number of node group results returned by ListNodegroups in paginated output. When you use this parameter, ListNodegroups returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListNodegroups request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListNodegroups returns up to 100 results and a nextToken value if applicable.

nextToken

Type: string

The nextToken value returned from a previous paginated ListNodegroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Result Syntax

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

Result Details

Members

nextToken

Type: string

The nextToken value to include in a future ListNodegroups request. When the results of a ListNodegroups request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

nodegroups

Type: Array of strings

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

Errors

InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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 Region-specific.

ListTagsForResource

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

List the tags for an Amazon EKS resource.

Parameter Syntax

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

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

Result Syntax

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

Result Details

Members

tags

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

The tags for the resource.

Errors

BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.
NotFoundException:
A service resource associated with the request could not be found. Clients should not retry such requests.

Examples

Example 1: To list tags for a cluster

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

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

Result syntax:

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

ListUpdates

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

Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.

Parameter Syntax

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

Parameter Details

Members

maxResults

Type: int

The maximum number of update results returned by ListUpdates in paginated output. When you use this parameter, ListUpdates returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListUpdates request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListUpdates returns up to 100 results and a nextToken value if applicable.

name

Required: Yes
Type: string

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

nextToken

Type: string

The nextToken value returned from a previous paginated ListUpdates request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

nodegroupName

Type: string

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

Result Syntax

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

Result Details

Members

nextToken

Type: string

The nextToken value to include in a future ListUpdates request. When the results of a ListUpdates request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

updateIds

Type: Array of strings

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

Errors

InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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 Region-specific.

TagResource

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

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag does not automatically propagate to the subnets and worker nodes associated with the cluster.

Parameter Syntax

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

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

tags

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

The tags to add to the resource. A tag is an array of key-value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.
NotFoundException:
A service resource associated with the request could not be found. Clients should not retry such requests.

UntagResource

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

Deletes specified tags from a resource.

Parameter Syntax

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

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

tagKeys

Required: Yes
Type: Array of strings

The keys of the tags to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.
NotFoundException:
A service resource associated with the request could not be found. Clients should not retry such requests.

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 the DescribeUpdate API operation.

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

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

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

At this time, you can not update the subnets or security group IDs for an existing 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([
    'clientRequestToken' => '<string>',
    'logging' => [
        'clusterLogging' => [
            [
                'enabled' => true || false,
                'types' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'resourcesVpcConfig' => [
        'endpointPrivateAccess' => true || false,
        'endpointPublicAccess' => true || false,
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Members

clientRequestToken

Type: string

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

logging

Type: Logging structure

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

name

Required: Yes
Type: string

The name of the Amazon EKS cluster to update.

resourcesVpcConfig

Type: VpcConfigRequest structure

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

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate',
    ],
]

Result Details

Members

update

Type: Update structure

An object representing an asynchronous update.

Errors

InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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 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.

If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.

Parameter Syntax

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

Parameter Details

Members

clientRequestToken

Type: string

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

name

Required: Yes
Type: string

The name of the Amazon EKS cluster to update.

version

Required: Yes
Type: string

The desired Kubernetes version following a successful update.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate',
    ],
]

Result Details

Members

update

Type: Update structure

The full description of the specified update

Errors

InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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 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>,
    ],
]);

Parameter Details

Members

clientRequestToken

Type: string

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

clusterName

Required: Yes
Type: string

The name of the Amazon EKS cluster that the managed node group resides in.

labels

Type: UpdateLabelsPayload structure

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

nodegroupName

Required: Yes
Type: string

The name of the managed node group to update.

scalingConfig

Type: NodegroupScalingConfig structure

The scaling configuration details for the AutoScaling group after the update.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate',
    ],
]

Result Details

Members

update

Type: Update structure

An object representing an asynchronous update.

Errors

InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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 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 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 more information, see Amazon EKS-Optimized Linux 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, the pods in that node are 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,
    'nodegroupName' => '<string>', // REQUIRED
    'releaseVersion' => '<string>',
    'version' => '<string>',
]);

Parameter Details

Members

clientRequestToken

Type: string

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

clusterName

Required: Yes
Type: string

The name of the Amazon EKS cluster that is associated with the managed node group to update.

force

Type: boolean

Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If a previous update fails because pods could not be drained, you can force the update after it fails to terminate the old node regardless of whether or not any pods are running on the node.

nodegroupName

Required: Yes
Type: string

The name of the managed node group to update.

releaseVersion

Type: string

The AMI version of the Amazon EKS-optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.

version

Type: string

The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate',
    ],
]

Result Details

Members

update

Type: Update structure

An object representing an asynchronous update.

Errors

InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ClientException:
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user 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 Region-specific.
InvalidRequestException:
The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

Shapes

AutoScalingGroup

Description

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

Members

name

Type: string

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

BadRequestException

Description

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

Members

message

Type: string

Certificate

Description

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

Members

data

Type: string

The Base64-encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

ClientException

Description

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

Members

clusterName

Type: string

The Amazon EKS cluster associated with the exception.

message

Type: string

nodegroupName

Type: string

Cluster

Description

An object representing an Amazon EKS cluster.

Members

arn

Type: string

The Amazon Resource Name (ARN) of the cluster.

certificateAuthority

Type: Certificate structure

The certificate-authority-data for your cluster.

clientRequestToken

Type: string

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

createdAt

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

The Unix epoch timestamp in seconds for when the cluster was created.

endpoint

Type: string

The endpoint for your Kubernetes API server.

identity

Type: Identity structure

The identity provider information for the cluster.

logging

Type: Logging structure

The logging configuration for your cluster.

name

Type: string

The name of the cluster.

platformVersion

Type: string

The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .

resourcesVpcConfig

Type: VpcConfigResponse structure

roleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

status

Type: string

The current status of the cluster.

tags

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

The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.

version

Type: string

The Kubernetes server version for the cluster.

ErrorDetail

Description

An object representing an error when an asynchronous operation fails.

Members

errorCode

Type: string

A brief description of the error.

SubnetNotFound: We couldn't find one of the subnets associated with the cluster.
SecurityGroupNotFound: We couldn't find one of the security groups associated with the cluster.
EniLimitReached: You have reached the elastic network interface limit for your account.
IpNotAvailable: A subnet associated with the cluster doesn't have any free IP addresses.
AccessDenied: You don't have permissions to perform the specified operation.
OperationNotPermitted: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS.
VpcIdNotFound: We couldn't find the VPC associated with the cluster.

errorMessage

Type: string

A more complete description of the error.

resourceIds

Type: Array of strings

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

Identity

Description

An object representing an identity provider for authentication credentials.

Members

oidc

Type: OIDC structure

The OpenID Connect identity provider information for the cluster.

InvalidParameterException

Description

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

Members

clusterName

Type: string

The Amazon EKS cluster associated with the exception.

message

Type: string

nodegroupName

Type: string

InvalidRequestException

Description

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

Members

clusterName

Type: string

The Amazon EKS cluster associated with the exception.

message

Type: string

nodegroupName

Type: string

Issue

Description

An object representing an issue with an Amazon EKS resource.

Members

code

Type: string

A brief description of the error.

AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.
Ec2SecurityGroupNotFound: We couldn't find the cluster security group for the cluster. You must recreate your cluster.
Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.
Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.
Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the Amazon EKS-created version to recover.
IamInstanceProfileNotFound: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.
IamNodeRoleNotFound: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.
AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch instances.
InstanceLimitExceeded: Your AWS account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.
InsufficientFreeAddresses: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.
AccessDenied: Amazon EKS and or one or more of your managed nodes is unable to communicate with your cluster API server.
InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.

message

Type: string

The error message associated with the issue.

resourceIds

Type: Array of strings

The AWS resources that are afflicted by this issue.

LogSetup

Description

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

Members

enabled

Type: boolean

If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.

types

Type: Array of strings

The available cluster control plane log types.

Logging

Description

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

Members

clusterLogging

Type: Array of LogSetup structures

The cluster control plane logging configuration for your cluster.

Nodegroup

Description

An object representing an Amazon EKS managed node group.

Members

amiType

Type: string

The AMI type associated with your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support; non-GPU instances should use the AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI.

clusterName

Type: string

The name of the cluster that the managed node group resides in.

createdAt

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

The Unix epoch timestamp in seconds for when the managed node group was created.

diskSize

Type: int

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB.

health

Type: NodegroupHealth structure

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

instanceTypes

Type: Array of strings

The instance types associated with your node group.

labels

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

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

Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.

modifiedAt

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

The Unix epoch timestamp in seconds for when the managed node group was last modified.

nodeRole

Type: string

nodegroupArn

Type: string

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

nodegroupName

Type: string

The name associated with an Amazon EKS managed node group.

releaseVersion

Type: string

The AMI version of the managed node group. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.

remoteAccess

Type: RemoteAccessConfig structure

The remote access (SSH) configuration that is associated with the node group.

resources

Type: NodegroupResources structure

The resources associated with the nodegroup, such as AutoScaling groups and security groups for remote access.

scalingConfig

Type: NodegroupScalingConfig structure

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

status

Type: string

The current status of the managed node group.

subnets

Type: Array of strings

The subnets allowed for the AutoScaling group that is associated with your node group. These subnets must have the following tag: kubernetes.io/cluster/CLUSTER_NAME, where CLUSTER_NAME is replaced with the name of your cluster.

tags

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

The metadata applied the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

version

Type: string

The Kubernetes version of the managed node group.

NodegroupHealth

Description

An object representing the health status of the node group.

Members

issues

Type: Array of Issue structures

Any issues that are associated with the node group.

NodegroupResources

Description

An object representing the resources associated with the nodegroup, such as AutoScaling groups and security groups for remote access.

Members

autoScalingGroups

Type: Array of AutoScalingGroup structures

The autoscaling groups associated with the node group.

remoteAccessSecurityGroup

Type: string

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

NodegroupScalingConfig

Description

An object representing the scaling configuration details for the AutoScaling group that is associated with your node group.

Members

desiredSize

Type: int

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

maxSize

Type: int

The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.

minSize

Type: int

The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.

NotFoundException

Description

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

Members

message

Type: string

OIDC

Description

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

Members

issuer

Type: string

The issuer URL for the OpenID Connect identity provider.

RemoteAccessConfig

Description

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

Members

ec2SshKey

Type: string

The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

sourceSecurityGroups

Type: Array of strings

The security groups to allow SSH access (port 22) from on the worker nodes. If you specify an Amazon EC2 SSH key, but you do not specify a source security group when you create a managed node group, port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

ResourceInUseException

Description

The specified resource is in use.

Members

clusterName

Type: string

The Amazon EKS cluster associated with the exception.

message

Type: string

nodegroupName

Type: string

ResourceLimitExceededException

Description

You have encountered a service limit on the specified resource.

Members

clusterName

Type: string

The Amazon EKS cluster associated with the exception.

message

Type: string

nodegroupName

Type: string

ResourceNotFoundException

Description

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

Members

clusterName

Type: string

The Amazon EKS cluster associated with the exception.

message

Type: string

nodegroupName

Type: string

ServerException

Description

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

Members

clusterName

Type: string

The Amazon EKS cluster associated with the exception.

message

Type: string

nodegroupName

Type: string

ServiceUnavailableException

Description

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

Members

message

Type: string

UnsupportedAvailabilityZoneException

Description

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

Members

clusterName

Type: string

The Amazon EKS cluster associated with the exception.

message

Type: string

nodegroupName

Type: string

validZones

Type: Array of strings

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

Update

Description

An object representing an asynchronous update.

Members

createdAt

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

The Unix epoch timestamp in seconds for when the update was created.

errors

Type: Array of ErrorDetail structures

Any errors associated with a Failed update.

id

Type: string

A UUID that is used to track the update.

params

Type: Array of UpdateParam structures

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

status

Type: string

The current status of the update.

type

Type: string

The type of the update.

UpdateLabelsPayload

Description

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

Members

addOrUpdateLabels

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

Kubernetes labels to be added or updated.

removeLabels

Type: Array of strings

Kubernetes labels to be removed.

UpdateParam

Description

An object representing the details of an update request.

Members

type

Type: string

The keys associated with an update request.

value

Type: string

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

VpcConfigRequest

Description

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

Members

endpointPrivateAccess

Type: boolean

Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

endpointPublicAccess

Type: boolean

Set this value to false to disable public access for your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can receive only requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

securityGroupIds

Type: Array of strings

Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.

subnetIds

Type: Array of strings

Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.

VpcConfigResponse

Description

An object representing an Amazon EKS cluster VPC configuration response.

Members

clusterSecurityGroupId

Type: string

The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.

endpointPrivateAccess

Type: boolean

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet.

endpointPublicAccess

Type: boolean

This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can receive only requests that originate from within the cluster VPC.

securityGroupIds

Type: Array of strings

The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.

subnetIds

Type: Array of strings

The subnets associated with your cluster.

vpcId

Type: string

The VPC associated with your cluster.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Elastic Kubernetes Service 2017-11-01

Operation Summary

Paginators

Waiters

Operations

CreateCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a new cluster

CreateNodegroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To delete a cluster

DeleteNodegroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To describe a cluster

DescribeNodegroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeUpdate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListClusters

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members