EKS / Client / describe_cluster_versions

describe_cluster_versions

EKS.Client.describe_cluster_versions(**kwargs)

Lists available Kubernetes versions for Amazon EKS clusters.

See also: AWS API Documentation

Request Syntax

response = client.describe_cluster_versions(
    clusterType='string',
    maxResults=123,
    nextToken='string',
    defaultOnly=True|False,
    includeAll=True|False,
    clusterVersions=[
        'string',
    ],
    status='unsupported'|'standard-support'|'extended-support',
    versionStatus='UNSUPPORTED'|'STANDARD_SUPPORT'|'EXTENDED_SUPPORT'
)
Parameters:

  • clusterType (string) – The type of cluster to filter versions by.

  • maxResults (integer) – Maximum number of results to return.

  • nextToken (string) – Pagination token for the next set of results.

  • defaultOnly (boolean) – Filter to show only default versions.

  • includeAll (boolean) – Include all available versions in the response.

  • clusterVersions (list) –

    List of specific cluster versions to describe.

    • (string) –

  • status (string) –

    Warning

    This field is deprecated. Use versionStatus instead, as that field matches for input and output of this action.

    Filter versions by their current status.

  • versionStatus (string) – Filter versions by their current status.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'clusterVersions': [
        {
            'clusterVersion': 'string',
            'clusterType': 'string',
            'defaultPlatformVersion': 'string',
            'defaultVersion': True|False,
            'releaseDate': datetime(2015, 1, 1),
            'endOfStandardSupportDate': datetime(2015, 1, 1),
            'endOfExtendedSupportDate': datetime(2015, 1, 1),
            'status': 'unsupported'|'standard-support'|'extended-support',
            'versionStatus': 'UNSUPPORTED'|'STANDARD_SUPPORT'|'EXTENDED_SUPPORT',
            'kubernetesPatchVersion': 'string',
            'controlPlaneScalingTiers': [
                {
                    'tierName': 'string',
                    'apiRequestConcurrency': 123,
                    'podSchedulingRatePerSecond': 123,
                    'clusterDatabaseSizeGb': 123,
                    'controlPlaneComponentConfigOverrides': {
                        'kubeApiServerConfig': {
                            'eventTtl': {
                                'defaultValue': 'string',
                                'constraints': {
                                    'min': 'string',
                                    'max': 'string'
                                }
                            },
                            'serviceNodePortRange': {
                                'defaultValue': {
                                    'minPort': 123,
                                    'maxPort': 123
                                },
                                'constraints': {
                                    'minPort': {
                                        'min': 123,
                                        'max': 123
                                    },
                                    'maxPort': {
                                        'min': 123,
                                        'max': 123
                                    }
                                }
                            }
                        },
                        'kubeSchedulerConfig': {
                            'nodeResourcesFit': {
                                'scoringStrategy': {
                                    'defaultValue': {
                                        'type': 'LeastAllocated'|'MostAllocated',
                                        'resources': [
                                            {
                                                'name': 'string',
                                                'weight': 123
                                            },
                                        ]
                                    },
                                    'constraints': {
                                        'scoringStrategy': {
                                            'allowedValues': [
                                                'string',
                                            ]
                                        },
                                        'resources': {
                                            'name': {
                                                'allowedValues': [
                                                    'string',
                                                ]
                                            },
                                            'weight': {
                                                'min': 123,
                                                'max': 123
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        'kubeControllerManagerConfig': {
                            'horizontalPodAutoscalerControllerConfig': {
                                'horizontalPodAutoscalerSyncPeriod': {
                                    'defaultValue': 'string',
                                    'constraints': {
                                        'min': 'string',
                                        'max': 'string'
                                    }
                                }
                            }
                        }
                    }
                },
            ],
            'controlPlaneComponentConfig': {
                'kubeApiServerConfig': {
                    'eventTtl': {
                        'defaultValue': 'string',
                        'constraints': {
                            'min': 'string',
                            'max': 'string'
                        }
                    },
                    'serviceNodePortRange': {
                        'defaultValue': {
                            'minPort': 123,
                            'maxPort': 123
                        },
                        'constraints': {
                            'minPort': {
                                'min': 123,
                                'max': 123
                            },
                            'maxPort': {
                                'min': 123,
                                'max': 123
                            }
                        }
                    }
                },
                'kubeSchedulerConfig': {
                    'nodeResourcesFit': {
                        'scoringStrategy': {
                            'defaultValue': {
                                'type': 'LeastAllocated'|'MostAllocated',
                                'resources': [
                                    {
                                        'name': 'string',
                                        'weight': 123
                                    },
                                ]
                            },
                            'constraints': {
                                'scoringStrategy': {
                                    'allowedValues': [
                                        'string',
                                    ]
                                },
                                'resources': {
                                    'name': {
                                        'allowedValues': [
                                            'string',
                                        ]
                                    },
                                    'weight': {
                                        'min': 123,
                                        'max': 123
                                    }
                                }
                            }
                        }
                    }
                },
                'kubeControllerManagerConfig': {
                    'horizontalPodAutoscalerControllerConfig': {
                        'horizontalPodAutoscalerSyncPeriod': {
                            'defaultValue': 'string',
                            'constraints': {
                                'min': 'string',
                                'max': 'string'
                            }
                        }
                    }
                }
            }
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      Pagination token for the next set of results.

    • clusterVersions (list) –

      List of cluster version information objects.

      • (dict) –

        Contains details about a specific EKS cluster version.

        • clusterVersion (string) –

          The Kubernetes version for the cluster.

        • clusterType (string) –

          The type of cluster this version is for.

        • defaultPlatformVersion (string) –

          Default platform version for this Kubernetes version.

        • defaultVersion (boolean) –

          Indicates if this is a default version.

        • releaseDate (datetime) –

          The release date of this cluster version.

        • endOfStandardSupportDate (datetime) –

          Date when standard support ends for this version.

        • endOfExtendedSupportDate (datetime) –

          Date when extended support ends for this version.

        • status (string) –

          Warning

          This field is deprecated. Use versionStatus instead, as that field matches for input and output of this action.

          Current status of this cluster version.

        • versionStatus (string) –

          Current status of this cluster version.

        • kubernetesPatchVersion (string) –

          The patch version of Kubernetes for this cluster version.

        • controlPlaneScalingTiers (list) –

          The available provisioned control plane scaling tiers and their capabilities for this Kubernetes version.

          • (dict) –

            Information about a provisioned control plane scaling tier.

            • tierName (string) –

              The name of the scaling tier.

            • apiRequestConcurrency (integer) –

              The maximum API request concurrency supported by this tier.

            • podSchedulingRatePerSecond (integer) –

              The maximum pod scheduling rate per second supported by this tier.

            • clusterDatabaseSizeGb (integer) –

              The maximum cluster database size in GB supported by this tier.

            • controlPlaneComponentConfigOverrides (dict) –

              The control plane component configuration overrides specific to this scaling tier.

              • kubeApiServerConfig (dict) –

                The Kubernetes API server configuration defaults and constraints.

                • eventTtl (dict) –

                  The event TTL configuration with default value and constraints.

                  • defaultValue (string) –

                    The default value for the duration parameter.

                  • constraints (dict) –

                    The constraints for the duration parameter.

                    • min (string) –

                      The minimum allowed duration value.

                    • max (string) –

                      The maximum allowed duration value.

                • serviceNodePortRange (dict) –

                  The service node port range configuration with default value and constraints.

                  • defaultValue (dict) –

                    The default port range value.

                    • minPort (integer) –

                      The minimum port number in the range.

                    • maxPort (integer) –

                      The maximum port number in the range.

                  • constraints (dict) –

                    The constraints for the port range parameter.

                    • minPort (dict) –

                      The constraints for the minimum port value.

                      • min (integer) –

                        The minimum allowed value.

                      • max (integer) –

                        The maximum allowed value.

                    • maxPort (dict) –

                      The constraints for the maximum port value.

                      • min (integer) –

                        The minimum allowed value.

                      • max (integer) –

                        The maximum allowed value.

              • kubeSchedulerConfig (dict) –

                The Kubernetes scheduler configuration defaults and constraints.

                • nodeResourcesFit (dict) –

                  The NodeResourcesFit configuration with default value and constraints.

                  • scoringStrategy (dict) –

                    The scoring strategy configuration with default value and constraints.

                    • defaultValue (dict) –

                      The default scoring strategy.

                      • type (string) –

                        The scoring strategy type. Valid values are LeastAllocated or MostAllocated.

                      • resources (list) –

                        The resource weights used for scoring nodes.

                        • (dict) –

                          A resource weight entry for the scheduler scoring strategy.

                          • name (string) –

                            The name of the resource (for example, cpu or memory).

                          • weight (integer) –

                            The weight assigned to the resource for scoring. Must be between 1 and 100.

                    • constraints (dict) –

                      The constraints for the scoring strategy.

                      • scoringStrategy (dict) –

                        The allowed values for the scoring strategy type.

                        • allowedValues (list) –

                          The list of allowed values.

                          • (string) –

                      • resources (dict) –

                        The constraints for resource weights.

                        • name (dict) –

                          The allowed values for resource names.

                          • allowedValues (list) –

                            The list of allowed values.

                            • (string) –

                        • weight (dict) –

                          The allowed range for resource weight values.

                          • min (integer) –

                            The minimum allowed value.

                          • max (integer) –

                            The maximum allowed value.

              • kubeControllerManagerConfig (dict) –

                The Kubernetes controller manager configuration defaults and constraints.

                • horizontalPodAutoscalerControllerConfig (dict) –

                  The horizontal pod autoscaler controller configuration with default value and constraints.

                  • horizontalPodAutoscalerSyncPeriod (dict) –

                    The HPA sync period configuration with default value and constraints.

                    • defaultValue (string) –

                      The default value for the duration parameter.

                    • constraints (dict) –

                      The constraints for the duration parameter.

                      • min (string) –

                        The minimum allowed duration value.

                      • max (string) –

                        The maximum allowed duration value.

        • controlPlaneComponentConfig (dict) –

          The default control plane component configuration and constraints for this Kubernetes version.

          • kubeApiServerConfig (dict) –

            The Kubernetes API server configuration defaults and constraints.

            • eventTtl (dict) –

              The event TTL configuration with default value and constraints.

              • defaultValue (string) –

                The default value for the duration parameter.

              • constraints (dict) –

                The constraints for the duration parameter.

                • min (string) –

                  The minimum allowed duration value.

                • max (string) –

                  The maximum allowed duration value.

            • serviceNodePortRange (dict) –

              The service node port range configuration with default value and constraints.

              • defaultValue (dict) –

                The default port range value.

                • minPort (integer) –

                  The minimum port number in the range.

                • maxPort (integer) –

                  The maximum port number in the range.

              • constraints (dict) –

                The constraints for the port range parameter.

                • minPort (dict) –

                  The constraints for the minimum port value.

                  • min (integer) –

                    The minimum allowed value.

                  • max (integer) –

                    The maximum allowed value.

                • maxPort (dict) –

                  The constraints for the maximum port value.

                  • min (integer) –

                    The minimum allowed value.

                  • max (integer) –

                    The maximum allowed value.

          • kubeSchedulerConfig (dict) –

            The Kubernetes scheduler configuration defaults and constraints.

            • nodeResourcesFit (dict) –

              The NodeResourcesFit configuration with default value and constraints.

              • scoringStrategy (dict) –

                The scoring strategy configuration with default value and constraints.

                • defaultValue (dict) –

                  The default scoring strategy.

                  • type (string) –

                    The scoring strategy type. Valid values are LeastAllocated or MostAllocated.

                  • resources (list) –

                    The resource weights used for scoring nodes.

                    • (dict) –

                      A resource weight entry for the scheduler scoring strategy.

                      • name (string) –

                        The name of the resource (for example, cpu or memory).

                      • weight (integer) –

                        The weight assigned to the resource for scoring. Must be between 1 and 100.

                • constraints (dict) –

                  The constraints for the scoring strategy.

                  • scoringStrategy (dict) –

                    The allowed values for the scoring strategy type.

                    • allowedValues (list) –

                      The list of allowed values.

                      • (string) –

                  • resources (dict) –

                    The constraints for resource weights.

                    • name (dict) –

                      The allowed values for resource names.

                      • allowedValues (list) –

                        The list of allowed values.

                        • (string) –

                    • weight (dict) –

                      The allowed range for resource weight values.

                      • min (integer) –

                        The minimum allowed value.

                      • max (integer) –

                        The maximum allowed value.

          • kubeControllerManagerConfig (dict) –

            The Kubernetes controller manager configuration defaults and constraints.

            • horizontalPodAutoscalerControllerConfig (dict) –

              The horizontal pod autoscaler controller configuration with default value and constraints.

              • horizontalPodAutoscalerSyncPeriod (dict) –

                The HPA sync period configuration with default value and constraints.

                • defaultValue (string) –

                  The default value for the duration parameter.

                • constraints (dict) –

                  The constraints for the duration parameter.

                  • min (string) –

                    The minimum allowed duration value.

                  • max (string) –

                    The maximum allowed duration value.

Exceptions