class Aws::EKS::Types::CreateNodegroupRequest
@note When making an API call, you may pass CreateNodegroupRequest
data as a hash: { cluster_name: "String", # required nodegroup_name: "String", # required scaling_config: { min_size: 1, max_size: 1, desired_size: 1, }, disk_size: 1, subnets: ["String"], # required instance_types: ["String"], ami_type: "AL2_x86_64", # accepts AL2_x86_64, AL2_x86_64_GPU, AL2_ARM_64, CUSTOM remote_access: { ec2_ssh_key: "String", source_security_groups: ["String"], }, node_role: "String", # required labels: { "labelKey" => "labelValue", }, taints: [ { key: "taintKey", value: "taintValue", effect: "NO_SCHEDULE", # accepts NO_SCHEDULE, NO_EXECUTE, PREFER_NO_SCHEDULE }, ], tags: { "TagKey" => "TagValue", }, client_request_token: "String", launch_template: { name: "String", version: "String", id: "String", }, update_config: { max_unavailable: 1, max_unavailable_percentage: 1, }, capacity_type: "ON_DEMAND", # accepts ON_DEMAND, SPOT version: "String", release_version: "String", }
@!attribute [rw] cluster_name
The name of the cluster to create the node group in. @return [String]
@!attribute [rw] nodegroup_name
The unique name to give your node group. @return [String]
@!attribute [rw] scaling_config
The scaling configuration details for the Auto Scaling group that is created for your node group. @return [Types::NodegroupScalingConfig]
@!attribute [rw] disk_size
The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB. 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][1] in the Amazon EKS User Guide. [1]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html @return [Integer]
@!attribute [rw] subnets
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` ][1] 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][2] in the Amazon EKS User Guide. [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html [2]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html @return [Array<String>]
@!attribute [rw] instance_types
Specify the instance types for a node group. If you specify a GPU instance type, be sure to specify `AL2_x86_64_GPU` 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][1] and [Launch template support][2] in the *Amazon EKS User Guide*. [1]: https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types [2]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html @return [Array<String>]
@!attribute [rw] ami_type
The AMI type for your node group. GPU instance types should use the `AL2_x86_64_GPU` AMI type. Non-GPU instances should use the `AL2_x86_64` AMI type. Arm instances should use the `AL2_ARM_64` AMI type. All types use the Amazon EKS optimized Amazon Linux 2 AMI. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `amiType`, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see [Launch template support][1] in the Amazon EKS User Guide. [1]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html @return [String]
@!attribute [rw] remote_access
The remote access (SSH) configuration to use with your node group. 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][1] in the Amazon EKS User Guide. [1]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html @return [Types::RemoteAccessConfig]
@!attribute [rw] node_role
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 Amazon Web Services 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][1] in the <i> <i>Amazon EKS User Guide</i> </i>. If you specify `launchTemplate`, then don't specify [ `IamInstanceProfile` ][2] 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][3] in the Amazon EKS User Guide. [1]: https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html [3]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html @return [String]
@!attribute [rw] labels
The Kubernetes labels to be applied to the nodes in the node group when they are created. @return [Hash<String,String>]
@!attribute [rw] taints
The Kubernetes taints to be applied to the nodes in the node group. @return [Array<Types::Taint>]
@!attribute [rw] tags
The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets. @return [Hash<String,String>]
@!attribute [rw] client_request_token
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. **A suitable default value is auto-generated.** You should normally not need to pass this option. @return [String]
@!attribute [rw] launch_template
An object representing a node group's launch template specification. If specified, then do not specify `instanceTypes`, `diskSize`, or `remoteAccess` and make sure that the launch template meets the requirements in `launchTemplateSpecification`. @return [Types::LaunchTemplateSpecification]
@!attribute [rw] update_config
The node group update configuration. @return [Types::NodegroupUpdateConfig]
@!attribute [rw] capacity_type
The capacity type for your node group. @return [String]
@!attribute [rw] version
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 specify `version`, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see [Launch template support][1] in the Amazon EKS User Guide. [1]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html @return [String]
@!attribute [rw] release_version
The AMI version of the Amazon EKS optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current Kubernetes version is used. For more information, see [Amazon EKS optimized Amazon Linux 2 AMI versions][1] in the *Amazon EKS User Guide*. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `releaseVersion`, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see [Launch template support][2] in the Amazon EKS User Guide. [1]: https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html [2]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html @return [String]
@see docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/CreateNodegroupRequest AWS API Documentation
Constants
- SENSITIVE