Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-eks-cluster.json
Parent schema serverless-framework-configuration
Type: object

An object representing an Amazon EKS cluster.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git

Properties

ResourcesVpcConfig object required

An object representing the VPC configuration to use for an Amazon EKS cluster.

5 nested properties
SubnetIds string[] required

Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.

EndpointPrivateAccess boolean

Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.

EndpointPublicAccess boolean

Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.

PublicAccessCidrs string[]

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 CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.

SecurityGroupIds string[]

Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.

RoleArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

EncryptionConfig EncryptionConfig[]
KubernetesNetworkConfig object

The Kubernetes network configuration for the cluster.

3 nested properties
ServiceIpv4Cidr string | Aws_CF_FunctionString

The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC.

ServiceIpv6Cidr string | Aws_CF_FunctionString

The CIDR block to assign Kubernetes service IP addresses from.

IpFamily string | Aws_CF_FunctionString

Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on

Logging object

Enable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs.

1 nested properties
ClusterLogging object

The cluster control plane logging configuration for your cluster.

1 nested properties
EnabledTypes LoggingTypeConfig[]

Enable control plane logs for your cluster, all log types will be disabled if the array is empty

Name string | Aws_CF_FunctionString

The unique name to give to your cluster.

OutpostConfig object

An object representing the Outpost configuration to use for AWS EKS outpost cluster.

3 nested properties
OutpostArns string[] required

Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster.

ControlPlaneInstanceType string | Aws_CF_FunctionString required

Specify the Instance type of the machines that should be used to create your cluster.

ControlPlanePlacement object

Specify the placement group of the control plane machines for your cluster.

1 nested properties
GroupName string | Aws_CF_FunctionString

Specify the placement group name of the control place machines for your cluster.

Version string | Aws_CF_FunctionString

The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

Tags Tag[]

An array of key-value pairs to apply to this resource.

uniqueItems=true

Definitions

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Provider object
KeyArn string | Aws_CF_FunctionString

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.

EncryptionConfig object

The encryption configuration for the cluster

Provider object
1 nested properties
KeyArn string | Aws_CF_FunctionString

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.

Resources string[]

Specifies the resources to be encrypted. The only supported value is "secrets".

ResourcesVpcConfig object

An object representing the VPC configuration to use for an Amazon EKS cluster.

SubnetIds string[] required

Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.

EndpointPrivateAccess boolean

Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.

EndpointPublicAccess boolean

Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.

PublicAccessCidrs string[]

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 CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.

SecurityGroupIds string[]

Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.

LoggingTypeConfig object

Enabled Logging Type

Type string | Aws_CF_FunctionString

name of the log type

EnabledTypes LoggingTypeConfig[]

Enable control plane logs for your cluster, all log types will be disabled if the array is empty

ClusterLogging object

The cluster control plane logging configuration for your cluster.

EnabledTypes LoggingTypeConfig[]

Enable control plane logs for your cluster, all log types will be disabled if the array is empty

Logging object

Enable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs.

ClusterLogging object

The cluster control plane logging configuration for your cluster.

1 nested properties
EnabledTypes LoggingTypeConfig[]

Enable control plane logs for your cluster, all log types will be disabled if the array is empty

KubernetesNetworkConfig object

The Kubernetes network configuration for the cluster.

ServiceIpv4Cidr string | Aws_CF_FunctionString

The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC.

ServiceIpv6Cidr string | Aws_CF_FunctionString

The CIDR block to assign Kubernetes service IP addresses from.

IpFamily string | Aws_CF_FunctionString

Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on

ControlPlanePlacement object

Specify the placement group of the control plane machines for your cluster.

GroupName string | Aws_CF_FunctionString

Specify the placement group name of the control place machines for your cluster.

OutpostConfig object

An object representing the Outpost configuration to use for AWS EKS outpost cluster.

OutpostArns string[] required

Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster.

ControlPlaneInstanceType string | Aws_CF_FunctionString required

Specify the Instance type of the machines that should be used to create your cluster.

ControlPlanePlacement object

Specify the placement group of the control plane machines for your cluster.

1 nested properties
GroupName string | Aws_CF_FunctionString

Specify the placement group name of the control place machines for your cluster.