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 Container Service for Kubernetes (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.
DeleteCluster ( array $params = [] )
Deletes the Amazon EKS cluster control plane.
DescribeCluster ( array $params = [] )
Returns descriptive information about an Amazon EKS cluster.
DescribeUpdate ( array $params = [] )
Returns descriptive information about an update against your Amazon EKS cluster.
ListClusters ( array $params = [] )
Lists the Amazon EKS clusters in your AWS account in the specified Region.
ListUpdates ( array $params = [] )
Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.
UpdateClusterConfig ( array $params = [] )
Updates an Amazon EKS cluster configuration.
UpdateClusterVersion ( array $params = [] )
Updates an Amazon EKS cluster to the specified Kubernetes version.

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

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

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>',
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED',
        '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:

[
]

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.

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>',
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED',
        '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. Amazon EKS clusters 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:

[
]

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>',
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED',
        '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. Amazon EKS clusters 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',
    ],
]

DescribeUpdate

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

Returns descriptive information about an update against your Amazon EKS cluster.

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

Parameter Details

Members

name

Required: Yes
Type: string

The name of the Amazon EKS cluster to 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',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate',
    ],
]

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. Amazon EKS clusters 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',
    ],
]

ListUpdates

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

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

Parameter Syntax

$result = $client->listUpdates([
    'maxResults' => <integer>,
    'name' => '<string>', // REQUIRED
    'nextToken' => '<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.

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. Amazon EKS clusters are Region-specific.

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',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate',
    ],
]

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. Amazon EKS clusters 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.

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',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate',
    ],
]

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. Amazon EKS clusters 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

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

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.

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.

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.

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

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

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.

ResourceInUseException

Description

The specified resource is in use.

Members

clusterName

Type: string

The Amazon EKS cluster associated with the exception.

message

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

ResourceNotFoundException

Description

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

Members

clusterName

Type: string

The Amazon EKS cluster associated with the exception.

message

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

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

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.

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

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 Container Service for Kubernetes 2017-11-01

Operation Summary

Waiters

Operations

CreateCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a new cluster

DeleteCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To delete a cluster

DescribeCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To describe a cluster

DescribeUpdate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListClusters

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To list your available clusters

ListUpdates

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

UpdateClusterConfig

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

UpdateClusterVersion

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details