Interface ICfnNodegroupProps
Properties for defining a CfnNodegroup
.
Namespace: Amazon.CDK.AWS.EKS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnNodegroupProps
Syntax (vb)
Public Interface ICfnNodegroupProps
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.EKS;
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",
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
},
Version = "version"
};
Synopsis
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. |
NodegroupName | The unique name to give your node group. |
NodeRole | The Amazon Resource Name (ARN) of the IAM role to associate with 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. |
Properties
AmiType
The AMI type for your node group.
virtual string AmiType { get; }
Property Value
System.String
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.
virtual string CapacityType { get; }
Property Value
System.String
Remarks
ClusterName
The name of your cluster.
string ClusterName { get; }
Property Value
System.String
Remarks
DiskSize
The root device disk size (in GiB) for your node group instances.
virtual Nullable<double> DiskSize { get; }
Property Value
System.Nullable<System.Double>
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.
virtual object ForceUpdateEnabled { get; }
Property Value
System.Object
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
InstanceTypes
Specify the instance types for a node group.
virtual string[] InstanceTypes { get; }
Property Value
System.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.
virtual object Labels { get; }
Property Value
System.Object
Remarks
Only labels
that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels
applied to the nodes in this group.
LaunchTemplate
An object representing a node group's launch template specification.
virtual object LaunchTemplate { get; }
Property Value
System.Object
Remarks
When using this object, don't directly specify instanceTypes
, diskSize
, or remoteAccess
. 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 .
NodegroupName
The unique name to give your node group.
virtual string NodegroupName { get; }
Property Value
System.String
Remarks
NodeRole
The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
string NodeRole { get; }
Property Value
System.String
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 .
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 .
virtual string ReleaseVersion { get; }
Property Value
System.String
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 Release Version
.
RemoteAccess
The remote access configuration to use with your node group.
virtual object RemoteAccess { get; }
Property Value
System.Object
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 .
ScalingConfig
The scaling configuration details for the Auto Scaling group that is created for your node group.
virtual object ScalingConfig { get; }
Property Value
System.Object
Remarks
Subnets
The subnets to use for the Auto Scaling group that is created for your node group.
string[] Subnets { get; }
Property Value
System.String[]
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 .
Tags
Metadata that assists with categorization and organization.
virtual IDictionary<string, string> Tags { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
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.
virtual object Taints { get; }
Property Value
System.Object
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 .
UpdateConfig
The node group update configuration.
virtual object UpdateConfig { get; }
Property Value
System.Object
Remarks
Version
The Kubernetes version to use for your managed nodes.
virtual string Version { get; }
Property Value
System.String
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 Version
.