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

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

Overview

An object representing an Amazon EKS managed node group.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ami_typeString

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)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_typeString

The capacity type of your managed node group.

Returns:

  • (String)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_nameString

The name of the cluster that the managed node group resides in.

Returns:

  • (String)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The Unix epoch timestamp in seconds for when the managed node group was created.

Returns:

  • (Time)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#disk_sizeInteger

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)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#healthTypes::NodegroupHealth

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


2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typesArray<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>)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#labelsHash<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>)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#launch_templateTypes::LaunchTemplateSpecification

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


2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#modified_atTime

The Unix epoch timestamp in seconds for when the managed node group was last modified.

Returns:

  • (Time)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#node_roleString

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

Returns:

  • (String)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nodegroup_arnString

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

Returns:

  • (String)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nodegroup_nameString

The name associated with an Amazon EKS managed node group.

Returns:

  • (String)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#release_versionString

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)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#remote_accessTypes::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`.


2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resourcesTypes::NodegroupResources

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


2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_configTypes::NodegroupScalingConfig

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


2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the managed node group.

Returns:

  • (String)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#subnetsArray<String>

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

Returns:

  • (Array<String>)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The metadata applied 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>)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#versionString

The Kubernetes version of the managed node group.

Returns:

  • (String)

2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
# File 'lib/aws-sdk-eks/types.rb', line 2741

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,
  :resources,
  :disk_size,
  :health,
  :launch_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end