amazonka-eks-2.0: Amazon Elastic Kubernetes Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EKS.CreateNodegroup

Description

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 Amazon Web Services 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.

Synopsis

Creating a Request

data CreateNodegroup Source #

See: newCreateNodegroup smart constructor.

Constructors

CreateNodegroup' 

Fields

  • amiType :: Maybe AMITypes

    The AMI type for your node group. 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.

  • capacityType :: Maybe CapacityTypes

    The capacity type for your node group.

  • clientRequestToken :: Maybe Text

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  • diskSize :: Maybe Int

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

  • instanceTypes :: Maybe [Text]

    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 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 :: Maybe (HashMap Text Text)

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

  • launchTemplate :: Maybe 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.

  • releaseVersion :: Maybe Text

    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 information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows 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.

  • remoteAccess :: Maybe RemoteAccessConfig

    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 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 :: Maybe NodegroupScalingConfig

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

  • tags :: Maybe (HashMap Text Text)

    The metadata to apply to the node group to assist with categorization and organization. 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 :: Maybe [Taint]

    The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

  • updateConfig :: Maybe NodegroupUpdateConfig

    The node group update configuration.

  • version :: Maybe Text

    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.

  • clusterName :: Text

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

  • nodegroupName :: Text

    The unique name to give your node group.

  • subnets :: [Text]

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

  • nodeRole :: Text

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

Instances

Instances details
ToJSON CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

ToHeaders CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

ToPath CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

ToQuery CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

AWSRequest CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

Associated Types

type AWSResponse CreateNodegroup #

Generic CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

Associated Types

type Rep CreateNodegroup :: Type -> Type #

Read CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

Show CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

NFData CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

Methods

rnf :: CreateNodegroup -> () #

Eq CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

Hashable CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

type AWSResponse CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

type Rep CreateNodegroup Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

type Rep CreateNodegroup = D1 ('MetaData "CreateNodegroup" "Amazonka.EKS.CreateNodegroup" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "CreateNodegroup'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "amiType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AMITypes)) :*: S1 ('MetaSel ('Just "capacityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacityTypes))) :*: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "diskSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "instanceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "labels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "launchTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchTemplateSpecification)) :*: (S1 ('MetaSel ('Just "releaseVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "remoteAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RemoteAccessConfig)))))) :*: (((S1 ('MetaSel ('Just "scalingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodegroupScalingConfig)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "taints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Taint])) :*: S1 ('MetaSel ('Just "updateConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodegroupUpdateConfig)))) :*: ((S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "nodegroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "nodeRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCreateNodegroup Source #

Create a value of CreateNodegroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateNodegroup, createNodegroup_amiType - The AMI type for your node group. 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.

CreateNodegroup, createNodegroup_capacityType - The capacity type for your node group.

CreateNodegroup, createNodegroup_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

CreateNodegroup, createNodegroup_diskSize - 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 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.

CreateNodegroup, createNodegroup_instanceTypes - 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 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.

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

CreateNodegroup, createNodegroup_launchTemplate - 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.

CreateNodegroup, createNodegroup_releaseVersion - 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 information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows 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.

CreateNodegroup, createNodegroup_remoteAccess - 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 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.

CreateNodegroup, createNodegroup_scalingConfig - The scaling configuration details for the Auto Scaling group that is created for your node group.

CreateNodegroup, createNodegroup_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. 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.

CreateNodegroup, createNodegroup_taints - The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

CreateNodegroup, createNodegroup_updateConfig - The node group update configuration.

CreateNodegroup, createNodegroup_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 in the Amazon EKS User Guide.

CreateNodegroup, createNodegroup_clusterName - The name of the cluster to create the node group in.

CreateNodegroup, createNodegroup_nodegroupName - The unique name to give your node group.

CreateNodegroup, createNodegroup_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 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.

CreateNodegroup, createNodegroup_nodeRole - 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 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.

Request Lenses

createNodegroup_amiType :: Lens' CreateNodegroup (Maybe AMITypes) Source #

The AMI type for your node group. 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.

createNodegroup_capacityType :: Lens' CreateNodegroup (Maybe CapacityTypes) Source #

The capacity type for your node group.

createNodegroup_clientRequestToken :: Lens' CreateNodegroup (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createNodegroup_diskSize :: Lens' CreateNodegroup (Maybe Int) Source #

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

createNodegroup_instanceTypes :: Lens' CreateNodegroup (Maybe [Text]) Source #

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

createNodegroup_labels :: Lens' CreateNodegroup (Maybe (HashMap Text Text)) Source #

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

createNodegroup_launchTemplate :: Lens' CreateNodegroup (Maybe LaunchTemplateSpecification) Source #

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.

createNodegroup_releaseVersion :: Lens' CreateNodegroup (Maybe Text) Source #

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 information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows 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.

createNodegroup_remoteAccess :: Lens' CreateNodegroup (Maybe RemoteAccessConfig) Source #

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

createNodegroup_scalingConfig :: Lens' CreateNodegroup (Maybe NodegroupScalingConfig) Source #

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

createNodegroup_tags :: Lens' CreateNodegroup (Maybe (HashMap Text Text)) Source #

The metadata to apply to the node group to assist with categorization and organization. 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.

createNodegroup_taints :: Lens' CreateNodegroup (Maybe [Taint]) Source #

The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

createNodegroup_version :: Lens' CreateNodegroup (Maybe Text) Source #

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.

createNodegroup_clusterName :: Lens' CreateNodegroup Text Source #

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

createNodegroup_nodegroupName :: Lens' CreateNodegroup Text Source #

The unique name to give your node group.

createNodegroup_subnets :: Lens' CreateNodegroup [Text] Source #

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

createNodegroup_nodeRole :: Lens' CreateNodegroup Text Source #

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

Destructuring the Response

data CreateNodegroupResponse Source #

See: newCreateNodegroupResponse smart constructor.

Constructors

CreateNodegroupResponse' 

Fields

Instances

Instances details
Generic CreateNodegroupResponse Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

Associated Types

type Rep CreateNodegroupResponse :: Type -> Type #

Read CreateNodegroupResponse Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

Show CreateNodegroupResponse Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

NFData CreateNodegroupResponse Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

Methods

rnf :: CreateNodegroupResponse -> () #

Eq CreateNodegroupResponse Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

type Rep CreateNodegroupResponse Source # 
Instance details

Defined in Amazonka.EKS.CreateNodegroup

type Rep CreateNodegroupResponse = D1 ('MetaData "CreateNodegroupResponse" "Amazonka.EKS.CreateNodegroup" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "CreateNodegroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nodegroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Nodegroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateNodegroupResponse Source #

Create a value of CreateNodegroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nodegroup:CreateNodegroupResponse', createNodegroupResponse_nodegroup - The full description of your new node group.

$sel:httpStatus:CreateNodegroupResponse', createNodegroupResponse_httpStatus - The response's http status code.

Response Lenses

createNodegroupResponse_nodegroup :: Lens' CreateNodegroupResponse (Maybe Nodegroup) Source #

The full description of your new node group.