/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::EKS::CreateNodegroup

NAME

Paws::EKS::CreateNodegroup - Arguments for method CreateNodegroup on Paws::EKS

DESCRIPTION

This class represents the parameters used for calling the method CreateNodegroup on the Amazon Elastic Kubernetes Service service. Use the attributes of this class as arguments to method CreateNodegroup.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateNodegroup.

SYNOPSIS

my $eks = Paws->service('EKS');
my $CreateNodegroupResponse = $eks->CreateNodegroup(
  ClusterName        => 'MyString',
  NodeRole           => 'MyString',
  NodegroupName      => 'MyString',
  Subnets            => [ 'MyString', ... ],
  AmiType            => 'AL2_x86_64',           # OPTIONAL
  CapacityType       => 'ON_DEMAND',            # OPTIONAL
  ClientRequestToken => 'MyString',             # OPTIONAL
  DiskSize           => 1,                      # OPTIONAL
  InstanceTypes      => [ 'MyString', ... ],    # OPTIONAL
  Labels             => {
    'MylabelKey' =>
      'MylabelValue',    # key: min: 1, max: 63, value: min: 1, max: 63
  },    # OPTIONAL
  LaunchTemplate => {
    Id      => 'MyString',
    Name    => 'MyString',
    Version => 'MyString',
  },    # OPTIONAL
  ReleaseVersion => 'MyString',    # OPTIONAL
  RemoteAccess   => {
    Ec2SshKey            => 'MyString',
    SourceSecurityGroups => [ 'MyString', ... ],
  },                               # OPTIONAL
  ScalingConfig => {
    DesiredSize => 1,              # OPTIONAL
    MaxSize     => 1,              # min: 1; OPTIONAL
    MinSize     => 1,              # OPTIONAL
  },    # OPTIONAL
  Tags => {
    'MyTagKey' => 'MyTagValue',    # key: min: 1, max: 128, value: max: 256
  },    # OPTIONAL
  Taints => [
    {
      Effect => 'NO_SCHEDULE'
      ,    # values: NO_SCHEDULE, NO_EXECUTE, PREFER_NO_SCHEDULE; OPTIONAL
      Key   => 'MytaintKey',      # min: 1, max: 63; OPTIONAL
      Value => 'MytaintValue',    # max: 63; OPTIONAL
    },
    ...
  ],    # OPTIONAL
  UpdateConfig => {
    MaxUnavailable           => 1,    # min: 1; OPTIONAL
    MaxUnavailablePercentage => 1,    # min: 1, max: 100; OPTIONAL
  },    # OPTIONAL
  Version => 'MyString',    # OPTIONAL
);

# Results:
my $Nodegroup = $CreateNodegroupResponse->Nodegroup;

# Returns a L<Paws::EKS::CreateNodegroupResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/eks/CreateNodegroup

ATTRIBUTES

AmiType => Str

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 (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the Amazon EKS User Guide.

Valid values are: "AL2_x86_64", "AL2_x86_64_GPU", "AL2_ARM_64", "CUSTOM"

CapacityType => Str

The capacity type for your node group.

Valid values are: "ON_DEMAND", "SPOT"

ClientRequestToken => Str

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

REQUIRED ClusterName => Str

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

DiskSize => Int

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 (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the Amazon EKS User Guide.

InstanceTypes => ArrayRef[Str|Undef]

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 (https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types) and Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the Amazon EKS User Guide.

Labels => Paws::EKS::LabelsMap

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

LaunchTemplate => Paws::EKS::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.

REQUIRED NodegroupName => Str

The unique name to give your node group.

REQUIRED NodeRole => Str

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 (https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html) in the Amazon EKS User Guide . If you specify launchTemplate, 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 Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the Amazon EKS User Guide.

ReleaseVersion => Str

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 (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) 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 (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the Amazon EKS User Guide.

RemoteAccess => Paws::EKS::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 (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the Amazon EKS User Guide.

ScalingConfig => Paws::EKS::NodegroupScalingConfig

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

REQUIRED Subnets => ArrayRef[Str|Undef]

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 Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the Amazon EKS User Guide.

Tags => Paws::EKS::TagMap

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.

Taints => ArrayRef[Paws::EKS::Taint]

The Kubernetes taints to be applied to the nodes in the node group.

UpdateConfig => Paws::EKS::NodegroupUpdateConfig

Version => Str

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 (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the Amazon EKS User Guide.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateNodegroup in Paws::EKS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues