DescribeCluster
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": {
"active": {
"activatedBy": "string",
"id": "string"
},
"data": "string"
},
"clientRequestToken": "string",
"computeConfig": {
"enabled": boolean,
"nodePools": [ "string" ],
"nodeRoleArn": "string"
},
"connectorConfig": {
"activationCode": "string",
"activationExpiry": number,
"activationId": "string",
"provider": "string",
"roleArn": "string"
},
"controlPlaneScalingConfig": {
"tier": "string"
},
"createdAt": number,
"deletionProtection": boolean,
"encryptionConfig": [
{
"provider": {
"keyArn": "string"
},
"resources": [ "string" ]
}
],
"endpoint": "string",
"health": {
"issues": [
{
"code": "string",
"message": "string",
"resourceIds": [ "string" ]
}
]
},
"id": "string",
"identity": {
"oidc": {
"issuer": "string"
}
},
"kubeApiServerConfig": {
"eventTtl": "string",
"serviceNodePortRange": {
"maxPort": number,
"minPort": number
}
},
"kubeControllerManagerConfig": {
"horizontalPodAutoscalerControllerConfig": {
"horizontalPodAutoscalerSyncPeriod": "string"
},
"podGcControllerConfig": {
"terminatedPodGcThreshold": number
}
},
"kubernetesNetworkConfig": {
"elasticLoadBalancing": {
"enabled": boolean
},
"ipFamily": "string",
"serviceIpv4Cidr": "string",
"serviceIpv6Cidr": "string"
},
"kubeSchedulerConfig": {
"nodeResourcesFit": {
"scoringStrategy": {
"resources": [
{
"name": "string",
"weight": number
}
],
"type": "string"
}
}
},
"logging": {
"clusterLogging": [
{
"enabled": boolean,
"types": [ "string" ]
}
]
},
"name": "string",
"outpostConfig": {
"controlPlaneInstanceType": "string",
"controlPlanePlacement": {
"groupName": "string",
"spreadLevel": "string"
},
"etcdInstanceType": "string",
"etcdPlacement": {
"spreadLevel": "string"
},
"outpostArns": [ "string" ]
},
"platformVersion": "string",
"remoteNetworkConfig": {
"remoteNodeNetworks": [
{
"cidrs": [ "string" ]
}
],
"remotePodNetworks": [
{
"cidrs": [ "string" ]
}
]
},
"resourcesVpcConfig": {
"clusterSecurityGroupId": "string",
"controlPlaneEgressMode": "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"
},
"