Class CfnNodegroupProps
Properties for defining a CfnNodegroup.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.EKSv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnNodegroupProps : ICfnNodegroupPropsSyntax (vb)
Public Class CfnNodegroupProps Implements ICfnNodegroupPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EKSv2;
var cfnNodegroupProps = new CfnNodegroupProps {
ClusterName = "clusterName",
NodeRole = "nodeRole",
Subnets = new [] { "subnets" },
// the properties below are optional
AmiType = "amiType",
CapacityType = "capacityType",
DiskSize = 123,
ForceUpdateEnabled = false,
InstanceTypes = new [] { "instanceTypes" },
Labels = new Dictionary<string, string> {
{ "labelsKey", "labels" }
},
LaunchTemplate = new LaunchTemplateSpecificationProperty {
Id = "id",
Name = "name",
Version = "version"
},
NodegroupName = "nodegroupName",
NodeRepairConfig = new NodeRepairConfigProperty {
Enabled = false,
MaxParallelNodesRepairedCount = 123,
MaxParallelNodesRepairedPercentage = 123,
MaxUnhealthyNodeThresholdCount = 123,
MaxUnhealthyNodeThresholdPercentage = 123,
NodeRepairConfigOverrides = new [] { new NodeRepairConfigOverridesProperty {
MinRepairWaitTimeMins = 123,
NodeMonitoringCondition = "nodeMonitoringCondition",
NodeUnhealthyReason = "nodeUnhealthyReason",
RepairAction = "repairAction"
} }
},
ReleaseVersion = "releaseVersion",
RemoteAccess = new RemoteAccessProperty {
Ec2SshKey = "ec2SshKey",
// the properties below are optional
SourceSecurityGroups = new [] { "sourceSecurityGroups" }
},
ScalingConfig = new ScalingConfigProperty {
DesiredSize = 123,
MaxSize = 123,
MinSize = 123
},
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
Taints = new [] { new TaintProperty {
Effect = "effect",
Key = "key",
Value = "value"
} },
UpdateConfig = new UpdateConfigProperty {
MaxUnavailable = 123,
MaxUnavailablePercentage = 123,
UpdateStrategy = "updateStrategy"
},
Version = "version",
WarmPoolConfig = new WarmPoolConfigProperty {
Enabled = false,
MaxGroupPreparedCapacity = 123,
MinSize = 123,
PoolState = "poolState",
ReuseOnScaleIn = false
}
};Synopsis
Constructors
| CfnNodegroupProps() | Properties for defining a |
Properties
| AmiType | The AMI type for your node group. |
| CapacityType | The capacity type of your managed node group. |
| ClusterName | The name of your cluster. |
| DiskSize | The root device disk size (in GiB) for your node group instances. |
| ForceUpdateEnabled | Force the update if any |
| InstanceTypes | Specify the instance types for a node group. |
| Labels | The Kubernetes |
| LaunchTemplate | An object representing a node group's launch template specification. |
| NodeRepairConfig | The node auto repair configuration for the node group. |
| NodeRole | The Amazon Resource Name (ARN) of the IAM role to associate with your node group. |
| NodegroupName | The unique name to give your node group. |
| ReleaseVersion | The AMI version of the Amazon EKS optimized AMI to use with your node group (for example, |
| RemoteAccess | The remote access configuration to use with your node group. |
| ScalingConfig | The scaling configuration details for the Auto Scaling group that is created for your node group. |
| Subnets | The subnets to use for the Auto Scaling group that is created for your node group. |
| Tags | Metadata that assists with categorization and organization. |
| Taints | The Kubernetes taints to be applied to the nodes in the node group when they are created. |
| UpdateConfig | The node group update configuration. |
| Version | The Kubernetes version to use for your managed nodes. |
| WarmPoolConfig | The warm pool configuration for the node group. |
Constructors
CfnNodegroupProps()
Properties for defining a CfnNodegroup.
public CfnNodegroupProps()Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EKSv2;
var cfnNodegroupProps = new CfnNodegroupProps {
ClusterName = "clusterName",
NodeRole = "nodeRole",
Subnets = new [] { "subnets" },
// the properties below are optional
AmiType = "amiType",
CapacityType = "capacityType",
DiskSize = 123,
ForceUpdateEnabled = false,
InstanceTypes = new [] { "instanceTypes" },
Labels = new Dictionary<string, string> {
{ "labelsKey", "labels" }
},
LaunchTemplate = new LaunchTemplateSpecificationProperty {
Id = "id",
Name = "name",
Version = "version"
},
NodegroupName = "nodegroupName",
NodeRepairConfig = new NodeRepairConfigProperty {
Enabled = false,
MaxParallelNodesRepairedCount = 123,
MaxParallelNodesRepairedPercentage = 123,
MaxUnhealthyNodeThresholdCount = 123,
MaxUnhealthyNodeThresholdPercentage = 123,
NodeRepairConfigOverrides = new [] { new NodeRepairConfigOverridesProperty {
MinRepairWaitTimeMins = 123,
NodeMonitoringCondition = "nodeMonitoringCondition",
NodeUnhealthyReason = "nodeUnhealthyReason",
RepairAction = "repairAction"
} }
},
ReleaseVersion = "releaseVersion",
RemoteAccess = new RemoteAccessProperty {
Ec2SshKey = "ec2SshKey",
// the properties below are optional
SourceSecurityGroups = new [] { "sourceSecurityGroups" }
},
ScalingConfig = new ScalingConfigProperty {
DesiredSize = 123,
MaxSize = 123,
MinSize = 123
},
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
Taints = new [] { new TaintProperty {
Effect = "effect",
Key = "key",
Value = "value"
} },
UpdateConfig = new UpdateConfigProperty {
MaxUnavailable = 123,
MaxUnavailablePercentage = 123,
UpdateStrategy = "updateStrategy"
},
Version = "version",
WarmPoolConfig = new WarmPoolConfigProperty {
Enabled = false,
MaxGroupPreparedCapacity = 123,
MinSize = 123,
PoolState = "poolState",
ReuseOnScaleIn = false
}
};Properties
AmiType
The AMI type for your node group.
public string? AmiType { get; set; }Property Value
Remarks
If you specify launchTemplate , and your launch template uses a custom AMI, then don't specify amiType , or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap . For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide .
CapacityType
The capacity type of your managed node group.
public string? CapacityType { get; set; }Property Value
Remarks
ClusterName
The name of your cluster.
public object ClusterName { get; set; }Property Value
Remarks
Type union: either string or IClusterRef
DiskSize
The root device disk size (in GiB) for your node group instances.
public double? DiskSize { get; set; }Property Value
Remarks
The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify launchTemplate , then don't specify diskSize , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide .
ForceUpdateEnabled
Force the update if any Pod on the existing node group can't be drained due to a Pod disruption budget issue.
public object? ForceUpdateEnabled { get; set; }Property Value
Remarks
If an update fails because all Pods can't be drained, you can force the update after it fails to terminate the old node whether or not any Pod is running on the node.
Default: - false
Type union: either bool or IResolvable
InstanceTypes
Specify the instance types for a node group.
public string[]? InstanceTypes { get; set; }Property Value
string[]
Remarks
If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate , then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes . If however, you specify an instance type in your launch template and specify any instanceTypes , the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes , then t3.medium is used, by default. If you specify Spot for capacityType , then we recommend specifying multiple values for instanceTypes . For more information, see Managed node group capacity types and Customizing managed nodes with launch templates in the Amazon EKS User Guide .
Labels
The Kubernetes labels applied to the nodes in the node group.
public object? Labels { get; set; }Property Value
Remarks
Only <code>labels</code> that are applied with the Amazon EKS API are shown here. There may be other Kubernetes <code>labels</code> applied to the nodes in this group.
Type union: either IResolvable or Dictionary<string, string>
LaunchTemplate
An object representing a node group's launch template specification.
public object? LaunchTemplate { get; set; }Property Value
Remarks
When using this object, don't directly specify instanceTypes , diskSize , or remoteAccess . You cannot later specify a different launch template ID or name than what was used to create the node group.
Make sure that the launch template meets the requirements in launchTemplateSpecification . Also refer to Customizing managed nodes with launch templates in the Amazon EKS User Guide .
Type union: either IResolvable or CfnNodegroup.ILaunchTemplateSpecificationProperty
NodeRepairConfig
The node auto repair configuration for the node group.
public object? NodeRepairConfig { get; set; }Property Value
Remarks
NodeRole
The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
public object NodeRole { get; set; }Property Value
Remarks
The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify launchTemplate , then don't specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide .
Type union: either string or IRoleRef
NodegroupName
The unique name to give your node group.
public string? NodegroupName { get; set; }Property Value
Remarks
ReleaseVersion
The AMI version of the Amazon EKS optimized AMI to use with your node group (for example, 1.14.7- *YYYYMMDD* ). By default, the latest available AMI version for the node group's current Kubernetes version is used. For more information, see Amazon EKS optimized Linux AMI Versions in the Amazon EKS User Guide .
public string? ReleaseVersion { get; set; }Property Value
Remarks
Changing this value triggers an update of the node group if one is available. You can't update other properties at the same time as updating <code>Release Version</code> .
RemoteAccess
The remote access configuration to use with your node group.
public object? RemoteAccess { get; set; }Property Value
Remarks
For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate , then don't specify remoteAccess , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide .
Type union: either IResolvable or CfnNodegroup.IRemoteAccessProperty
ScalingConfig
The scaling configuration details for the Auto Scaling group that is created for your node group.
public object? ScalingConfig { get; set; }Property Value
Remarks
Subnets
The subnets to use for the Auto Scaling group that is created for your node group.
public object[] Subnets { get; set; }Property Value
object[]
Remarks
If you specify launchTemplate , then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide .
Type union: (either string or ISubnetRef)[]
Tags
Metadata that assists with categorization and organization.
public IDictionary<string, string>? Tags { get; set; }Property Value
Remarks
Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources.
Taints
The Kubernetes taints to be applied to the nodes in the node group when they are created.
public object? Taints { get; set; }Property Value
Remarks
Effect is one of No_Schedule , Prefer_No_Schedule , or No_Execute . Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. For more information, see Node taints on managed node groups .
Type union: either IResolvable or (either IResolvable or CfnNodegroup.ITaintProperty)[]
UpdateConfig
The node group update configuration.
public object? UpdateConfig { get; set; }Property Value
Remarks
Version
The Kubernetes version to use for your managed nodes.
public string? Version { get; set; }Property Value
Remarks
By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate , and your launch template uses a custom AMI, then don't specify version , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide .
You can't update other properties at the same time as updating <code>Version</code> .
WarmPoolConfig
The warm pool configuration for the node group.
public object? WarmPoolConfig { get; set; }