Describes 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 Creating or
updating a kubeconfig file for an Amazon EKS cluster.
Note
The API server endpoint and certificate authority data aren't available until the
cluster reaches the ACTIVE state.
Request Syntax
GET /clusters/name HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of your cluster.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"cluster": {
"accessConfig": {
"authenticationMode": "string",
"bootstrapClusterCreatorAdminPermissions": boolean
},
"arn": "string",
"certificateAuthority": {
"data": "string"
},
"clientRequestToken": "string",
"computeConfig": {
"enabled": boolean,
"nodePools": [ "string" ],
"nodeRoleArn": "string"
},
"connectorConfig": {
"activationCode": "string",
"activationExpiry": number,
"activationId": "string",
"provider": "string",
"roleArn": "string"
},
"createdAt": number,
"encryptionConfig": [
{
"provider": {
"keyArn": "string"
},
"resources": [ "string" ]
}
],
"endpoint": "string",
"health": {
"issues": [
{
"code": "string",
"message": "string",
"resourceIds": [ "string" ]
}
]
},
"id": "string",
"identity": {
"oidc": {
"issuer": "string"
}
},
"kubernetesNetworkConfig": {
"elasticLoadBalancing": {
"enabled": boolean
},
"ipFamily": "string",
"serviceIpv4Cidr": "string",
"serviceIpv6Cidr": "string"
},
"logging": {
"clusterLogging": [
{
"enabled": boolean,
"types": [ "string" ]
}
]
},
"name": "string",
"outpostConfig": {
"controlPlaneInstanceType": "string",
"controlPlanePlacement": {
"groupName": "string"
},
"outpostArns": [ "string" ]
},
"platformVersion": "string",
"remoteNetworkConfig": {
"remoteNodeNetworks": [
{
"cidrs": [ "string" ]
}
],
"remotePodNetworks": [
{
"cidrs": [ "string" ]
}
]
},
"resourcesVpcConfig": {
"clusterSecurityGroupId": "string",
"endpointPrivateAccess": boolean,
"endpointPublicAccess": boolean,
"publicAccessCidrs": [ "string" ],
"securityGroupIds": [ "string" ],
"subnetIds": [ "string" ],
"vpcId": "string"
},
"roleArn": "string",
"status": "string",
"storageConfig": {
"blockStorage": {
"enabled": boolean
}
},
"tags": {
"string" : "string"
},
"upgradePolicy": {
"supportType": "string"
},
"version": "string",
"zonalShiftConfig": {
"enabled": boolean
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientException
-
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource could not be found. You can view your available clusters with
ListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are AWS Region specific.HTTP Status Code: 404
- ServerException
-
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is unavailable. Back off and retry the operation.
HTTP Status Code: 503
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS) must be replaced with an AWS Signature Version 4
signature. For more information about creating these signatures, see Signature
Version 4 Signing Process in the Amazon EKS General
Reference.
You need to learn how to sign HTTP requests only if you intend to manually
create them. When you use the AWS Command Line
Interface (AWS CLI)
Example
The following example describes a cluster named
my-cluster.
Sample Request
GET /clusters/my-cluster HTTP/1.1
Host: eks.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.120 Python/3.7.0 Darwin/18.2.0 botocore/1.12.110
X-Amz-Date: 20190322T161109Z
Authorization: AUTHPARAMSSample Response
HTTP/1.1 200 OK
Date: Fri, 22 Mar 2019 16:11:07 GMT
Content-Type: application/json
Content-Length: 682
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
x-amz-apigw-id: W85cPGkVvHcFa4g=
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive
{
"cluster": {
"name": "my-cluster",
"arn": "arn:aws:eks:us-west-2:012345678910:cluster/my-cluster",
"createdAt": 1553270518.433,
"version": "1.11",
"endpoint": null,
"roleArn": "arn:aws:iam::012345678910:role/eksClusterRole",
"resourcesVpcConfig": {
"subnetIds": [
"subnet-xxxxxxxxxxxxxxxxx",
"subnet-yyyyyyyyyyyyyyyyy",
"subnet-zzzzzzzzzzzzzzzzz"
],
"securityGroupIds": [
"sg-xxxxxxxxxxxxxxxxx"
],
"vpcId": "vpc-xxxxxxxxxxxxxxxxx",
"endpointPublicAccess": true,
"endpointPrivateAccess": true
},
"logging": {
"clusterLogging": [
{
"types": [
"api",
"audit",
"authenticator",
"controllerManager",
"scheduler"
],
"enabled": false
}
]
},
"identity": {
"oidc": {
"issuer": null
}
},
"status": "CREATING",
"certificateAuthority": {
"data": null
},
"clientRequestToken": null,
"platformVersion": "eks.2"
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
