describe_cluster¶

EKS.Client.describe_cluster(**kwargs)¶

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.

Note

The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

See also: AWS API Documentation

Request Syntax

response = client.describe_cluster(
    name='string'
)

Parameters

name (string) --

[REQUIRED]

The name of the cluster to describe.

Return type

dict

Returns

Response Syntax

{
    'cluster': {
        'name': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'version': 'string',
        'endpoint': 'string',
        'roleArn': 'string',
        'resourcesVpcConfig': {
            'subnetIds': [
                'string',
            ],
            'securityGroupIds': [
                'string',
            ],
            'clusterSecurityGroupId': 'string',
            'vpcId': 'string',
            'endpointPublicAccess': True|False,
            'endpointPrivateAccess': True|False,
            'publicAccessCidrs': [
                'string',
            ]
        },
        'kubernetesNetworkConfig': {
            'serviceIpv4Cidr': 'string',
            'serviceIpv6Cidr': 'string',
            'ipFamily': 'ipv4'|'ipv6'
        },
        'logging': {
            'clusterLogging': [
                {
                    'types': [
                        'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
                    ],
                    'enabled': True|False
                },
            ]
        },
        'identity': {
            'oidc': {
                'issuer': 'string'
            }
        },
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'PENDING',
        'certificateAuthority': {
            'data': 'string'
        },
        'clientRequestToken': 'string',
        'platformVersion': 'string',
        'tags': {
            'string': 'string'
        },
        'encryptionConfig': [
            {
                'resources': [
                    'string',
                ],
                'provider': {
                    'keyArn': 'string'
                }
            },
        ],
        'connectorConfig': {
            'activationId': 'string',
            'activationCode': 'string',
            'activationExpiry': datetime(2015, 1, 1),
            'provider': 'string',
            'roleArn': 'string'
        },
        'id': 'string',
        'health': {
            'issues': [
                {
                    'code': 'AccessDenied'|'ClusterUnreachable'|'ConfigurationConflict'|'InternalFailure'|'ResourceLimitExceeded'|'ResourceNotFound',
                    'message': 'string',
                    'resourceIds': [
                        'string',
                    ]
                },
            ]
        },
        'outpostConfig': {
            'outpostArns': [
                'string',
            ],
            'controlPlaneInstanceType': 'string',
            'controlPlanePlacement': {
                'groupName': 'string'
            }
        }
    }
}

Response Structure

(dict) --
- cluster (dict) --
  The full description of your specified cluster.
  - name (string) --
    The name of the cluster.
  - arn (string) --
    The Amazon Resource Name (ARN) of the cluster.
  - createdAt (datetime) --
    The Unix epoch timestamp in seconds for when the cluster was created.
  - version (string) --
    The Kubernetes server version for the cluster.
  - endpoint (string) --
    The endpoint for your Kubernetes API server.
  - roleArn (string) --
    The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.
  - resourcesVpcConfig (dict) --
    The VPC configuration 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 .
    - subnetIds (list) --
      The subnets associated with your cluster.
      - (string) --
    - securityGroupIds (list) --
      The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.
      - (string) --
    - clusterSecurityGroupId (string) --
      The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.
    - vpcId (string) --
      The VPC associated with your cluster.
    - endpointPublicAccess (boolean) --
      This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
    - endpointPrivateAccess (boolean) --
      This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
    - publicAccessCidrs (list) --
      The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
      - (string) --
  - kubernetesNetworkConfig (dict) --
    The Kubernetes network configuration for the cluster.
    - serviceIpv4Cidr (string) --
      The CIDR block that Kubernetes pod and service IP addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it can't be changed.
    - serviceIpv6Cidr (string) --
      The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns service addresses from the unique local address range ( fc00::/7 ) because you can't specify a custom IPv6 CIDR block when you create the cluster.
    - ipFamily (string) --
      The IP family used to assign Kubernetes pod and service IP addresses. The IP family is always ipv4 , unless you have a 1.21 or later cluster running version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 when you created the cluster.
  - logging (dict) --
    The logging configuration for your cluster.
    - clusterLogging (list) --
      The cluster control plane logging configuration for your cluster.
      - (dict) --
        An object representing the enabled or disabled Kubernetes control plane logs for your cluster.
        
        types (list) --
        The available cluster control plane log types.
        
        (string) --
        
        enabled (boolean) --
        If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.
  - identity (dict) --
    The identity provider information for the cluster.
    - oidc (dict) --
      An object representing the OpenID Connect identity provider information.
      - issuer (string) --
        The issuer URL for the OIDC identity provider.
  - status (string) --
    The current status of the cluster.
  - certificateAuthority (dict) --
    The certificate-authority-data for your cluster.
    - 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.
  - clientRequestToken (string) --
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - platformVersion (string) --
    The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
  - tags (dict) --
    The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
    - (string) --
      - (string) --
  - encryptionConfig (list) --
    The encryption configuration for the cluster.
    - (dict) --
      The encryption configuration for the cluster.
      - resources (list) --
        Specifies the resources to be encrypted. The only supported value is "secrets".
        
        (string) --
      - provider (dict) --
        Key Management Service (KMS) key. Either the ARN or the alias can be used.
        
        keyArn (string) --
        Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key. For more information, see Allowing Users in Other Accounts to Use a KMS key in the Key Management Service Developer Guide .
  - connectorConfig (dict) --
    The configuration used to connect to a cluster for registration.
    - activationId (string) --
      A unique ID associated with the cluster for registration purposes.
    - activationCode (string) --
      A unique code associated with the cluster for registration purposes.
    - activationExpiry (datetime) --
      The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.
    - provider (string) --
      The cluster's cloud service provider.
    - roleArn (string) --
      The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.
  - id (string) --
    The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
  - health (dict) --
    An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
    - issues (list) --
      An object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.
      - (dict) --
        An issue with your local Amazon EKS cluster on an Amazon Web Services Outpost. You can't use this API with an Amazon EKS cluster on the Amazon Web Services cloud.
        
        code (string) --
        The error code of the issue.
        
        message (string) --
        A description of the issue.
        
        resourceIds (list) --
        The resource IDs that the issue relates to.
        
        (string) --
  - outpostConfig (dict) --
    An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
    - outpostArns (list) --
      The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.
      - (string) --
    - controlPlaneInstanceType (string) --
      The Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances.
    - controlPlanePlacement (dict) --
      An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide .
      - groupName (string) --
        The name of the placement group for the Kubernetes control plane instances.

Exceptions

EKS.Client.exceptions.ResourceNotFoundException
EKS.Client.exceptions.ClientException
EKS.Client.exceptions.ServerException
EKS.Client.exceptions.ServiceUnavailableException

Examples

This example command provides a description of the specified cluster in your default region.

response = client.describe_cluster(
    name='devel',
)

print(response)

Expected Output:

{
    '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',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}

Table Of Contents

describe_cluster¶