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

Resource schema for AWS::EKS::Nodegroup. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

ClusterName string | Aws_CF_FunctionString required

Name of the cluster to create the node group in.

NodeRole string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the IAM role to associate with your node group.

Subnets string[] required

The subnets to use for the Auto Scaling group that is created for your node group.

AmiType string | Aws_CF_FunctionString

The AMI type for your node group.

CapacityType string | Aws_CF_FunctionString

The capacity type of your managed node group.

DiskSize integer

The root device disk size (in GiB) for your node group instances.

ForceUpdateEnabled boolean

Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.

Default: false
InstanceTypes string[]

Specify the instance types for a node group.

Labels object

The Kubernetes labels to be applied to the nodes in the node group when they are created.

LaunchTemplate object

An object representing a launch template specification for AWS EKS Nodegroup.

3 nested properties
Id string | Aws_CF_FunctionString
Version string | Aws_CF_FunctionString
Name string | Aws_CF_FunctionString
NodegroupName string | Aws_CF_FunctionString

The unique name to give your node group.

ReleaseVersion string | Aws_CF_FunctionString

The AMI version of the Amazon EKS-optimized AMI to use with your node group.

RemoteAccess object

An object representing a remote access configuration specification for AWS EKS Nodegroup.

2 nested properties
Ec2SshKey string | Aws_CF_FunctionString required
SourceSecurityGroups string[]
ScalingConfig object

An object representing a auto scaling group specification for AWS EKS Nodegroup.

3 nested properties
MinSize integer
min=0
DesiredSize integer
min=0
MaxSize integer
min=1
Tags object

The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.

Taints Taint[]

The Kubernetes taints to be applied to the nodes in the node group when they are created.

UpdateConfig object

The node group update configuration.

2 nested properties
MaxUnavailable number

The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.

min=1
MaxUnavailablePercentage number

The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.

min=1max=100
Version string | Aws_CF_FunctionString

The Kubernetes version to use for your managed nodes.

Definitions

LaunchTemplateSpecification object

An object representing a launch template specification for AWS EKS Nodegroup.

Id string | Aws_CF_FunctionString
Version string | Aws_CF_FunctionString
Name string | Aws_CF_FunctionString
Taint object

An object representing a Taint specification for AWS EKS Nodegroup.

Key string | Aws_CF_FunctionString
Value string | Aws_CF_FunctionString
Effect string | Aws_CF_FunctionString
ScalingConfig object

An object representing a auto scaling group specification for AWS EKS Nodegroup.

MinSize integer
min=0
DesiredSize integer
min=0
MaxSize integer
min=1
RemoteAccess object

An object representing a remote access configuration specification for AWS EKS Nodegroup.

Ec2SshKey string | Aws_CF_FunctionString required
SourceSecurityGroups string[]
UpdateConfig object

The node group update configuration.

MaxUnavailable number

The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.

min=1
MaxUnavailablePercentage number

The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.

min=1max=100