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.
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.
Name | Data Type | Description |
---|---|---|
updateId
|
string | |
name
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DescribeUpdateRequest
|
object |
Name | Data Type | Description |
---|---|---|
DescribeUpdateResponse
|
object |
update
|
Update |
The full description of the specified update. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
ClientException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.
Name | Data Type | Description |
---|---|---|
name
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListUpdatesRequest
|
object |
Name | Data Type | Description |
---|---|---|
ListUpdatesResponse
|
object |
nextToken
|
String |
The |
|||||||||||
|
|||||||||||||
updateIds
|
StringList |
A list of all the updates for the specified cluster and Region. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
ClientException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
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
.
Name | Data Type | Description |
---|---|---|
name
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
UpdateClusterVersionResponse
|
object |
update
|
Update |
The full description of the specified update |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
ClientException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
ResourceInUseException
|
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
Name | Data Type | Description |
---|---|---|
InvalidRequestException
|
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.
Name | Data Type | Description |
---|---|---|
name
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DeleteClusterRequest
|
object |
{
"name": "devel"
}
Name | Data Type | Description |
---|---|---|
DeleteClusterResponse
|
object |
cluster
|
Cluster |
The full description of the cluster to delete. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ResourceInUseException
|
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
Name | Data Type | Description |
---|---|---|
ClientException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
ServiceUnavailableException
|
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.
Name | Data Type | Description |
---|---|---|
name
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DescribeClusterRequest
|
object |
{
"name": "devel"
}
Name | Data Type | Description |
---|---|---|
DescribeClusterResponse
|
object |
cluster
|
Cluster |
The full description of your specified cluster. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
{
"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"
}
}
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
Name | Data Type | Description |
---|---|---|
ClientException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
ServiceUnavailableException
|
Lists the Amazon EKS clusters in your AWS account in the specified Region.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListClustersRequest
|
object |
Name | Data Type | Description |
---|---|---|
ListClustersResponse
|
object |
nextToken
|
String |
The |
|||||||||||
|
|||||||||||||
clusters
|
StringList |
A list of all of the clusters for your account in the specified Region. |
|||||||||||
|
{
"clusters": [
"devel",
"prod"
]
}
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
ClientException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
ServiceUnavailableException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
CreateClusterRequest
|
object |
clientRequestToken
|
String |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
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 . |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
name
|
ClusterName |
The unique name to give to your cluster. |
||||||||||||||||||||||||
|
{
"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"
}
Name | Data Type | Description |
---|---|---|
CreateClusterResponse
|
object |
cluster
|
Cluster |
The full description of your new cluster. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ResourceInUseException
|
Name | Data Type | Description |
---|---|---|
ResourceLimitExceededException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
ClientException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
ServiceUnavailableException
|
Name | Data Type | Description |
---|---|---|
UnsupportedAvailabilityZoneException
|
An object representing the certificate-authority-data
for your cluster.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
data
|
String |
The base64 encoded certificate data required to communicate with your cluster. Add this to the |
||||
|
Name | Data Type | Description |
---|---|---|
ClientException
|
An object representing an Amazon EKS cluster.
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 . |
||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
clientRequestToken
|
String |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
certificateAuthority
|
Certificate |
The |
||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
ClusterStatus |
The current status of the cluster. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
resourcesVpcConfig
|
VpcConfigResponse |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
endpoint
|
String |
The endpoint for your Kubernetes API server. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
version
|
String |
The Kubernetes server version for the cluster. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt
|
Timestamp |
The Unix epoch timestamp in seconds for when the cluster was created. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
arn
|
String |
The Amazon Resource Name (ARN) of the cluster. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
String |
The name of the cluster. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ClusterName
|
string Pattern: ^[0-9A-Za-z][A-Za-z0-9\-_]* Minimum: 1 Maximum: 100 |
Name | Data Type | Description |
---|---|---|
ClusterStatus
|
string Allowed values: - CREATING - ACTIVE - DELETING - FAILED |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
clientRequestToken
|
String |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
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 . |
||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
name
|
ClusterName |
The unique name to give to your cluster. |
||||||||||||||||||||||||||||||||||||||
|
{
"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"
}
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cluster
|
Cluster |
The full description of your new cluster. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DeleteClusterRequest
|
object |
{
"name": "devel"
}
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cluster
|
Cluster |
The full description of the cluster to delete. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DescribeClusterRequest
|
object |
{
"name": "devel"
}
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cluster
|
Cluster |
The full description of your specified cluster. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
{
"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"
}
}
Name | Data Type | Description |
---|---|---|
DescribeUpdateRequest
|
object |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
update
|
Update |
The full description of the specified update. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ErrorCode
|
string Allowed values: - SubnetNotFound - SecurityGroupNotFound - EniLimitReached - IpNotAvailable - AccessDenied - OperationNotPermitted - VpcIdNotFound - Unknown |
An object representing an error when an asynchronous operation fails.
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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.
|
|||||||||||
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ErrorDetails
|
array [ErrorDetail] | ||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InvalidRequestException
|
Name | Data Type | Description |
---|---|---|
ListClustersRequest
|
object |
Name | Data Type | Description |
---|---|---|
ListClustersRequestMaxResults
|
integer Minimum: 1 Maximum: 100 |
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextToken
|
String |
The |
|||||||||||
|
|||||||||||||
clusters
|
StringList |
A list of all of the clusters for your account in the specified Region. |
|||||||||||
|
{
"clusters": [
"devel",
"prod"
]
}
Name | Data Type | Description |
---|---|---|
ListUpdatesRequest
|
object |
Name | Data Type | Description |
---|---|---|
ListUpdatesRequestMaxResults
|
integer Minimum: 1 Maximum: 100 |
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextToken
|
String |
The |
|||||||||||
|
|||||||||||||
updateIds
|
StringList |
A list of all the updates for the specified cluster and Region. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
ResourceInUseException
|
Name | Data Type | Description |
---|---|---|
ResourceLimitExceededException
|
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
ServiceUnavailableException
|
Name | Data Type | Description |
---|---|---|
String
|
string |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
StringList
|
array [String] | |||||
|
Name | Data Type | Description |
---|---|---|
Timestamp
|
dateTime |
Name | Data Type | Description |
---|---|---|
UnsupportedAvailabilityZoneException
|
An object representing an asynchronous update.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors
|
ErrorDetails |
Any errors associated with a |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
createdAt
|
Timestamp |
The Unix epoch timestamp in seconds for when the update was created. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
params
|
UpdateParams |
A key-value map that contains the parameters associated with the update. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
type
|
UpdateType |
The type of the update. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
status
|
UpdateStatus |
The current status of the update. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
id
|
String |
A UUID that is used to track the update. |
|||||||||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
update
|
Update |
The full description of the specified update |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
An object representing the details of an update request.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
value
|
String |
The value of the keys submitted as part of an update request. |
||||
|
||||||
type
|
UpdateParamType |
The keys associated with an update request. |
||||
|
Name | Data Type | Description |
---|---|---|
UpdateParamType
|
string Allowed values: - Version - PlatformVersion |
Name | Data Type | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
UpdateParams
|
array [UpdateParam] | |||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
UpdateStatus
|
string Allowed values: - InProgress - Failed - Cancelled - Successful |
Name | Data Type | Description |
---|---|---|
UpdateType
|
string Allowed values: - VersionUpdate |
An object representing an Amazon EKS cluster VPC configuration request.
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. |
|||||||||||
|
|||||||||||||
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. |
|||||||||||
|
An object representing an Amazon EKS cluster VPC configuration response.
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. |
|||||||||||
|
Amazon Signature authorization v4
header
Authorization
awsSigv4
Name | AWS |
External URL | https://docs.aws.amazon.com/eks/index.html |
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 |