Cluster (AWS SDK for Java

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 you provide to ensure the idempotency of the request.
`Instant`	`createdAt()` The Unix epoch time stamp in seconds for when the cluster was created.
`String`	`endpoint()` The endpoint for your Kubernetes API server.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`name()` The name of the cluster.
`String`	`platformVersion()` The platform version of your Amazon EKS cluster.
`VpcConfigResponse`	`resourcesVpcConfig()` The VPC subnets and security groups 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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`version()` The Kubernetes server version for the cluster.

Methods inherited from class java.lang.Object
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 time stamp in seconds for when the cluster was created.
    
    Returns:
    
    The Unix epoch time stamp 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 subnets and security groups 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 subnets and security groups 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.
  - 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 you provide to ensure the idempotency of the request.
    
    Returns:
    
    Unique, case-sensitive identifier 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()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>
    
    Returns:
    
    a builder for type T
  - 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
  - toString
```
public String toString()
```
    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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

status

statusAsString

certificateAuthority

clientRequestToken

platformVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields