Class CfnNodegroup
A CloudFormation AWS::EKS::Nodegroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.EKS.Legacy
Assembly: Amazon.CDK.AWS.EKS.Legacy.dll
Syntax (csharp)
public class CfnNodegroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnNodegroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 more information about using launch templates, see Launch template support .
An Amazon EKS managed node group is an 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 Regions that support Windows Amazon EKS.
CloudformationResource: AWS::EKS::Nodegroup
Link: 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.Legacy;
var cfnNodegroup = new CfnNodegroup(this, "MyCfnNodegroup", 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
Constructors
CfnNodegroup(Construct, String, ICfnNodegroupProps) | Create a new |
CfnNodegroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnNodegroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AmiType | The AMI type for your node group. |
AttrArn | The Amazon Resource Name (ARN) associated with the managed node group. |
AttrClusterName | The name of the cluster that the managed node group resides in. |
AttrId | |
AttrNodegroupName | The name associated with an Amazon EKS managed node group. |
CapacityType | The capacity type of your managed node group. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClusterName | The name of the cluster to create the node group in. |
DiskSize | The root device disk size (in GiB) for your node group instances. |
ForceUpdateEnabled | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. |
InstanceTypes | Specify the instance types for a node group. |
Labels | The Kubernetes labels applied to the nodes in the node group. |
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 | The metadata applied to the node group to assist 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnNodegroup(Construct, String, ICfnNodegroupProps)
Create a new AWS::EKS::Nodegroup
.
public CfnNodegroup(Construct scope, string id, ICfnNodegroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnNodegroupProps
- resource properties.
CfnNodegroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnNodegroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnNodegroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnNodegroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AmiType
The AMI type for your node group.
public virtual string AmiType { get; set; }
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 Launch template support in the Amazon EKS User Guide .
AttrArn
The Amazon Resource Name (ARN) associated with the managed node group.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrClusterName
The name of the cluster that the managed node group resides in.
public virtual string AttrClusterName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ClusterName
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrNodegroupName
The name associated with an Amazon EKS managed node group.
public virtual string AttrNodegroupName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: NodegroupName
CapacityType
The capacity type of your managed node group.
public virtual string CapacityType { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClusterName
The name of the cluster to create the node group in.
public virtual string ClusterName { get; set; }
Property Value
System.String
Remarks
DiskSize
The root device disk size (in GiB) for your node group instances.
public virtual Nullable<double> DiskSize { get; set; }
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 Launch template support in the Amazon EKS User Guide .
ForceUpdateEnabled
Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
public virtual object ForceUpdateEnabled { get; set; }
Property Value
System.Object
Remarks
If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.
InstanceTypes
Specify the instance types for a node group.
public virtual string[] InstanceTypes { get; set; }
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 Launch template support in the Amazon EKS User Guide .
Labels
The Kubernetes labels applied to the nodes in the node group.
public virtual object Labels { get; set; }
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.
public virtual object LaunchTemplate { get; set; }
Property Value
System.Object
Remarks
If specified, then do not specify instanceTypes
, diskSize
, or remoteAccess
and make sure that the launch template meets the requirements in launchTemplateSpecification
.
NodegroupName
The unique name to give your node group.
public virtual string NodegroupName { get; set; }
Property Value
System.String
Remarks
NodeRole
The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
public virtual string NodeRole { get; set; }
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 Launch template support 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 .
public virtual string ReleaseVersion { get; set; }
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.
public virtual object RemoteAccess { get; set; }
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 Launch template support in the Amazon EKS User Guide .
ScalingConfig
The scaling configuration details for the Auto Scaling group that is created for your node group.
public virtual object ScalingConfig { get; set; }
Property Value
System.Object
Remarks
Subnets
The subnets to use for the Auto Scaling group that is created for your node group.
public virtual string[] Subnets { get; set; }
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 Launch template support in the Amazon EKS User Guide .
Tags
The metadata applied to the node group to assist with categorization and organization.
public virtual TagManager Tags { get; }
Property Value
Remarks
Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
Taints
The Kubernetes taints to be applied to the nodes in the node group when they are created.
public virtual object Taints { get; set; }
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.
public virtual object UpdateConfig { get; set; }
Property Value
System.Object
Remarks
Version
The Kubernetes version to use for your managed nodes.
public virtual string Version { get; set; }
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
.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>