Class: Aws::EKS::Types::Nodegroup

Inherits:

Struct

• Object
• Struct
• Aws::EKS::Types::Nodegroup

Includes:

Structure

Defined in:

lib/aws-sdk-eks/types.rb

Overview

An object representing an Amazon EKS managed node group.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ami_type ⇒ String

  If the node group was deployed using a launch template with a custom AMI, then this is ‘CUSTOM`.

• #capacity_type ⇒ String

  The capacity type of your managed node group.

• #cluster_name ⇒ String

  The name of your cluster.

• #created_at ⇒ Time

  The Unix epoch timestamp at object creation.

• #disk_size ⇒ Integer

  If the node group wasn’t deployed with a launch template, then this is the disk size in the node group configuration.

• #health ⇒ Types::NodegroupHealth

  The health status of the node group.

• #instance_types ⇒ Array<String>

  If the node group wasn’t deployed with a launch template, then this is the instance type that is associated with the node group.

• #labels ⇒ Hash<String,String>

  The Kubernetes ‘labels` applied to the nodes in the node group.

• #launch_template ⇒ Types::LaunchTemplateSpecification

  If a launch template was used to create the node group, then this is the launch template that was used.

• #modified_at ⇒ Time

  The Unix epoch timestamp for the last modification to the object.

• #node_role ⇒ String

  The IAM role associated with your node group.

• #nodegroup_arn ⇒ String

  The Amazon Resource Name (ARN) associated with the managed node group.

• #nodegroup_name ⇒ String

  The name associated with an Amazon EKS managed node group.

• #release_version ⇒ String

  If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template.

• #remote_access ⇒ Types::RemoteAccessConfig

  If the node group wasn’t deployed with a launch template, then this is the remote access configuration that is associated with the node group.

• #resources ⇒ Types::NodegroupResources

  The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

• #scaling_config ⇒ Types::NodegroupScalingConfig

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

• #status ⇒ String

  The current status of the managed node group.

• #subnets ⇒ Array<String>

  The subnets that were specified for the Auto Scaling group that is associated with your node group.

• #tags ⇒ Hash<String,String>

  Metadata that assists with categorization and organization.

• #taints ⇒ Array<Types::Taint>

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

• #update_config ⇒ Types::NodegroupUpdateConfig

  The node group update configuration.

• #version ⇒ String

  The Kubernetes version of the managed node group.

Instance Attribute Details

#ami_type ⇒ String

If the node group was deployed using a launch template with a custom AMI, then this is ‘CUSTOM`. For node groups that weren’t deployed using a launch template, this is the AMI type that was specified in the node group configuration.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_type ⇒ String

The capacity type of your managed node group.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

The name of your cluster.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The Unix epoch timestamp at object creation.

Returns:

• (Time)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#disk_size ⇒ Integer

If the node group wasn’t deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is ‘null`.

Returns:

• (Integer)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#health ⇒ Types::NodegroupHealth

The health status of the node group. If there are issues with your node group’s health, they are listed here.

Returns:

• (Types::NodegroupHealth)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#instance_types ⇒ Array<String>

If the node group wasn’t deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is ‘null`.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#labels ⇒ Hash<String,String>

The Kubernetes ‘labels` applied to the nodes in the node group.

<note markdown=“1”> Only ‘labels` that are applied with the Amazon EKS API are shown here. There may be other Kubernetes `labels` applied to the nodes in this group.

</note>

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#launch_template ⇒ Types::LaunchTemplateSpecification

If a launch template was used to create the node group, then this is the launch template that was used.

Returns:

• (Types::LaunchTemplateSpecification)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#modified_at ⇒ Time

The Unix epoch timestamp for the last modification to the object.

Returns:

• (Time)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#node_role ⇒ String

The IAM role associated with your node group. The Amazon EKS 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.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nodegroup_arn ⇒ String

The Amazon Resource Name (ARN) associated with the managed node group.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nodegroup_name ⇒ String

The name associated with an Amazon EKS managed node group.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#release_version ⇒ String

If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren’t deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#remote_access ⇒ Types::RemoteAccessConfig

If the node group wasn’t deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is ‘null`.

Returns:

• (Types::RemoteAccessConfig)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resources ⇒ Types::NodegroupResources

The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

Returns:

• (Types::NodegroupResources)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_config ⇒ Types::NodegroupScalingConfig

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

Returns:

• (Types::NodegroupScalingConfig)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the managed node group.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#subnets ⇒ Array<String>

The subnets that were specified for the Auto Scaling group that is associated with your node group.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#taints ⇒ Array<Types::Taint>

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`, or `No_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].

[1]: docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html

Returns:

• (Array<Types::Taint>)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#update_config ⇒ Types::NodegroupUpdateConfig

The node group update configuration.

Returns:

• (Types::NodegroupUpdateConfig)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The Kubernetes version of the managed node group.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 4703

class Nodegroup < Struct.new(
  :nodegroup_name,
  :nodegroup_arn,
  :cluster_name,
  :version,
  :release_version,
  :created_at,
  :modified_at,
  :status,
  :capacity_type,
  :scaling_config,
  :instance_types,
  :subnets,
  :remote_access,
  :ami_type,
  :node_role,
  :labels,
  :taints,
  :resources,
  :disk_size,
  :health,
  :update_config,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end