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.
ListClusters ( array $params = [] )
Lists the Amazon EKS clusters in your AWS account in the specified region.

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

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.

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

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 Nodesin the Amazon EKS User Guide.

Parameter Syntax

$result = $client->createCluster([
    'clientRequestToken' => '<string>',
    'name' => '<string>', // REQUIRED
    'resourcesVpcConfig' => [ // REQUIRED
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...], // REQUIRED
    ],
    'roleArn' => '<string>', // REQUIRED
    'version' => '<string>',
]);

Parameter Details

Members

clientRequestToken

Type: string

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

name

Type: string

The unique name to give to your cluster.

resourcesVpcConfig

Required: Yes
Type: VpcConfigRequest structure

The VPC subnets and security groups used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide.

roleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role that provides permissions for 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 do not 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>',
        'name' => '<string>',
        'resourcesVpcConfig' => [
            '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, such as 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 will specify 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

Type: string

The name of the cluster to delete.

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'createdAt' => <DateTime>,
        'endpoint' => '<string>',
        'name' => '<string>',
        'resourcesVpcConfig' => [
            '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, such as 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 are not available until the cluster reaches the ACTIVE state.

Parameter Syntax

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

Parameter Details

Members

name

Type: string

The name of the cluster to describe.

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'createdAt' => <DateTime>,
        'endpoint' => '<string>',
        'name' => '<string>',
        'resourcesVpcConfig' => [
            '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, such as 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',
    ],
]

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 this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then 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 only used 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, this value can be used 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, such as 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',
    ],
]

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, such as 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 you provide to ensure the idempotency of the request.

createdAt

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

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

endpoint

Type: string

The endpoint for your Kubernetes API server.

name

Type: string

The name of the cluster.

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.

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

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

VpcConfigRequest

Description

An object representing an Amazon EKS cluster VPC configuration request.

Members

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.

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

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

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

ListClusters

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To list your available clusters

Shapes

Certificate

Description

Members

ClientException

Description

Members

Cluster

Description

Members

InvalidParameterException

Description

Members

ResourceInUseException

Description

Members

ResourceLimitExceededException

Description

Members

ResourceNotFoundException

Description

Members

ServerException

Description

Members

ServiceUnavailableException

Description

Members

UnsupportedAvailabilityZoneException

Description

Members