Cluster (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.eks.model.Cluster

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Cluster
extends Object
implements Serializable, Cloneable, StructuredPojo

An object representing an Amazon EKS cluster.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Cluster()

Constructors
Constructor and Description
`Cluster()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Cluster`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Cluster`	`clearTagsEntries()` Removes all the entries added into Tags.
`Cluster`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the cluster.
`Certificate`	`getCertificateAuthority()` The `certificate-authority-data` for your cluster.
`String`	`getClientRequestToken()` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`ConnectorConfigResponse`	`getConnectorConfig()` The configuration used to connect to a cluster for registration.
`Date`	`getCreatedAt()` The Unix epoch timestamp in seconds for when the cluster was created.
`List<EncryptionConfig>`	`getEncryptionConfig()` The encryption configuration for the cluster.
`String`	`getEndpoint()` The endpoint for your Kubernetes API server.
`Identity`	`getIdentity()` The identity provider information for the cluster.
`KubernetesNetworkConfigResponse`	`getKubernetesNetworkConfig()` The Kubernetes network configuration for the cluster.
`Logging`	`getLogging()` The logging configuration for your cluster.
`String`	`getName()` The name of the cluster.
`String`	`getPlatformVersion()` The platform version of your Amazon EKS cluster.
`VpcConfigResponse`	`getResourcesVpcConfig()` The VPC configuration used by the cluster control plane.
`String`	`getRoleArn()` 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.
`String`	`getStatus()` The current status of the cluster.
`Map<String,String>`	`getTags()` The metadata that you apply to the cluster to assist with categorization and organization.
`String`	`getVersion()` The Kubernetes server version for the cluster.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the cluster.
`void`	`setCertificateAuthority(Certificate certificateAuthority)` The `certificate-authority-data` for your cluster.
`void`	`setClientRequestToken(String clientRequestToken)` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setConnectorConfig(ConnectorConfigResponse connectorConfig)` The configuration used to connect to a cluster for registration.
`void`	`setCreatedAt(Date createdAt)` The Unix epoch timestamp in seconds for when the cluster was created.
`void`	`setEncryptionConfig(Collection<EncryptionConfig> encryptionConfig)` The encryption configuration for the cluster.
`void`	`setEndpoint(String endpoint)` The endpoint for your Kubernetes API server.
`void`	`setIdentity(Identity identity)` The identity provider information for the cluster.
`void`	`setKubernetesNetworkConfig(KubernetesNetworkConfigResponse kubernetesNetworkConfig)` The Kubernetes network configuration for the cluster.
`void`	`setLogging(Logging logging)` The logging configuration for your cluster.
`void`	`setName(String name)` The name of the cluster.
`void`	`setPlatformVersion(String platformVersion)` The platform version of your Amazon EKS cluster.
`void`	`setResourcesVpcConfig(VpcConfigResponse resourcesVpcConfig)` The VPC configuration used by the cluster control plane.
`void`	`setRoleArn(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.
`void`	`setStatus(String status)` The current status of the cluster.
`void`	`setTags(Map<String,String> tags)` The metadata that you apply to the cluster to assist with categorization and organization.
`void`	`setVersion(String version)` The Kubernetes server version for the cluster.
`String`	`toString()` Returns a string representation of this object.
`Cluster`	`withArn(String arn)` The Amazon Resource Name (ARN) of the cluster.
`Cluster`	`withCertificateAuthority(Certificate certificateAuthority)` The `certificate-authority-data` for your cluster.
`Cluster`	`withClientRequestToken(String clientRequestToken)` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`Cluster`	`withConnectorConfig(ConnectorConfigResponse connectorConfig)` The configuration used to connect to a cluster for registration.
`Cluster`	`withCreatedAt(Date createdAt)` The Unix epoch timestamp in seconds for when the cluster was created.
`Cluster`	`withEncryptionConfig(Collection<EncryptionConfig> encryptionConfig)` The encryption configuration for the cluster.
`Cluster`	`withEncryptionConfig(EncryptionConfig... encryptionConfig)` The encryption configuration for the cluster.
`Cluster`	`withEndpoint(String endpoint)` The endpoint for your Kubernetes API server.
`Cluster`	`withIdentity(Identity identity)` The identity provider information for the cluster.
`Cluster`	`withKubernetesNetworkConfig(KubernetesNetworkConfigResponse kubernetesNetworkConfig)` The Kubernetes network configuration for the cluster.
`Cluster`	`withLogging(Logging logging)` The logging configuration for your cluster.
`Cluster`	`withName(String name)` The name of the cluster.
`Cluster`	`withPlatformVersion(String platformVersion)` The platform version of your Amazon EKS cluster.
`Cluster`	`withResourcesVpcConfig(VpcConfigResponse resourcesVpcConfig)` The VPC configuration used by the cluster control plane.
`Cluster`	`withRoleArn(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.
`Cluster`	`withStatus(ClusterStatus status)` The current status of the cluster.
`Cluster`	`withStatus(String status)` The current status of the cluster.
`Cluster`	`withTags(Map<String,String> tags)` The metadata that you apply to the cluster to assist with categorization and organization.
`Cluster`	`withVersion(String version)` The Kubernetes server version for the cluster.

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

- Constructor Detail
  - Cluster
```
public Cluster()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the cluster.
    
    Parameters:
    
    name - The name of the cluster.
  - getName
```
public String getName()
```
    The name of the cluster.
    
    Returns:
    
    The name of the cluster.
  - withName
```
public Cluster withName(String name)
```
    The name of the cluster.
    
    Parameters:
    
    name - The name of the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the cluster.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the cluster.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the cluster.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the cluster.
  - withArn
```
public Cluster withArn(String arn)
```
    The Amazon Resource Name (ARN) of the cluster.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The Unix epoch timestamp in seconds for when the cluster was created.
    
    Parameters:
    
    createdAt - The Unix epoch timestamp in seconds for when the cluster was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    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.
  - withCreatedAt
```
public Cluster withCreatedAt(Date createdAt)
```
    The Unix epoch timestamp in seconds for when the cluster was created.
    
    Parameters:
    
    createdAt - The Unix epoch timestamp in seconds for when the cluster was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    The Kubernetes server version for the cluster.
    
    Parameters:
    
    version - The Kubernetes server version for the cluster.
  - getVersion
```
public String getVersion()
```
    The Kubernetes server version for the cluster.
    
    Returns:
    
    The Kubernetes server version for the cluster.
  - withVersion
```
public Cluster withVersion(String version)
```
    The Kubernetes server version for the cluster.
    
    Parameters:
    
    version - The Kubernetes server version for the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    The endpoint for your Kubernetes API server.
    
    Parameters:
    
    endpoint - The endpoint for your Kubernetes API server.
  - getEndpoint
```
public String getEndpoint()
```
    The endpoint for your Kubernetes API server.
    
    Returns:
    
    The endpoint for your Kubernetes API server.
  - withEndpoint
```
public Cluster withEndpoint(String endpoint)
```
    The endpoint for your Kubernetes API server.
    
    Parameters:
    
    endpoint - The endpoint for your Kubernetes API server.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(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.
    
    Parameters:
    
    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.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public Cluster withRoleArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourcesVpcConfig
```
public void setResourcesVpcConfig(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.
    
    Parameters:
    
    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.
  - getResourcesVpcConfig
```
public VpcConfigResponse getResourcesVpcConfig()
```
    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.
  - withResourcesVpcConfig
```
public Cluster withResourcesVpcConfig(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKubernetesNetworkConfig
```
public void setKubernetesNetworkConfig(KubernetesNetworkConfigResponse kubernetesNetworkConfig)
```
    The Kubernetes network configuration for the cluster.
    
    Parameters:
    
    kubernetesNetworkConfig - The Kubernetes network configuration for the cluster.
  - getKubernetesNetworkConfig
```
public KubernetesNetworkConfigResponse getKubernetesNetworkConfig()
```
    The Kubernetes network configuration for the cluster.
    
    Returns:
    
    The Kubernetes network configuration for the cluster.
  - withKubernetesNetworkConfig
```
public Cluster withKubernetesNetworkConfig(KubernetesNetworkConfigResponse kubernetesNetworkConfig)
```
    The Kubernetes network configuration for the cluster.
    
    Parameters:
    
    kubernetesNetworkConfig - The Kubernetes network configuration for the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogging
```
public void setLogging(Logging logging)
```
    The logging configuration for your cluster.
    
    Parameters:
    
    logging - The logging configuration for your cluster.
  - getLogging
```
public Logging getLogging()
```
    The logging configuration for your cluster.
    
    Returns:
    
    The logging configuration for your cluster.
  - withLogging
```
public Cluster withLogging(Logging logging)
```
    The logging configuration for your cluster.
    
    Parameters:
    
    logging - The logging configuration for your cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentity
```
public void setIdentity(Identity identity)
```
    The identity provider information for the cluster.
    
    Parameters:
    
    identity - The identity provider information for the cluster.
  - getIdentity
```
public Identity getIdentity()
```
    The identity provider information for the cluster.
    
    Returns:
    
    The identity provider information for the cluster.
  - withIdentity
```
public Cluster withIdentity(Identity identity)
```
    The identity provider information for the cluster.
    
    Parameters:
    
    identity - The identity provider information for the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the cluster.
    
    Parameters:
    
    status - The current status of the cluster.
    
    See Also:
    
    ClusterStatus
  - getStatus
```
public String getStatus()
```
    The current status of the cluster.
    
    Returns:
    
    The current status of the cluster.
    
    See Also:
    
    ClusterStatus
  - withStatus
```
public Cluster withStatus(String status)
```
    The current status of the cluster.
    
    Parameters:
    
    status - The current status of the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterStatus
  - withStatus
```
public Cluster withStatus(ClusterStatus status)
```
    The current status of the cluster.
    
    Parameters:
    
    status - The current status of the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterStatus
  - setCertificateAuthority
```
public void setCertificateAuthority(Certificate certificateAuthority)
```
    The certificate-authority-data for your cluster.
    
    Parameters:
    
    certificateAuthority - The certificate-authority-data for your cluster.
  - getCertificateAuthority
```
public Certificate getCertificateAuthority()
```
    The certificate-authority-data for your cluster.
    
    Returns:
    
    The certificate-authority-data for your cluster.
  - withCertificateAuthority
```
public Cluster withCertificateAuthority(Certificate certificateAuthority)
```
    The certificate-authority-data for your cluster.
    
    Parameters:
    
    certificateAuthority - The certificate-authority-data for your cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientRequestToken
```
public void setClientRequestToken(String clientRequestToken)
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    
    Parameters:
    
    clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - getClientRequestToken
```
public String getClientRequestToken()
```
    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.
  - withClientRequestToken
```
public Cluster withClientRequestToken(String clientRequestToken)
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    
    Parameters:
    
    clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlatformVersion
```
public void setPlatformVersion(String platformVersion)
```
    The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
    
    Parameters:
    
    platformVersion - The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
  - getPlatformVersion
```
public String getPlatformVersion()
```
    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 .
  - withPlatformVersion
```
public Cluster withPlatformVersion(String platformVersion)
```
    The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
    
    Parameters:
    
    platformVersion - The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
    
    Returns:
    
    The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
    
    Parameters:
    
    tags - The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
  - withTags
```
public Cluster withTags(Map<String,String> tags)
```
    The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
    
    Parameters:
    
    tags - The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Cluster addTagsEntry(String key,
                            String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Cluster clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEncryptionConfig
```
public List<EncryptionConfig> getEncryptionConfig()
```
    The encryption configuration for the cluster.
    
    Returns:
    
    The encryption configuration for the cluster.
  - setEncryptionConfig
```
public void setEncryptionConfig(Collection<EncryptionConfig> encryptionConfig)
```
    The encryption configuration for the cluster.
    
    Parameters:
    
    encryptionConfig - The encryption configuration for the cluster.
  - withEncryptionConfig
```
public Cluster withEncryptionConfig(EncryptionConfig... encryptionConfig)
```
    The encryption configuration for the cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setEncryptionConfig(java.util.Collection) or withEncryptionConfig(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    encryptionConfig - The encryption configuration for the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEncryptionConfig
```
public Cluster withEncryptionConfig(Collection<EncryptionConfig> encryptionConfig)
```
    The encryption configuration for the cluster.
    
    Parameters:
    
    encryptionConfig - The encryption configuration for the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectorConfig
```
public void setConnectorConfig(ConnectorConfigResponse connectorConfig)
```
    The configuration used to connect to a cluster for registration.
    
    Parameters:
    
    connectorConfig - The configuration used to connect to a cluster for registration.
  - getConnectorConfig
```
public ConnectorConfigResponse getConnectorConfig()
```
    The configuration used to connect to a cluster for registration.
    
    Returns:
    
    The configuration used to connect to a cluster for registration.
  - withConnectorConfig
```
public Cluster withConnectorConfig(ConnectorConfigResponse connectorConfig)
```
    The configuration used to connect to a cluster for registration.
    
    Parameters:
    
    connectorConfig - The configuration used to connect to a cluster for registration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Cluster clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Cluster

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cluster

Method Detail

setName

getName

withName

setArn

getArn

withArn

setCreatedAt

getCreatedAt

withCreatedAt

setVersion

getVersion

withVersion

setEndpoint

getEndpoint

withEndpoint

setRoleArn

getRoleArn

withRoleArn

setResourcesVpcConfig

getResourcesVpcConfig

withResourcesVpcConfig

setKubernetesNetworkConfig

getKubernetesNetworkConfig

withKubernetesNetworkConfig

setLogging

getLogging

withLogging

setIdentity

getIdentity

withIdentity

setStatus

getStatus

withStatus

withStatus

setCertificateAuthority

getCertificateAuthority

withCertificateAuthority

setClientRequestToken

getClientRequestToken

withClientRequestToken

setPlatformVersion

getPlatformVersion

withPlatformVersion

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

getEncryptionConfig

setEncryptionConfig

withEncryptionConfig

withEncryptionConfig

setConnectorConfig

getConnectorConfig

withConnectorConfig

toString

equals

hashCode

clone

marshall