@akamai/openapi-ts
    Preparing search index...

    Type Alias PutLkeClusterData

    type PutLkeClusterData = {
        body?: {
            control_plane?: {
                acl?: {
                    addresses?: { ipv4?: string[]; ipv6?: string[] };
                    enabled?: boolean;
                    "revision-id"?: string;
                };
                audit_logs_enabled?: boolean;
                high_availability?: boolean;
            };
            k8s_version?: string;
            label?: string;
            tags?: string[];
        };
        path: { clusterId: number };
        query?: never;
        url: "lke/clusters/{clusterId}";
    }
    Index

    Properties

    body? path query? url

    Properties

    Optionalbody

    body?: {
        control_plane?: {
            acl?: {
                addresses?: { ipv4?: string[]; ipv6?: string[] };
                enabled?: boolean;
                "revision-id"?: string;
            };
            audit_logs_enabled?: boolean;
            high_availability?: boolean;
        };
        k8s_version?: string;
        label?: string;
        tags?: string[];
    }

    The fields to update the Kubernetes cluster.

    Type Declaration

    • Optionalcontrol_plane?: {
          acl?: {
              addresses?: { ipv4?: string[]; ipv6?: string[] };
              enabled?: boolean;
              "revision-id"?: string;
          };
          audit_logs_enabled?: boolean;
          high_availability?: boolean;
      }

      Defines settings for the Kubernetes control plane, including High Availability (HA) and an IP-based Access Control List (ACL) for the control plane components.

      When upgrading pre-existing LKE clusters to use the HA Control Plane, the following changes will additionally occur:

      • All nodes will be deleted and new nodes will be created to replace them.

      • Any local storage (such as hostPath volumes) will be erased.

      • The upgrade process may take several minutes to complete, as nodes will be replaced on a rolling basis.

      When upgrading pre-existing LKE clusters to use the control plane ACL for the first time, it may take several hours for external clients to respect the access control settings. This is partly due to delays from DNS propagation.

      • Optionalacl?: {
            addresses?: { ipv4?: string[]; ipv6?: string[] };
            enabled?: boolean;
            "revision-id"?: string;
        }

        Defines settings related to the IP-based ACL of the LKE cluster. The object requires the enabled and addresses keys. It also supports the optional key revision-id. The default policy is set to ALLOW, so that access controls are disabled. An empty object value ({}) sets default elements.

        • Optionaladdresses?: { ipv4?: string[]; ipv6?: string[] }

          Supports keys ipv4 and ipv6. Defaults to {}.

          • Optionalipv4?: string[]

            A list of individual ipv4 addresses or CIDRs to ALLOW. Defaults to [].

          • Optionalipv6?: string[]

            A list of individual ipv6 addresses or CIDRs to ALLOW. Defaults to [].

        • Optionalenabled?: boolean

          Defines a default policy. A value of true results in a default policy of DENY. A value of false results in a default policy of ALLOW, such as for disabled access controls. It defaults to true. Creating a cluster with ACL, or upgrading a cluster to use ACL for LKE, is an irreversible change. Once upgraded, you can only toggle access controls with this field.

        • Optionalrevision-id?: string

          Enables clients to track events related to ACL update requests and enforcements. Optional field. If omitted, defaults to a randomly generated string.

      • Optionalaudit_logs_enabled?: boolean

        Beta, LKE Enterprise Enables audit logs on the cluster's control plane. These logs provide detailed information about user access and the operations performed on the cluster, which can be useful for security and compliance purposes.

        🚧

        This field is available as part of the beta API and can only be used with accounts that have been enrolled in the LKE Enterprise LA. Call the URL with the apiVersion path parameter set to v4beta.

      • Optionalhigh_availability?: boolean

        Enables High Availability for the cluster's control plane components. It defaults to false. Enabling High Availability for LKE is an irreversible change.

    • Optionalk8s_version?: string

      The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>. New and recycled Nodes in this cluster will be installed with the latest available patch for the Cluster's Kubernetes version.

      When upgrading the Kubernetes version, only the next latest minor version following the current version can be deployed. For example, a cluster with Kubernetes version 1.29 can be upgraded to version 1.30, but not directly to 1.31.

      The Kubernetes version of a cluster can not be downgraded.

    • Optionallabel?: string

      Filterable This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:

      • UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character か is 3 bytes in UTF-8 (0xE382AB). Its Unicode code point is 2 bytes (0x30AB). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point ("カ").

      • 4 byte UTF-8 characters are not supported.

      • If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.

    • Optionaltags?: string[]

      An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only. To delete a tag, exclude it from your tags array.

    path: { clusterId: number }

    Type Declaration

    • clusterId: number

      ID of the Kubernetes cluster to look up.

    query?: never
    url: "lke/clusters/{clusterId}"

    Settings

    Member Visibility

    On This Page

    Properties