codegen-resources.docs-2.json Maven / Gradle / Ivy
Show all versions of eks Show documentation
{
"version": "2.0",
"service": "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.
",
"operations": {
"CreateCluster": "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.
",
"DeleteCluster": "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.
",
"DescribeCluster": "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.
",
"ListClusters": "Lists the Amazon EKS clusters in your AWS account in the specified Region.
"
},
"shapes": {
"Certificate": {
"base": "An object representing the certificate-authority-data for your cluster.
",
"refs": {
"Cluster$certificateAuthority": "The certificate-authority-data for your cluster.
"
}
},
"ClientException": {
"base": "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.
",
"refs": {
}
},
"Cluster": {
"base": "An object representing an Amazon EKS cluster.
",
"refs": {
"CreateClusterResponse$cluster": "The full description of your new cluster.
",
"DeleteClusterResponse$cluster": "The full description of the cluster to delete.
",
"DescribeClusterResponse$cluster": "The full description of your specified cluster.
"
}
},
"ClusterName": {
"base": null,
"refs": {
"CreateClusterRequest$name": "The unique name to give to your cluster.
"
}
},
"ClusterStatus": {
"base": null,
"refs": {
"Cluster$status": "The current status of the cluster.
"
}
},
"CreateClusterRequest": {
"base": null,
"refs": {
}
},
"CreateClusterResponse": {
"base": null,
"refs": {
}
},
"DeleteClusterRequest": {
"base": null,
"refs": {
}
},
"DeleteClusterResponse": {
"base": null,
"refs": {
}
},
"DescribeClusterRequest": {
"base": null,
"refs": {
}
},
"DescribeClusterResponse": {
"base": null,
"refs": {
}
},
"InvalidParameterException": {
"base": "The specified parameter is invalid. Review the available parameters for the API request.
",
"refs": {
}
},
"ListClustersRequest": {
"base": null,
"refs": {
}
},
"ListClustersRequestMaxResults": {
"base": null,
"refs": {
"ListClustersRequest$maxResults": "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.
"
}
},
"ListClustersResponse": {
"base": null,
"refs": {
}
},
"ResourceInUseException": {
"base": "The specified resource is in use.
",
"refs": {
}
},
"ResourceLimitExceededException": {
"base": "You have encountered a service limit on the specified resource.
",
"refs": {
}
},
"ResourceNotFoundException": {
"base": "The specified resource could not be found. You can view your available clusters with ListClusters. Amazon EKS clusters are Region-specific.
",
"refs": {
}
},
"ServerException": {
"base": "These errors are usually caused by a server-side issue.
",
"refs": {
}
},
"ServiceUnavailableException": {
"base": "The service is unavailable. Back off and retry the operation.
",
"refs": {
}
},
"String": {
"base": null,
"refs": {
"Certificate$data": "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$clusterName": "The Amazon EKS cluster associated with the exception.
",
"ClientException$message": null,
"Cluster$name": "The name of the cluster.
",
"Cluster$arn": "The Amazon Resource Name (ARN) of the cluster.
",
"Cluster$version": "The Kubernetes server version for the cluster.
",
"Cluster$endpoint": "The endpoint for your Kubernetes API server.
",
"Cluster$roleArn": "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.
",
"Cluster$clientRequestToken": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
",
"Cluster$platformVersion": "The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
",
"CreateClusterRequest$version": "The desired Kubernetes version for your cluster. If you do not specify a value here, the latest version available in Amazon EKS is used.
",
"CreateClusterRequest$roleArn": "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 .
",
"CreateClusterRequest$clientRequestToken": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
",
"DeleteClusterRequest$name": "The name of the cluster to delete.
",
"DescribeClusterRequest$name": "The name of the cluster to describe.
",
"InvalidParameterException$clusterName": "The Amazon EKS cluster associated with the exception.
",
"InvalidParameterException$message": null,
"ListClustersRequest$nextToken": "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.
",
"ListClustersResponse$nextToken": "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.
",
"ResourceInUseException$clusterName": "The Amazon EKS cluster associated with the exception.
",
"ResourceInUseException$message": null,
"ResourceLimitExceededException$clusterName": "The Amazon EKS cluster associated with the exception.
",
"ResourceLimitExceededException$message": null,
"ResourceNotFoundException$clusterName": "The Amazon EKS cluster associated with the exception.
",
"ResourceNotFoundException$message": null,
"ServerException$clusterName": "The Amazon EKS cluster associated with the exception.
",
"ServerException$message": null,
"ServiceUnavailableException$message": null,
"StringList$member": null,
"UnsupportedAvailabilityZoneException$message": null,
"UnsupportedAvailabilityZoneException$clusterName": "The Amazon EKS cluster associated with the exception.
",
"VpcConfigResponse$vpcId": "The VPC associated with your cluster.
"
}
},
"StringList": {
"base": null,
"refs": {
"ListClustersResponse$clusters": "A list of all of the clusters for your account in the specified Region.
",
"UnsupportedAvailabilityZoneException$validZones": "The supported Availability Zones for your account. Choose subnets in these Availability Zones for your cluster.
",
"VpcConfigRequest$subnetIds": "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.
",
"VpcConfigRequest$securityGroupIds": "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.
",
"VpcConfigResponse$subnetIds": "The subnets associated with your cluster.
",
"VpcConfigResponse$securityGroupIds": "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.
"
}
},
"Timestamp": {
"base": null,
"refs": {
"Cluster$createdAt": "The Unix epoch time stamp in seconds for when the cluster was created.
"
}
},
"UnsupportedAvailabilityZoneException": {
"base": "At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.
",
"refs": {
}
},
"VpcConfigRequest": {
"base": "An object representing an Amazon EKS cluster VPC configuration request.
",
"refs": {
"CreateClusterRequest$resourcesVpcConfig": "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 5 security groups, but we recommend that you use a dedicated security group for your cluster control plane.
"
}
},
"VpcConfigResponse": {
"base": "An object representing an Amazon EKS cluster VPC configuration response.
",
"refs": {
"Cluster$resourcesVpcConfig": "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.
"
}
}
}
}