Class: Aws::EKS::Types::CreateNodegroupRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-eks/types.rb

Overview

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
  remote_access: {
    ec2_ssh_key: "String",
    source_security_groups: ["String"],
  },
  node_role: "String", # required
  labels: {
    "labelKey" => "labelValue",
  },
  tags: {
    "TagKey" => "TagValue",
  },
  client_request_token: "String",
  launch_template: {
    name: "String",
    version: "String",
    id: "String",
  },
  capacity_type: "ON_DEMAND", # accepts ON_DEMAND, SPOT
  version: "String",
  release_version: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ami_typeString

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] in the Amazon EKS User Guide.

[1]: docs.aws.amazon.com/eks/latest/userguide/launch-templates.html

Returns:

  • (String)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_typeString

The capacity type for your node group.

Returns:

  • (String)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_tokenString

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.

Returns:

  • (String)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_nameString

The name of the cluster to create the node group in.

Returns:

  • (String)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#disk_sizeInteger

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] in the Amazon EKS User Guide.

[1]: docs.aws.amazon.com/eks/latest/userguide/launch-templates.html

Returns:

  • (Integer)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typesArray<String>

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] in the *Amazon EKS User Guide*.

[1]: docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types [2]: docs.aws.amazon.com/eks/latest/userguide/launch-templates.html

Returns:

  • (Array<String>)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#labelsHash<String,String>

The Kubernetes labels to be applied to the nodes in the node group when they are created.

Returns:

  • (Hash<String,String>)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#launch_templateTypes::LaunchTemplateSpecification

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`.


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#node_roleString

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 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] in the Amazon EKS User Guide.

[1]: docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html [3]: docs.aws.amazon.com/eks/latest/userguide/launch-templates.html

Returns:

  • (String)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#nodegroup_nameString

The unique name to give your node group.

Returns:

  • (String)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#release_versionString

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] 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] in the Amazon EKS User Guide.

[1]: docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html [2]: docs.aws.amazon.com/eks/latest/userguide/launch-templates.html

Returns:

  • (String)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#remote_accessTypes::RemoteAccessConfig

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] in the Amazon EKS User Guide.

[1]: docs.aws.amazon.com/eks/latest/userguide/launch-templates.html


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_configTypes::NodegroupScalingConfig

The scaling configuration details for the Auto Scaling group that is created for your node group.


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#subnetsArray<String>

The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the tag key `kubernetes.io/cluster/CLUSTER_NAME` with a value of `shared`, where `CLUSTER_NAME` is replaced with the name of your cluster. 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]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html [2]: docs.aws.amazon.com/eks/latest/userguide/launch-templates.html

Returns:

  • (Array<String>)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

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.

Returns:

  • (Hash<String,String>)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end

#versionString

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] in the Amazon EKS User Guide.

[1]: docs.aws.amazon.com/eks/latest/userguide/launch-templates.html

Returns:

  • (String)

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/aws-sdk-eks/types.rb', line 1065

class CreateNodegroupRequest < Struct.new(
  :cluster_name,
  :nodegroup_name,
  :scaling_config,
  :disk_size,
  :subnets,
  :instance_types,
  :ami_type,
  :remote_access,
  :node_role,
  :labels,
  :tags,
  :client_request_token,
  :launch_template,
  :capacity_type,
  :version,
  :release_version)
  SENSITIVE = []
  include Aws::Structure
end