Type Alias PostLkeClusterData

Type Declaration

• Optionalapl_enabled?: boolean

  Write-once Indicates whether the Akamai App Platform is installed during creation of the LKE cluster. It defaults to false. If set to true, control_plane.high_availability also needs to be true. Automatic installation of the App Platform is only possible when creating a new cluster (not when modifying existing clusters).

• 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.

  • 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.

• k8s_version: string

  Filterable The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>. The latest supported patch version is deployed.

• label: 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.

• node_pools: {
      autoscaler?: { enabled?: boolean; max?: number; min?: number };
      count: number;
      disk_encryption?: "enabled" | "disabled";
      disks?: { size?: number; type?: "raw" | "ext4" }[];
      k8s_version?: string;
      label?: string;
      labels?: { [key: string]: string };
      tags?: string[];
      taints?: {
          effect: "NoSchedule" | "PreferNoSchedule" | "NoExecute";
          key: string;
          value: string;
      }[];
      type: string;
      update_strategy?: "rolling_update"
      | "on_recycle";
  }[]

• region: string

  Filterable This Kubernetes cluster's location.

• Optionalstack_type?: "ipv4" | "ipv4-ipv6"

  Beta, LKE Enterprise The networking stack type of the Kubernetes cluster. This specifies that the cluster is IPv4 only (default) or supports both IPv4 and IPv6 (dual-stack).

  🚧

  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.

• Optionalsubnet_id?: number

  Beta, LKE Enterprise The ID of the VPC subnet to use for the Kubernetes cluster. This subnet must have both IPv4 and IPv6 enabled (dual-stack). When this field is specified, the cluster is deployed to the given subnet and its corresponding VPC. To specify a VPC and have a subnet auto-allocated, use vpc_id instead. If subnet_id and vpc_id are both unspecified, a new VPC and subnet are auto-allocated for the cluster.

  🚧

  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.

• Optionaltags?: string[]

  Filterable An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only.

• Optionaltier?: "standard" | "enterprise"

  Beta, Filterable The desired Kubernetes tier, either standard or enterprise.

  🚧

  This field is available as part of the beta API. Call the URL with the apiVersion path parameter set to v4beta.

• Optionalvpc_id?: number

  Beta, LKE Enterprise The ID of the VPC to use for the Kubernetes cluster. An appropriately sized subnet is auto-allocated. To specify an existing subnet, use subnet_id instead. If subnet_id and vpc_id are both unspecified, a new VPC and subnet are auto-allocated for the cluster.

  🚧

  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.