Amazon Web Services - API Amazon Elastic Container Service for Kubernetes

Amazon Web Services / Amazon Elastic Container Service for Kubernetes

Amazon Elastic Container Service for Kubernetes

Amazon Elastic Container Service for Kubernetes (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to stand up or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.

License: Apache 2.0 License

Resources

GET

/clusters/{name}/updates/{updateId}

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.

Request

Path

Name	Data Type	Description
`name`	string
`updateId`	string

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`DescribeUpdateRequest`	object

Responses

200Success

Body

Name	Data Type	Description
`DescribeUpdateResponse`	object

Properties


                        update

Update

The full description of the specified update.


                        Update

object

An object representing an asynchronous update.

Properties


                        errors

ErrorDetails

Any errors associated with a Failed update.

ErrorDetails array [ErrorDetail]


                        createdAt

Timestamp

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

Timestamp dateTime


                        params

UpdateParams

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

UpdateParams array [UpdateParam]


                        type

UpdateType

The type of the update.

UpdateType string
Allowed values:
- VersionUpdate


                        status

UpdateStatus

The current status of the update.

UpdateStatus string
Allowed values:
- InProgress
- Failed
- Cancelled
- Successful

id

String

A UUID that is used to track the update.

String string

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481ClientException

Body

Name	Data Type	Description
`ClientException`

482ServerException

Body

Name	Data Type	Description
`ServerException`

483ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

GET

/clusters/{name}/updates

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

Request

Path

Name	Data Type	Description
`name`	string

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`ListUpdatesRequest`	object

Responses

200Success

Body

Name	Data Type	Description
`ListUpdatesResponse`	object

Properties


                        nextToken

String

The nextToken value to include in a future ListUpdates request. When the results of a ListUpdates 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.

String string


                        updateIds

StringList

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

StringList array [String]

String string

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481ClientException

Body

Name	Data Type	Description
`ClientException`

482ServerException

Body

Name	Data Type	Description
`ServerException`

483ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

POST

/clusters/{name}/updates

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

Request

Path

Name	Data Type	Description
`name`	string

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`UpdateClusterVersionRequest`	object

Properties


                        clientRequestToken

String

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

String string


                        version

String

The desired Kubernetes version following a successful update.

String string

Responses

200Success

Body

Name	Data Type	Description
`UpdateClusterVersionResponse`	object

Properties


                        update

Update

The full description of the specified update


                        Update

object

An object representing an asynchronous update.

Properties


                        errors

ErrorDetails

Any errors associated with a Failed update.

ErrorDetails array [ErrorDetail]


                        createdAt

Timestamp

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

Timestamp dateTime


                        params

UpdateParams

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

UpdateParams array [UpdateParam]


                        type

UpdateType

The type of the update.

UpdateType string
Allowed values:
- VersionUpdate


                        status

UpdateStatus

The current status of the update.

UpdateStatus string
Allowed values:
- InProgress
- Failed
- Cancelled
- Successful

id

String

A UUID that is used to track the update.

String string

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481ClientException

Body

Name	Data Type	Description
`ClientException`

482ServerException

Body

Name	Data Type	Description
`ServerException`

483ResourceInUseException

Body

Name	Data Type	Description
`ResourceInUseException`

484ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

485InvalidRequestException

Body

Name	Data Type	Description
`InvalidRequestException`

DELETE

/clusters/{name}

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.

Request

Path

Name	Data Type	Description
`name`	string

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`DeleteClusterRequest`	object

Examples

{
    "name": "devel"
}

Responses

200Success

Body

Name	Data Type	Description
`DeleteClusterResponse`	object

Properties


                        cluster

Cluster

The full description of the cluster to delete.


                        Cluster

object

An object representing an Amazon EKS cluster.

Properties


                        platformVersion

String

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

String string


                        clientRequestToken

String

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

String string


                        certificateAuthority

Certificate

The certificate-authority-data for your cluster.


                        Certificate

object

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

Properties


                        data

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.


                        status

ClusterStatus

The current status of the cluster.

ClusterStatus string
Allowed values:
- CREATING
- ACTIVE
- DELETING
- FAILED


                        resourcesVpcConfig

VpcConfigResponse


                        VpcConfigResponse

object

An object representing an Amazon EKS cluster VPC configuration response.

Properties

`vpcId`	String	The VPC associated with your cluster.
`securityGroupIds`	StringList	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`	StringList	The subnets associated with your cluster.


                        roleArn

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.

String string


                        endpoint

String

The endpoint for your Kubernetes API server.

String string


                        version

String

The Kubernetes server version for the cluster.

String string


                        createdAt

Timestamp

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

Timestamp dateTime

arn

String

The Amazon Resource Name (ARN) of the cluster.

String string


                        name

String

The name of the cluster.

String string

480ResourceInUseException

Body

Name	Data Type	Description
`ResourceInUseException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

482ClientException

Body

Name	Data Type	Description
`ClientException`

483ServerException

Body

Name	Data Type	Description
`ServerException`

484ServiceUnavailableException

Body

Name	Data Type	Description
`ServiceUnavailableException`

GET

/clusters/{name}

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.

Request

Path

Name	Data Type	Description
`name`	string

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`DescribeClusterRequest`	object

Examples

{
    "name": "devel"
}

Responses

200Success

Body

Name	Data Type	Description
`DescribeClusterResponse`	object

Properties


                        cluster

Cluster

The full description of your specified cluster.


                        Cluster

object

An object representing an Amazon EKS cluster.

Properties


                        platformVersion

String

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

String string


                        clientRequestToken

String

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

String string


                        certificateAuthority

Certificate

The certificate-authority-data for your cluster.


                        Certificate

object

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

Properties


                        data

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.


                        status

ClusterStatus

The current status of the cluster.

ClusterStatus string
Allowed values:
- CREATING
- ACTIVE
- DELETING
- FAILED


                        resourcesVpcConfig

VpcConfigResponse


                        VpcConfigResponse

object

An object representing an Amazon EKS cluster VPC configuration response.

Properties

`vpcId`	String	The VPC associated with your cluster.
`securityGroupIds`	StringList	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`	StringList	The subnets associated with your cluster.


                        roleArn

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.

String string


                        endpoint

String

The endpoint for your Kubernetes API server.

String string


                        version

String

The Kubernetes server version for the cluster.

String string


                        createdAt

Timestamp

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

Timestamp dateTime

arn

String

The Amazon Resource Name (ARN) of the cluster.

String string


                        name

String

The name of the cluster.

String string

Examples

{
    "cluster": {
        "version": "1.10",
        "name": "devel",
        "arn": "arn:aws:eks:us-west-2:012345678910:cluster\/devel",
        "certificateAuthority": {
            "data": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo="
        },
        "createdAt": 1527807879.988,
        "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"
    }
}

480ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

481ClientException

Body

Name	Data Type	Description
`ClientException`

482ServerException

Body

Name	Data Type	Description
`ServerException`

483ServiceUnavailableException

Body

Name	Data Type	Description
`ServiceUnavailableException`

GET

/clusters

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

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`ListClustersRequest`	object

Responses

200Success

Body

Name	Data Type	Description
`ListClustersResponse`	object

Properties


                        nextToken

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.

String string


                        clusters

StringList

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

StringList array [String]

String string

Examples

{
    "clusters": [
        "devel",
        "prod"
    ]
}

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481ClientException

Body

Name	Data Type	Description
`ClientException`

482ServerException

Body

Name	Data Type	Description
`ServerException`

483ServiceUnavailableException

Body

Name	Data Type	Description
`ServiceUnavailableException`

POST

/clusters

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`CreateClusterRequest`	object

Properties


                        clientRequestToken

String

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

String string


                        resourcesVpcConfig

VpcConfigRequest

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. You must specify at least two subnets. You may specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.


                        VpcConfigRequest

object

An object representing an Amazon EKS cluster VPC configuration request.

Properties


                        securityGroupIds

StringList

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 do not specify a security group, the default security group for your VPC is used.

StringList array [String]


                        subnetIds

StringList

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.

StringList array [String]


                        roleArn

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 .

String string


                        version

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.

String string


                        name

ClusterName

The unique name to give to your cluster.

ClusterName string
Pattern: ^[0-9A-Za-z][A-Za-z0-9\-_]*
Minimum: 1
Maximum: 100

Examples

{
    "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"
}

Responses

200Success

Body

Name	Data Type	Description
`CreateClusterResponse`	object

Properties


                        cluster

Cluster

The full description of your new cluster.


                        Cluster

object

An object representing an Amazon EKS cluster.

Properties


                        platformVersion

String

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

String string


                        clientRequestToken

String

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

String string


                        certificateAuthority

Certificate

The certificate-authority-data for your cluster.


                        Certificate

object

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

Properties


                        data

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.


                        status

ClusterStatus

The current status of the cluster.

ClusterStatus string
Allowed values:
- CREATING
- ACTIVE
- DELETING
- FAILED


                        resourcesVpcConfig

VpcConfigResponse


                        VpcConfigResponse

object

An object representing an Amazon EKS cluster VPC configuration response.

Properties

`vpcId`	String	The VPC associated with your cluster.
`securityGroupIds`	StringList	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`	StringList	The subnets associated with your cluster.


                        roleArn

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.

String string


                        endpoint

String

The endpoint for your Kubernetes API server.

String string


                        version

String

The Kubernetes server version for the cluster.

String string


                        createdAt

Timestamp

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

Timestamp dateTime

arn

String

The Amazon Resource Name (ARN) of the cluster.

String string


                        name

String

The name of the cluster.

String string

480ResourceInUseException

Body

Name	Data Type	Description
`ResourceInUseException`

481ResourceLimitExceededException

Body

Name	Data Type	Description
`ResourceLimitExceededException`

482InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

483ClientException

Body

Name	Data Type	Description
`ClientException`

484ServerException

Body

Name	Data Type	Description
`ServerException`

485ServiceUnavailableException

Body

Name	Data Type	Description
`ServiceUnavailableException`

486UnsupportedAvailabilityZoneException

Body

Name	Data Type	Description
`UnsupportedAvailabilityZoneException`

Models

Certificate

ClientException

Cluster

An object representing an Amazon EKS cluster.

Properties

Name Data Type Description


                        platformVersion

String

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

String string


                        clientRequestToken

String

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

String string


                        certificateAuthority

Certificate

The certificate-authority-data for your cluster.


                        Certificate

object

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

Properties


                        data

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.

String string


                        status

ClusterStatus

The current status of the cluster.

ClusterStatus string
Allowed values:
- CREATING
- ACTIVE
- DELETING
- FAILED


                        resourcesVpcConfig

VpcConfigResponse


                        VpcConfigResponse

object

An object representing an Amazon EKS cluster VPC configuration response.

Properties


                        vpcId

String

The VPC associated with your cluster.

String string


                        securityGroupIds

StringList

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.

StringList array [String]

String string


                        subnetIds

StringList

The subnets associated with your cluster.

StringList array [String]

String string


                        roleArn

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.

String string


                        endpoint

String

The endpoint for your Kubernetes API server.

String string


                        version

String

The Kubernetes server version for the cluster.

String string


                        createdAt

Timestamp

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

Timestamp dateTime

arn

String

The Amazon Resource Name (ARN) of the cluster.

String string


                        name

String

The name of the cluster.

String string

ClusterName

ClusterStatus

CreateClusterRequest

Properties

Name Data Type Description


                        clientRequestToken

String

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

String string


                        resourcesVpcConfig

VpcConfigRequest


                        VpcConfigRequest

object

An object representing an Amazon EKS cluster VPC configuration request.

Properties


                        securityGroupIds

StringList

StringList array [String]

String string


                        subnetIds

StringList

StringList array [String]

String string


                        roleArn

String

String string


                        version

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.

String string


                        name

ClusterName

The unique name to give to your cluster.

ClusterName string
Pattern: ^[0-9A-Za-z][A-Za-z0-9\-_]*
Minimum: 1
Maximum: 100

Examples

{
    "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"
}

CreateClusterResponse

Properties

Name Data Type Description


                        cluster

Cluster

The full description of your new cluster.


                        Cluster

object

An object representing an Amazon EKS cluster.

Properties


                        platformVersion

String

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

String string


                        clientRequestToken

String

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

String string


                        certificateAuthority

Certificate

The certificate-authority-data for your cluster.


                        Certificate

object

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

Properties


                        data

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.

String string


                        status

ClusterStatus

The current status of the cluster.

ClusterStatus string
Allowed values:
- CREATING
- ACTIVE
- DELETING
- FAILED


                        resourcesVpcConfig

VpcConfigResponse


                        VpcConfigResponse

object

An object representing an Amazon EKS cluster VPC configuration response.

Properties


                        vpcId

String

The VPC associated with your cluster.

String string


                        securityGroupIds

StringList

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.

StringList array [String]


                        subnetIds

StringList

The subnets associated with your cluster.

StringList array [String]


                        roleArn

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.

String string


                        endpoint

String

The endpoint for your Kubernetes API server.

String string


                        version

String

The Kubernetes server version for the cluster.

String string


                        createdAt

Timestamp

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

Timestamp dateTime

arn

String

The Amazon Resource Name (ARN) of the cluster.

String string


                        name

String

The name of the cluster.

String string

DeleteClusterRequest

DeleteClusterResponse

Properties

Name Data Type Description


                        cluster

Cluster

The full description of the cluster to delete.


                        Cluster

object

An object representing an Amazon EKS cluster.

Properties


                        platformVersion

String

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

String string


                        clientRequestToken

String

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

String string


                        certificateAuthority

Certificate

The certificate-authority-data for your cluster.


                        Certificate

object

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

Properties


                        data

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.

String string


                        status

ClusterStatus

The current status of the cluster.

ClusterStatus string
Allowed values:
- CREATING
- ACTIVE
- DELETING
- FAILED


                        resourcesVpcConfig

VpcConfigResponse


                        VpcConfigResponse

object

An object representing an Amazon EKS cluster VPC configuration response.

Properties


                        vpcId

String

The VPC associated with your cluster.

String string


                        securityGroupIds

StringList

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.

StringList array [String]


                        subnetIds

StringList

The subnets associated with your cluster.

StringList array [String]


                        roleArn

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.

String string


                        endpoint

String

The endpoint for your Kubernetes API server.

String string


                        version

String

The Kubernetes server version for the cluster.

String string


                        createdAt

Timestamp

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

Timestamp dateTime

arn

String

The Amazon Resource Name (ARN) of the cluster.

String string


                        name

String

The name of the cluster.

String string

DescribeClusterRequest

DescribeClusterResponse

Properties

Name Data Type Description


                        cluster

Cluster

The full description of your specified cluster.


                        Cluster

object

An object representing an Amazon EKS cluster.

Properties


                        platformVersion

String

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

String string


                        clientRequestToken

String

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

String string


                        certificateAuthority

Certificate

The certificate-authority-data for your cluster.


                        Certificate

object

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

Properties


                        data

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.

String string


                        status

ClusterStatus

The current status of the cluster.

ClusterStatus string
Allowed values:
- CREATING
- ACTIVE
- DELETING
- FAILED


                        resourcesVpcConfig

VpcConfigResponse


                        VpcConfigResponse

object

An object representing an Amazon EKS cluster VPC configuration response.

Properties


                        vpcId

String

The VPC associated with your cluster.

String string


                        securityGroupIds

StringList

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.

StringList array [String]


                        subnetIds

StringList

The subnets associated with your cluster.

StringList array [String]


                        roleArn

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.

String string


                        endpoint

String

The endpoint for your Kubernetes API server.

String string


                        version

String

The Kubernetes server version for the cluster.

String string


                        createdAt

Timestamp

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

Timestamp dateTime

arn

String

The Amazon Resource Name (ARN) of the cluster.

String string


                        name

String

The name of the cluster.

String string

Examples

{
    "cluster": {
        "version": "1.10",
        "name": "devel",
        "arn": "arn:aws:eks:us-west-2:012345678910:cluster\/devel",
        "certificateAuthority": {
            "data": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo="
        },
        "createdAt": 1527807879.988,
        "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"
    }
}

DescribeUpdateRequest

DescribeUpdateResponse

Properties

Name Data Type Description


                        update

Update

The full description of the specified update.


                        Update

object

An object representing an asynchronous update.

Properties


                        errors

ErrorDetails

Any errors associated with a Failed update.

ErrorDetails array [ErrorDetail]


                        ErrorDetail

object

An object representing an error when an asynchronous operation fails.

Properties

`resourceIds`	StringList	An optional field that contains the resource IDs associated with the error.
`errorMessage`	String	A more complete description of the error.
`errorCode`	ErrorCode	A brief description of the error. SubnetNotFound: One of the subnets associated with the cluster could not be found. SecurityGroupNotFound: One of the security groups associated with the cluster could not be found. EniLimitReached: You have reached the elastic network interface limit for your account. IpNotAvailable: A subnet associated with the cluster does not have any free IP addresses. AccessDenied: You do not have permissions to perform the specified operation. OperationNotPermitted: The service role associated with the cluster does not have the required access permissions for Amazon EKS. VpcIdNotFound: The VPC associated with the cluster could not be found.


                        createdAt

Timestamp

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

Timestamp dateTime


                        params

UpdateParams

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

UpdateParams array [UpdateParam]


                        UpdateParam

object

An object representing the details of an update request.

Properties

`value`	String	The value of the keys submitted as part of an update request.
`type`	UpdateParamType	The keys associated with an update request.


                        type

UpdateType

The type of the update.

UpdateType string
Allowed values:
- VersionUpdate


                        status

UpdateStatus

The current status of the update.

UpdateStatus string
Allowed values:
- InProgress
- Failed
- Cancelled
- Successful

id

String

A UUID that is used to track the update.

String string

ErrorCode

ErrorDetail

An object representing an error when an asynchronous operation fails.

Properties

Name Data Type Description


                        resourceIds

StringList

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

StringList array [String]

String string


                        errorMessage

String

A more complete description of the error.

String string


                        errorCode

ErrorCode

A brief description of the error.

SubnetNotFound: One of the subnets associated with the cluster could not be found.
SecurityGroupNotFound: One of the security groups associated with the cluster could not be found.
EniLimitReached: You have reached the elastic network interface limit for your account.
IpNotAvailable: A subnet associated with the cluster does not have any free IP addresses.
AccessDenied: You do not have permissions to perform the specified operation.
OperationNotPermitted: The service role associated with the cluster does not have the required access permissions for Amazon EKS.
VpcIdNotFound: The VPC associated with the cluster could not be found.

ErrorCode string
Allowed values:
- SubnetNotFound
- SecurityGroupNotFound
- EniLimitReached
- IpNotAvailable
- AccessDenied
- OperationNotPermitted
- VpcIdNotFound
- Unknown

ErrorDetails

Name Data Type Description

ErrorDetails array [ErrorDetail]


                        ErrorDetail

object

An object representing an error when an asynchronous operation fails.

Properties


                        resourceIds

StringList

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

StringList array [String]

String string


                        errorMessage

String

A more complete description of the error.

String string


                        errorCode

ErrorCode

A brief description of the error.

SubnetNotFound: One of the subnets associated with the cluster could not be found.
SecurityGroupNotFound: One of the security groups associated with the cluster could not be found.
EniLimitReached: You have reached the elastic network interface limit for your account.
IpNotAvailable: A subnet associated with the cluster does not have any free IP addresses.
AccessDenied: You do not have permissions to perform the specified operation.
OperationNotPermitted: The service role associated with the cluster does not have the required access permissions for Amazon EKS.
VpcIdNotFound: The VPC associated with the cluster could not be found.

ErrorCode string
Allowed values:
- SubnetNotFound
- SecurityGroupNotFound
- EniLimitReached
- IpNotAvailable
- AccessDenied
- OperationNotPermitted
- VpcIdNotFound
- Unknown

InvalidParameterException

InvalidRequestException

ListClustersRequest

ListClustersRequestMaxResults

ListClustersResponse

Properties

Name Data Type Description


                        nextToken

String

String string


                        clusters

StringList

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

StringList array [String]

String string

Examples

{
    "clusters": [
        "devel",
        "prod"
    ]
}

ListUpdatesRequest

ListUpdatesRequestMaxResults

ListUpdatesResponse

Properties

Name Data Type Description


                        nextToken

String

String string


                        updateIds

StringList

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

StringList array [String]

String string

ResourceInUseException

ResourceLimitExceededException

ResourceNotFoundException

ServerException

ServiceUnavailableException

String

StringList

Timestamp

UnsupportedAvailabilityZoneException

Update

An object representing an asynchronous update.

Properties

Name Data Type Description


                        errors

ErrorDetails

Any errors associated with a Failed update.

ErrorDetails array [ErrorDetail]


                        ErrorDetail

object

An object representing an error when an asynchronous operation fails.

Properties


                        resourceIds

StringList

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

StringList array [String]


                        errorMessage

String

A more complete description of the error.

String string


                        errorCode

ErrorCode

A brief description of the error.

SubnetNotFound: One of the subnets associated with the cluster could not be found.
SecurityGroupNotFound: One of the security groups associated with the cluster could not be found.
EniLimitReached: You have reached the elastic network interface limit for your account.
IpNotAvailable: A subnet associated with the cluster does not have any free IP addresses.
AccessDenied: You do not have permissions to perform the specified operation.
OperationNotPermitted: The service role associated with the cluster does not have the required access permissions for Amazon EKS.
VpcIdNotFound: The VPC associated with the cluster could not be found.

ErrorCode string
Allowed values:
- SubnetNotFound
- SecurityGroupNotFound
- EniLimitReached
- IpNotAvailable
- AccessDenied
- OperationNotPermitted
- VpcIdNotFound
- Unknown


                        createdAt

Timestamp

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

Timestamp dateTime


                        params

UpdateParams

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

UpdateParams array [UpdateParam]


                        UpdateParam

object

An object representing the details of an update request.

Properties


                        value

String

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

String string


                        type

UpdateParamType

The keys associated with an update request.

UpdateParamType string
Allowed values:
- Version
- PlatformVersion


                        type

UpdateType

The type of the update.

UpdateType string
Allowed values:
- VersionUpdate


                        status

UpdateStatus

The current status of the update.

UpdateStatus string
Allowed values:
- InProgress
- Failed
- Cancelled
- Successful

id

String

A UUID that is used to track the update.

String string

UpdateClusterVersionRequest

UpdateClusterVersionResponse

Properties

Name Data Type Description


                        update

Update

The full description of the specified update


                        Update

object

An object representing an asynchronous update.

Properties


                        errors

ErrorDetails

Any errors associated with a Failed update.

ErrorDetails array [ErrorDetail]


                        ErrorDetail

object

An object representing an error when an asynchronous operation fails.

Properties

`resourceIds`	StringList	An optional field that contains the resource IDs associated with the error.
`errorMessage`	String	A more complete description of the error.
`errorCode`	ErrorCode	A brief description of the error. SubnetNotFound: One of the subnets associated with the cluster could not be found. SecurityGroupNotFound: One of the security groups associated with the cluster could not be found. EniLimitReached: You have reached the elastic network interface limit for your account. IpNotAvailable: A subnet associated with the cluster does not have any free IP addresses. AccessDenied: You do not have permissions to perform the specified operation. OperationNotPermitted: The service role associated with the cluster does not have the required access permissions for Amazon EKS. VpcIdNotFound: The VPC associated with the cluster could not be found.


                        createdAt

Timestamp

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

Timestamp dateTime


                        params

UpdateParams

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

UpdateParams array [UpdateParam]


                        UpdateParam

object

An object representing the details of an update request.

Properties

`value`	String	The value of the keys submitted as part of an update request.
`type`	UpdateParamType	The keys associated with an update request.


                        type

UpdateType

The type of the update.

UpdateType string
Allowed values:
- VersionUpdate


                        status

UpdateStatus

The current status of the update.

UpdateStatus string
Allowed values:
- InProgress
- Failed
- Cancelled
- Successful

id

String

A UUID that is used to track the update.

String string

UpdateParam

UpdateParamType

UpdateParams

Name Data Type Description

UpdateParams array [UpdateParam]


                        UpdateParam

object

An object representing the details of an update request.

Properties


                        value

String

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

String string


                        type

UpdateParamType

The keys associated with an update request.

UpdateParamType string
Allowed values:
- Version
- PlatformVersion

UpdateStatus

UpdateType

VpcConfigRequest

An object representing an Amazon EKS cluster VPC configuration request.

Properties

Name Data Type Description


                        securityGroupIds

StringList

StringList array [String]

String string


                        subnetIds

StringList

StringList array [String]

String string

VpcConfigResponse

An object representing an Amazon EKS cluster VPC configuration response.

Properties

Name Data Type Description


                        vpcId

String

The VPC associated with your cluster.

String string


                        securityGroupIds

StringList

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.

StringList array [String]

String string


                        subnetIds

StringList

The subnets associated with your cluster.

StringList array [String]

String string

Authentication

Api Key

Amazon Signature authorization v4

Location: header
Header Name: Authorization
Amazon-apigateway-authtype: awsSigv4

Contact

Name	`AWS`
External URL	`https://docs.aws.amazon.com/eks/index.html`

Metadata (Technical Details)

Release	`v4`
Provider Name	`amazonaws.com`
Service Name	`eks`
Origin - ContentType	`application/json`
Origin - Url	`https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/eks-2017-11-01.normal.json`
Api Client Registration	`https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct`
Preferred	`Yes`
API Version	`2017-11-01`

Comments

Loading comments ...