Nodegroup (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.eks.model.Nodegroup

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Nodegroup.Builder,Nodegroup>

@Generated(value="software.amazon.awssdk:codegen")
public final class Nodegroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Nodegroup.Builder,Nodegroup>

An object representing an Amazon EKS managed node group.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Nodegroup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Nodegroup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AMITypes`	`amiType()` If the node group was deployed using a launch template with a custom AMI, then this is `CUSTOM`.
`String`	`amiTypeAsString()` If the node group was deployed using a launch template with a custom AMI, then this is `CUSTOM`.
`static Nodegroup.Builder`	`builder()`
`CapacityTypes`	`capacityType()` The capacity type of your managed node group.
`String`	`capacityTypeAsString()` The capacity type of your managed node group.
`String`	`clusterName()` The name of the cluster that the managed node group resides in.
`Instant`	`createdAt()` The Unix epoch timestamp in seconds for when the managed node group was created.
`Integer`	`diskSize()` If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasInstanceTypes()` For responses, this returns true if the service returned a value for the InstanceTypes property.
`boolean`	`hasLabels()` For responses, this returns true if the service returned a value for the Labels property.
`boolean`	`hasSubnets()` For responses, this returns true if the service returned a value for the Subnets property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasTaints()` For responses, this returns true if the service returned a value for the Taints property.
`NodegroupHealth`	`health()` The health status of the node group.
`List<String>`	`instanceTypes()` If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group.
`Map<String,String>`	`labels()` The Kubernetes labels applied to the nodes in the node group.
`LaunchTemplateSpecification`	`launchTemplate()` If a launch template was used to create the node group, then this is the launch template that was used.
`Instant`	`modifiedAt()` The Unix epoch timestamp in seconds for when the managed node group was last modified.
`String`	`nodegroupArn()` The Amazon Resource Name (ARN) associated with the managed node group.
`String`	`nodegroupName()` The name associated with an Amazon EKS managed node group.
`String`	`nodeRole()` The IAM role associated with your node group.
`String`	`releaseVersion()` 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.
`RemoteAccessConfig`	`remoteAccess()` 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.
`NodegroupResources`	`resources()` The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
`NodegroupScalingConfig`	`scalingConfig()` The scaling configuration details for the Auto Scaling group that is associated with your node group.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Nodegroup.Builder>`	`serializableBuilderClass()`
`NodegroupStatus`	`status()` The current status of the managed node group.
`String`	`statusAsString()` The current status of the managed node group.
`List<String>`	`subnets()` The subnets that were specified for the Auto Scaling group that is associated with your node group.
`Map<String,String>`	`tags()` The metadata applied to the node group to assist with categorization and organization.
`List<Taint>`	`taints()` The Kubernetes taints to be applied to the nodes in the node group when they are created.
`Nodegroup.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`NodegroupUpdateConfig`	`updateConfig()` The node group update configuration.
`String`	`version()` The Kubernetes version of the managed node group.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - nodegroupName
```
public final String nodegroupName()
```
    The name associated with an Amazon EKS managed node group.
    
    Returns:
    
    The name associated with an Amazon EKS managed node group.
  - nodegroupArn
```
public final String nodegroupArn()
```
    The Amazon Resource Name (ARN) associated with the managed node group.
    
    Returns:
    
    The Amazon Resource Name (ARN) associated with the managed node group.
  - clusterName
```
public final String clusterName()
```
    The name of the cluster that the managed node group resides in.
    
    Returns:
    
    The name of the cluster that the managed node group resides in.
  - version
```
public final String version()
```
    The Kubernetes version of the managed node group.
    
    Returns:
    
    The Kubernetes version of the managed node group.
  - releaseVersion
```
public final String releaseVersion()
```
    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:
    
    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.
  - createdAt
```
public final Instant createdAt()
```
    The Unix epoch timestamp in seconds for when the managed node group was created.
    
    Returns:
    
    The Unix epoch timestamp in seconds for when the managed node group was created.
  - modifiedAt
```
public final Instant modifiedAt()
```
    The Unix epoch timestamp in seconds for when the managed node group was last modified.
    
    Returns:
    
    The Unix epoch timestamp in seconds for when the managed node group was last modified.
  - status
```
public final NodegroupStatus status()
```
    The current status of the managed node group.
    
    If the service returns an enum value that is not available in the current SDK version, status will return NodegroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the managed node group.
    
    See Also:
    
    NodegroupStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the managed node group.
    
    If the service returns an enum value that is not available in the current SDK version, status will return NodegroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the managed node group.
    
    See Also:
    
    NodegroupStatus
  - capacityType
```
public final CapacityTypes capacityType()
```
    The capacity type of your managed node group.
    
    If the service returns an enum value that is not available in the current SDK version, capacityType will return CapacityTypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from capacityTypeAsString().
    
    Returns:
    
    The capacity type of your managed node group.
    
    See Also:
    
    CapacityTypes
  - capacityTypeAsString
```
public final String capacityTypeAsString()
```
    The capacity type of your managed node group.
    
    If the service returns an enum value that is not available in the current SDK version, capacityType will return CapacityTypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from capacityTypeAsString().
    
    Returns:
    
    The capacity type of your managed node group.
    
    See Also:
    
    CapacityTypes
  - scalingConfig
```
public final NodegroupScalingConfig scalingConfig()
```
    The scaling configuration details for the Auto Scaling group that is associated with your node group.
    
    Returns:
    
    The scaling configuration details for the Auto Scaling group that is associated with your node group.
  - hasInstanceTypes
```
public final boolean hasInstanceTypes()
```
    For responses, this returns true if the service returned a value for the InstanceTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - instanceTypes
```
public final List<String> instanceTypes()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceTypes() method.
    
    Returns:
    
    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.
  - hasSubnets
```
public final boolean hasSubnets()
```
    For responses, this returns true if the service returned a value for the Subnets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - subnets
```
public final List<String> subnets()
```
    The subnets that were specified for the Auto Scaling group that is associated with your node group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnets() method.
    
    Returns:
    
    The subnets that were specified for the Auto Scaling group that is associated with your node group.
  - remoteAccess
```
public final RemoteAccessConfig remoteAccess()
```
    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:
    
    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.
  - amiType
```
public final AMITypes amiType()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, amiType will return AMITypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from amiTypeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    AMITypes
  - amiTypeAsString
```
public final String amiTypeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, amiType will return AMITypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from amiTypeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    AMITypes
  - nodeRole
```
public final String nodeRole()
```
    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:
    
    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.
  - hasLabels
```
public final boolean hasLabels()
```
    For responses, this returns true if the service returned a value for the Labels property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - labels
```
public final Map<String,String> labels()
```
    The Kubernetes labels applied to the nodes in the node group.
    
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLabels() method.
    
    Returns:
    
    The Kubernetes labels applied to the nodes in the node group.
    
    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.
  - hasTaints
```
public final boolean hasTaints()
```
    For responses, this returns true if the service returned a value for the Taints property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - taints
```
public final List<Taint> taints()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTaints() method.
    
    Returns:
    
    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.
  - resources
```
public final NodegroupResources resources()
```
    The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
    
    Returns:
    
    The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
  - diskSize
```
public final Integer diskSize()
```
    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:
    
    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.
  - health
```
public final NodegroupHealth health()
```
    The health status of the node group. If there are issues with your node group's health, they are listed here.
    
    Returns:
    
    The health status of the node group. If there are issues with your node group's health, they are listed here.
  - updateConfig
```
public final NodegroupUpdateConfig updateConfig()
```
    The node group update configuration.
    
    Returns:
    
    The node group update configuration.
  - launchTemplate
```
public final LaunchTemplateSpecification launchTemplate()
```
    If a launch template was used to create the node group, then this is the launch template that was used.
    
    Returns:
    
    If a launch template was used to create the node group, then this is the launch template that was used.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    The metadata applied 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The metadata applied 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.
  - toBuilder
```
public Nodegroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Nodegroup.Builder,Nodegroup>
  - builder
```
public static Nodegroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Nodegroup.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Nodegroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

nodegroupName

nodegroupArn

clusterName

version

releaseVersion

createdAt

modifiedAt

status

statusAsString

capacityType

capacityTypeAsString

scalingConfig

hasInstanceTypes

instanceTypes

hasSubnets

subnets

remoteAccess

amiType

amiTypeAsString

nodeRole

hasLabels

labels

hasTaints

taints

resources

diskSize

health

updateConfig

launchTemplate

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields