Interface CfnNodegroupProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnNodegroupProps.Jsii$Proxy
CfnNodegroup
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.eks.*; CfnNodegroupProps cfnNodegroupProps = CfnNodegroupProps.builder() .clusterName("clusterName") .nodeRole("nodeRole") .subnets(List.of("subnets")) // the properties below are optional .amiType("amiType") .capacityType("capacityType") .diskSize(123) .forceUpdateEnabled(false) .instanceTypes(List.of("instanceTypes")) .labels(Map.of( "labelsKey", "labels")) .launchTemplate(LaunchTemplateSpecificationProperty.builder() .id("id") .name("name") .version("version") .build()) .nodegroupName("nodegroupName") .releaseVersion("releaseVersion") .remoteAccess(RemoteAccessProperty.builder() .ec2SshKey("ec2SshKey") // the properties below are optional .sourceSecurityGroups(List.of("sourceSecurityGroups")) .build()) .scalingConfig(ScalingConfigProperty.builder() .desiredSize(123) .maxSize(123) .minSize(123) .build()) .tags(Map.of( "tagsKey", "tags")) .taints(List.of(TaintProperty.builder() .effect("effect") .key("key") .value("value") .build())) .updateConfig(UpdateConfigProperty.builder() .maxUnavailable(123) .maxUnavailablePercentage(123) .build()) .version("version") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnNodegroupProps
static final class
An implementation forCfnNodegroupProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnNodegroupProps.Builder
builder()
default String
The AMI type for your node group.default String
The capacity type of your managed node group.The name of your cluster.default Number
The root device disk size (in GiB) for your node group instances.default Object
Force the update if anyPod
on the existing node group can't be drained due to aPod
disruption budget issue.Specify the instance types for a node group.default Object
The Kuberneteslabels
applied to the nodes in the node group.default Object
An object representing a node group's launch template specification.default String
The unique name to give your node group.The Amazon Resource Name (ARN) of the IAM role to associate with your node group.default String
The AMI version of the Amazon EKS optimized AMI to use with your node group (for example,1.14.7- *YYYYMMDD*
).default Object
The remote access configuration to use with your node group.default Object
The scaling configuration details for the Auto Scaling group that is created for your node group.The subnets to use for the Auto Scaling group that is created for your node group.getTags()
Metadata that assists with categorization and organization.default Object
The Kubernetes taints to be applied to the nodes in the node group when they are created.default Object
The node group update configuration.default String
The Kubernetes version to use for your managed nodes.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getClusterName
The name of your cluster.- See Also:
-
getNodeRole
The Amazon Resource Name (ARN) of the IAM role to associate with your node group.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 specifylaunchTemplate
, then don't specify[IamInstanceProfile](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html)
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 .- See Also:
-
getSubnets
The subnets to use for the Auto Scaling group that is created for your node group.If you specify
launchTemplate
, then don't specify[SubnetId](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html)
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 .- See Also:
-
getAmiType
The AMI type for your node group.If you specify
launchTemplate
, and your launch template uses a custom AMI, then don't specifyamiType
, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then addeks:kube-proxy-windows
to your Windows nodesrolearn
in theaws-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 .- See Also:
-
getCapacityType
The capacity type of your managed node group.- See Also:
-
getDiskSize
The root device disk size (in GiB) for your node group instances.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 specifydiskSize
, 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 .- See Also:
-
getForceUpdateEnabled
Force the update if anyPod
on the existing node group can't be drained due to aPod
disruption budget issue.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
- See Also:
-
getInstanceTypes
Specify the instance types for a node group.If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the
amiType
parameter. If you specifylaunchTemplate
, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types forinstanceTypes
. If however, you specify an instance type in your launch template and specify anyinstanceTypes
, the node group deployment will fail. If you don't specify an instance type in a launch template or forinstanceTypes
, thent3.medium
is used, by default. If you specifySpot
forcapacityType
, then we recommend specifying multiple values forinstanceTypes
. For more information, see Managed node group capacity types and Customizing managed nodes with launch templates in the Amazon EKS User Guide .- See Also:
-
getLabels
The Kuberneteslabels
applied to the nodes in the node group.Only
labels
that are applied with the Amazon EKS API are shown here. There may be other Kuberneteslabels
applied to the nodes in this group.- See Also:
-
getLaunchTemplate
An object representing a node group's launch template specification.When using this object, don't directly specify
instanceTypes
,diskSize
, orremoteAccess
. Make sure that the launch template meets the requirements inlaunchTemplateSpecification
. Also refer to Customizing managed nodes with launch templates in the Amazon EKS User Guide .- See Also:
-
getNodegroupName
The unique name to give your node group.- See Also:
-
getReleaseVersion
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 .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
.- See Also:
-
getRemoteAccess
The remote access configuration to use with your node group.For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify
launchTemplate
, then don't specifyremoteAccess
, 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 .- See Also:
-
getScalingConfig
The scaling configuration details for the Auto Scaling group that is created for your node group.- See Also:
-
getTags
Metadata that assists with categorization and organization.Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources.
- See Also:
-
getTaints
The Kubernetes taints to be applied to the nodes in the node group when they are created.Effect is one of
No_Schedule
,Prefer_No_Schedule
, orNo_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 .- See Also:
-
getUpdateConfig
The node group update configuration.- See Also:
-
getVersion
The Kubernetes version to use for your managed nodes.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 specifyversion
, 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
.- See Also:
-
builder
- Returns:
- a
CfnNodegroupProps.Builder
ofCfnNodegroupProps
-