Class Cluster
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Cluster.Builder,
Cluster>
An object representing an Amazon EKS cluster.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AccessConfigResponse
The access configuration for the cluster.final String
arn()
The Amazon Resource Name (ARN) of the cluster.static Cluster.Builder
builder()
final Certificate
Thecertificate-authority-data
for your cluster.final String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final ConnectorConfigResponse
The configuration used to connect to a cluster for registration.final Instant
The Unix epoch timestamp at object creation.final List
<EncryptionConfig> The encryption configuration for the cluster.final String
endpoint()
The endpoint for your Kubernetes API server.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the EncryptionConfig property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final ClusterHealth
health()
An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost.final String
id()
The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost.final Identity
identity()
The identity provider information for the cluster.The Kubernetes network configuration for the cluster.final Logging
logging()
The logging configuration for your cluster.final String
name()
The name of your cluster.final OutpostConfigResponse
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost.final String
The platform version of your Amazon EKS cluster.final VpcConfigResponse
The VPC configuration used by the cluster control plane.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.static Class
<? extends Cluster.Builder> final ClusterStatus
status()
The current status of the cluster.final String
The current status of the cluster.tags()
Metadata that assists with categorization and organization.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
version()
The Kubernetes server version for the cluster.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of your cluster.
- Returns:
- The name of your cluster.
-
arn
The Amazon Resource Name (ARN) of the cluster.
- Returns:
- The Amazon Resource Name (ARN) of the cluster.
-
createdAt
The Unix epoch timestamp at object creation.
- Returns:
- The Unix epoch timestamp at object creation.
-
version
The Kubernetes server version for the cluster.
- Returns:
- The Kubernetes server version for the cluster.
-
endpoint
The endpoint for your Kubernetes API server.
- Returns:
- The endpoint for your Kubernetes API server.
-
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
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
The Kubernetes network configuration for the cluster.
- Returns:
- The Kubernetes network configuration for the cluster.
-
logging
The logging configuration for your cluster.
- Returns:
- The logging configuration for your cluster.
-
identity
The identity provider information for the cluster.
- Returns:
- The identity provider information for the cluster.
-
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 returnClusterStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the cluster.
- See Also:
-
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 returnClusterStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the cluster.
- See Also:
-
certificateAuthority
The
certificate-authority-data
for your cluster.- Returns:
- The
certificate-authority-data
for your cluster.
-
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
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 theisEmpty()
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
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 theisEmpty()
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
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
The configuration used to connect to a cluster for registration.
- Returns:
- The configuration used to connect to a cluster for registration.
-
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
An object representing the health 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 health 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.
-
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
The access configuration for the cluster.
- Returns:
- The access configuration for the cluster.
-
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 interfaceToCopyableBuilder<Cluster.Builder,
Cluster> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-