Cluster (AWS Java SDK :: Services

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

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

@Generated(value="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 and Description

static interface Cluster.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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()` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`Instant`	`createdAt()` The Unix epoch timestamp in seconds for when the cluster was created.
`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)`
`int`	`hashCode()`
`Logging`	`logging()` The logging configuration for your cluster.
`String`	`name()` The name of the cluster.
`String`	`platformVersion()` The platform version of your Amazon EKS cluster.
`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 AWS API operations on your behalf.
`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.
`Cluster.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`version()` The Kubernetes server version 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 String name()
```
    The name of the cluster.
    
    Returns:
    
    The name of the cluster.
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) of the cluster.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the cluster.
  - createdAt
```
public Instant createdAt()
```
    The Unix epoch timestamp in seconds for when the cluster was created.
    
    Returns:
    
    The Unix epoch timestamp in seconds for when the cluster was created.
  - version
```
public String version()
```
    The Kubernetes server version for the cluster.
    
    Returns:
    
    The Kubernetes server version for the cluster.
  - endpoint
```
public String endpoint()
```
    The endpoint for your Kubernetes API server.
    
    Returns:
    
    The endpoint for your Kubernetes API server.
  - roleArn
```
public String roleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS 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 AWS API operations on your behalf.
  - resourcesVpcConfig
```
public 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.
  - logging
```
public Logging logging()
```
    The logging configuration for your cluster.
    
    Returns:
    
    The logging configuration for your cluster.
  - status
```
public 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 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 Certificate certificateAuthority()
```
    The certificate-authority-data for your cluster.
    
    Returns:
    
    The certificate-authority-data for your cluster.
  - clientRequestToken
```
public String clientRequestToken()
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    
    Returns:
    
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - platformVersion
```
public String platformVersion()
```
    The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
    
    Returns:
    
    The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields 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

logging

status

statusAsString

certificateAuthority

clientRequestToken

platformVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields