class CfnNodegroupPropsMixin
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.EKS.Mixins.CfnNodegroupPropsMixin |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awseks/mixins#CfnNodegroupPropsMixin |
Java | software.amazon.awscdk.mixins.preview.services.eks.mixins.CfnNodegroupPropsMixin |
Python | aws_cdk.mixins_preview.aws_eks.mixins.CfnNodegroupPropsMixin |
TypeScript | @aws-cdk/mixins-preview » aws_eks » mixins » CfnNodegroupPropsMixin |
Implements
IMixin
Extends
Mixin
Creates a managed node group for an Amazon EKS cluster.
You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template.
For later updates, you will only be able to update a node group using a launch template only if it was originally deployed with a launch template. Additionally, the launch template ID or name must match what was used when the node group was created. You can update the launch template version with necessary changes. For more information about using launch templates, see Customizing managed nodes with launch templates .
An Amazon EKS managed node group is an Amazon EC2 Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide .
Windows AMI types are only supported for commercial AWS Regions that support Windows on Amazon EKS.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as eks_mixins } from '@aws-cdk/mixins-preview/aws-eks';
const cfnNodegroupPropsMixin = new eks_mixins.CfnNodegroupPropsMixin({
amiType: 'amiType',
capacityType: 'capacityType',
clusterName: 'clusterName',
diskSize: 123,
forceUpdateEnabled: false,
instanceTypes: ['instanceTypes'],
labels: {
labelsKey: 'labels',
},
launchTemplate: {
id: 'id',
name: 'name',
version: 'version',
},
nodegroupName: 'nodegroupName',
nodeRepairConfig: {
enabled: false,
maxParallelNodesRepairedCount: 123,
maxParallelNodesRepairedPercentage: 123,
maxUnhealthyNodeThresholdCount: 123,
maxUnhealthyNodeThresholdPercentage: 123,
nodeRepairConfigOverrides: [{
minRepairWaitTimeMins: 123,
nodeMonitoringCondition: 'nodeMonitoringCondition',
nodeUnhealthyReason: 'nodeUnhealthyReason',
repairAction: 'repairAction',
}],
},
nodeRole: 'nodeRole',
releaseVersion: 'releaseVersion',
remoteAccess: {
ec2SshKey: 'ec2SshKey',
sourceSecurityGroups: ['sourceSecurityGroups'],
},
scalingConfig: {
desiredSize: 123,
maxSize: 123,
minSize: 123,
},
subnets: ['subnets'],
tags: {
tagsKey: 'tags',
},
taints: [{
effect: 'effect',
key: 'key',
value: 'value',
}],
updateConfig: {
maxUnavailable: 123,
maxUnavailablePercentage: 123,
updateStrategy: 'updateStrategy',
},
version: 'version',
}, /* all optional props */ {
strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});
Initializer
new CfnNodegroupPropsMixin(props: CfnNodegroupMixinProps, options?: CfnPropertyMixinOptions)
Parameters
- props
Cfn— L1 properties to apply.Nodegroup Mixin Props - options
Cfn— Mixin options.Property Mixin Options
Create a mixin to apply properties to AWS::EKS::Nodegroup.
Properties
| Name | Type | Description |
|---|---|---|
| props | Cfn | |
| strategy | Property | |
| static CFN_PROPERTY_KEYS | string[] |
props
Type:
Cfn
strategy
Type:
Property
static CFN_PROPERTY_KEYS
Type:
string[]
Methods
| Name | Description |
|---|---|
| apply | Apply the mixin properties to the construct. |
| supports(construct) | Check if this mixin supports the given construct. |
applyTo(construct)
public applyTo(construct: IConstruct): IConstruct
Parameters
- construct
IConstruct
Returns
Apply the mixin properties to the construct.
supports(construct)
public supports(construct: IConstruct): boolean
Parameters
- construct
IConstruct
Returns
boolean
Check if this mixin supports the given construct.

.NET
Go
Java
Python
TypeScript