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

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

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

An object representing an Amazon EKS cluster.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Cluster.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AccessConfigResponse`	`accessConfig()`	The access configuration for the cluster.
`String`	`arn()`	The Amazon Resource Name (ARN) of the cluster.
`static Cluster.Builder`	`builder()`
`Certificate`	`certificateAuthority()`	The `certificate-authority-data` for your cluster.
`String`	`clientRequestToken()`	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`ComputeConfigResponse`	`computeConfig()`	Indicates the current configuration of the compute capability on your EKS Auto Mode cluster.
`ConnectorConfigResponse`	`connectorConfig()`	The configuration used to connect to a cluster for registration.
`Instant`	`createdAt()`	The Unix epoch timestamp at object creation.
`List<EncryptionConfig>`	`encryptionConfig()`	The encryption configuration for the cluster.
`String`	`endpoint()`	The endpoint for your Kubernetes API server.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEncryptionConfig()`	For responses, this returns true if the service returned a value for the EncryptionConfig property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`ClusterHealth`	`health()`	An object representing the health of your Amazon EKS cluster.
`String`	`id()`	The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost.
`Identity`	`identity()`	The identity provider information for the cluster.
`KubernetesNetworkConfigResponse`	`kubernetesNetworkConfig()`	The Kubernetes network configuration for the cluster.
`Logging`	`logging()`	The logging configuration for your cluster.
`String`	`name()`	The name of your cluster.
`OutpostConfigResponse`	`outpostConfig()`	An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost.
`String`	`platformVersion()`	The platform version of your Amazon EKS cluster.
`RemoteNetworkConfigResponse`	`remoteNetworkConfig()`	The configuration in the cluster for EKS Hybrid Nodes.
`VpcConfigResponse`	`resourcesVpcConfig()`	The VPC configuration used by the cluster control plane.
`String`	`roleArn()`	The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Cluster.Builder>`	`serializableBuilderClass()`
`ClusterStatus`	`status()`	The current status of the cluster.
`String`	`statusAsString()`	The current status of the cluster.
`StorageConfigResponse`	`storageConfig()`	Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster.
`Map<String,String>`	`tags()`	Metadata that assists with categorization and organization.
`Cluster.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`UpgradePolicyResponse`	`upgradePolicy()`	This value indicates if extended support is enabled or disabled for the cluster.
`String`	`version()`	The Kubernetes server version for the cluster.
`ZonalShiftConfigResponse`	`zonalShiftConfig()`	The configuration for zonal shift for the cluster.

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
  - name
```
public final String name()
```
    The name of your cluster.
    
    Returns:
    
    The name of your cluster.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the cluster.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the cluster.
  - createdAt
```
public final Instant createdAt()
```
    The Unix epoch timestamp at object creation.
    
    Returns:
    
    The Unix epoch timestamp at object creation.
  - version
```
public final String version()
```
    The Kubernetes server version for the cluster.
    
    Returns:
    
    The Kubernetes server version for the cluster.
  - endpoint
```
public final String endpoint()
```
    The endpoint for your Kubernetes API server.
    
    Returns:
    
    The endpoint for your Kubernetes API server.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.
  - resourcesVpcConfig
```
public final VpcConfigResponse resourcesVpcConfig()
```
    The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC considerations and Cluster security group considerations in the Amazon EKS User Guide.
    
    Returns:
    
    The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC considerations and Cluster security group considerations in the Amazon EKS User Guide.
  - kubernetesNetworkConfig
```
public final KubernetesNetworkConfigResponse kubernetesNetworkConfig()
```
    The Kubernetes network configuration for the cluster.
    
    Returns:
    
    The Kubernetes network configuration for the cluster.
  - logging
```
public final Logging logging()
```
    The logging configuration for your cluster.
    
    Returns:
    
    The logging configuration for your cluster.
  - identity
```
public final Identity identity()
```
    The identity provider information for the cluster.
    
    Returns:
    
    The identity provider information for the cluster.
  - status
```
public final ClusterStatus status()
```
    The current status of the cluster.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ClusterStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the cluster.
    
    See Also:
    
    ClusterStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the cluster.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ClusterStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the cluster.
    
    See Also:
    
    ClusterStatus
  - certificateAuthority
```
public final Certificate certificateAuthority()
```
    The certificate-authority-data for your cluster.
    
    Returns:
    
    The certificate-authority-data for your cluster.
  - clientRequestToken
```
public final String clientRequestToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - platformVersion
```
public final String platformVersion()
```
    The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
    
    Returns:
    
    The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
  - 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()
```
    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.
    
    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:
    
    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.
  - hasEncryptionConfig
```
public final boolean hasEncryptionConfig()
```
    For responses, this returns true if the service returned a value for the EncryptionConfig 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.
  - encryptionConfig
```
public final List<EncryptionConfig> encryptionConfig()
```
    The encryption configuration for the cluster.
    
    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 hasEncryptionConfig() method.
    
    Returns:
    
    The encryption configuration for the cluster.
  - connectorConfig
```
public final ConnectorConfigResponse connectorConfig()
```
    The configuration used to connect to a cluster for registration.
    
    Returns:
    
    The configuration used to connect to a cluster for registration.
  - id
```
public final String id()
```
    The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
    
    Returns:
    
    The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
  - health
```
public final ClusterHealth health()
```
    An object representing the health of your Amazon EKS cluster.
    
    Returns:
    
    An object representing the health of your Amazon EKS cluster.
  - outpostConfig
```
public final OutpostConfigResponse outpostConfig()
```
    An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
    
    Returns:
    
    An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
  - accessConfig
```
public final AccessConfigResponse accessConfig()
```
    The access configuration for the cluster.
    
    Returns:
    
    The access configuration for the cluster.
  - upgradePolicy
```
public final UpgradePolicyResponse upgradePolicy()
```
    This value indicates if extended support is enabled or disabled for the cluster.
    
    Learn more about EKS Extended Support in the EKS User Guide.
    
    Returns:
    
    This value indicates if extended support is enabled or disabled for the cluster.
    
    Learn more about EKS Extended Support in the EKS User Guide.
  - zonalShiftConfig
```
public final ZonalShiftConfigResponse zonalShiftConfig()
```
    The configuration for zonal shift for the cluster.
    
    Returns:
    
    The configuration for zonal shift for the cluster.
  - remoteNetworkConfig
```
public final RemoteNetworkConfigResponse remoteNetworkConfig()
```
    The configuration in the cluster for EKS Hybrid Nodes. You can't change or update this configuration after the cluster is created.
    
    Returns:
    
    The configuration in the cluster for EKS Hybrid Nodes. You can't change or update this configuration after the cluster is created.
  - computeConfig
```
public final ComputeConfigResponse computeConfig()
```
    Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the EKS User Guide.
    
    Returns:
    
    Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the EKS User Guide.
  - storageConfig
```
public final StorageConfigResponse storageConfig()
```
    Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.
    
    Returns:
    
    Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.
  - toBuilder
```
public Cluster.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>
  - builder
```
public static Cluster.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Cluster.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Cluster

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

arn

createdAt

version

endpoint

roleArn

resourcesVpcConfig

kubernetesNetworkConfig

logging

identity

status

statusAsString

certificateAuthority

clientRequestToken

platformVersion

hasTags

tags

hasEncryptionConfig

encryptionConfig

connectorConfig

id

health

outpostConfig

accessConfig

upgradePolicy

zonalShiftConfig

remoteNetworkConfig

computeConfig

storageConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField