Package software.amazon.awssdk.services.eks.model

Interface Cluster.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Cluster.Builder,Cluster>, SdkBuilder<Cluster.Builder,Cluster>, SdkPojo

Enclosing class:

Cluster

public static interface Cluster.Builder
extends SdkPojo, CopyableBuilder<Cluster.Builder,Cluster>

Method Summary

Modifier and Type	Method	Description
default Cluster.Builder	accessConfig(Consumer<AccessConfigResponse.Builder> accessConfig)	The access configuration for the cluster.
Cluster.Builder	accessConfig(AccessConfigResponse accessConfig)	The access configuration for the cluster.
Cluster.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the cluster.
default Cluster.Builder	certificateAuthority(Consumer<Certificate.Builder> certificateAuthority)	The certificate-authority-data for your cluster.
Cluster.Builder	certificateAuthority(Certificate certificateAuthority)	The certificate-authority-data for your cluster.
Cluster.Builder	clientRequestToken(String clientRequestToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
default Cluster.Builder	connectorConfig(Consumer<ConnectorConfigResponse.Builder> connectorConfig)	The configuration used to connect to a cluster for registration.
Cluster.Builder	connectorConfig(ConnectorConfigResponse connectorConfig)	The configuration used to connect to a cluster for registration.
Cluster.Builder	createdAt(Instant createdAt)	The Unix epoch timestamp at object creation.
Cluster.Builder	encryptionConfig(Collection<EncryptionConfig> encryptionConfig)	The encryption configuration for the cluster.
Cluster.Builder	encryptionConfig(Consumer<EncryptionConfig.Builder>... encryptionConfig)	The encryption configuration for the cluster.
Cluster.Builder	encryptionConfig(EncryptionConfig... encryptionConfig)	The encryption configuration for the cluster.
Cluster.Builder	endpoint(String endpoint)	The endpoint for your Kubernetes API server.
default Cluster.Builder	health(Consumer<ClusterHealth.Builder> health)	An object representing the health of your Amazon EKS cluster.
Cluster.Builder	health(ClusterHealth health)	An object representing the health of your Amazon EKS cluster.
Cluster.Builder	id(String id)	The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost.
default Cluster.Builder	identity(Consumer<Identity.Builder> identity)	The identity provider information for the cluster.
Cluster.Builder	identity(Identity identity)	The identity provider information for the cluster.
default Cluster.Builder	kubernetesNetworkConfig(Consumer<KubernetesNetworkConfigResponse.Builder> kubernetesNetworkConfig)	The Kubernetes network configuration for the cluster.
Cluster.Builder	kubernetesNetworkConfig(KubernetesNetworkConfigResponse kubernetesNetworkConfig)	The Kubernetes network configuration for the cluster.
default Cluster.Builder	logging(Consumer<Logging.Builder> logging)	The logging configuration for your cluster.
Cluster.Builder	logging(Logging logging)	The logging configuration for your cluster.
Cluster.Builder	name(String name)	The name of your cluster.
default Cluster.Builder	outpostConfig(Consumer<OutpostConfigResponse.Builder> outpostConfig)	An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost.
Cluster.Builder	outpostConfig(OutpostConfigResponse outpostConfig)	An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost.
Cluster.Builder	platformVersion(String platformVersion)	The platform version of your Amazon EKS cluster.
default Cluster.Builder	resourcesVpcConfig(Consumer<VpcConfigResponse.Builder> resourcesVpcConfig)	The VPC configuration used by the cluster control plane.
Cluster.Builder	resourcesVpcConfig(VpcConfigResponse resourcesVpcConfig)	The VPC configuration used by the cluster control plane.
Cluster.Builder	roleArn(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.Builder	status(String status)	The current status of the cluster.
Cluster.Builder	status(ClusterStatus status)	The current status of the cluster.
Cluster.Builder	tags(Map<String,String> tags)	Metadata that assists with categorization and organization.
default Cluster.Builder	upgradePolicy(Consumer<UpgradePolicyResponse.Builder> upgradePolicy)	This value indicates if extended support is enabled or disabled for the cluster.
Cluster.Builder	upgradePolicy(UpgradePolicyResponse upgradePolicy)	This value indicates if extended support is enabled or disabled for the cluster.
Cluster.Builder	version(String version)	The Kubernetes server version for the cluster.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

name

Cluster.Builder name(String name)

The name of your cluster.

Parameters:

name - The name of your cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

arn

Cluster.Builder arn(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.

createdAt

Cluster.Builder createdAt(Instant createdAt)

The Unix epoch timestamp at object creation.

Parameters:

createdAt - The Unix epoch timestamp at object creation.

Returns:

Returns a reference to this object so that method calls can be chained together.

version

Cluster.Builder version(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.

endpoint

Cluster.Builder endpoint(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.

roleArn

Cluster.Builder roleArn(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.

resourcesVpcConfig

Cluster.Builder resourcesVpcConfig(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.

resourcesVpcConfig

default Cluster.Builder resourcesVpcConfig(Consumer<VpcConfigResponse.Builder> 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.

This is a convenience method that creates an instance of the VpcConfigResponse.Builder avoiding the need to create one manually via VpcConfigResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourcesVpcConfig(VpcConfigResponse).

Parameters:

resourcesVpcConfig - a consumer that will call methods on VpcConfigResponse.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

resourcesVpcConfig(VpcConfigResponse)

kubernetesNetworkConfig

Cluster.Builder kubernetesNetworkConfig(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.

kubernetesNetworkConfig

default Cluster.Builder kubernetesNetworkConfig(Consumer<KubernetesNetworkConfigResponse.Builder> kubernetesNetworkConfig)

The Kubernetes network configuration for the cluster.

This is a convenience method that creates an instance of the KubernetesNetworkConfigResponse.Builder avoiding the need to create one manually via KubernetesNetworkConfigResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kubernetesNetworkConfig(KubernetesNetworkConfigResponse).

Parameters:

kubernetesNetworkConfig - a consumer that will call methods on KubernetesNetworkConfigResponse.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

kubernetesNetworkConfig(KubernetesNetworkConfigResponse)

logging

Cluster.Builder logging(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.

logging

default Cluster.Builder logging(Consumer<Logging.Builder> logging)

The logging configuration for your cluster.

This is a convenience method that creates an instance of the Logging.Builder avoiding the need to create one manually via Logging.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logging(Logging).

Parameters:

logging - a consumer that will call methods on Logging.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

logging(Logging)

identity

Cluster.Builder identity(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.

identity

default Cluster.Builder identity(Consumer<Identity.Builder> identity)

The identity provider information for the cluster.

This is a convenience method that creates an instance of the Identity.Builder avoiding the need to create one manually via Identity.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to identity(Identity).

Parameters:

identity - a consumer that will call methods on Identity.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

identity(Identity)

status

Cluster.Builder status(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, ClusterStatus

status

Cluster.Builder status(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, ClusterStatus

certificateAuthority

Cluster.Builder certificateAuthority(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.

certificateAuthority

default Cluster.Builder certificateAuthority(Consumer<Certificate.Builder> certificateAuthority)

The certificate-authority-data for your cluster.

This is a convenience method that creates an instance of the Certificate.Builder avoiding the need to create one manually via Certificate.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to certificateAuthority(Certificate).

Parameters:

certificateAuthority - a consumer that will call methods on Certificate.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

certificateAuthority(Certificate)

clientRequestToken

Cluster.Builder clientRequestToken(String clientRequestToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Parameters:

clientRequestToken - A 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.

platformVersion

Cluster.Builder platformVersion(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 .

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

tags

Cluster.Builder tags(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionConfig

Cluster.Builder encryptionConfig(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.

encryptionConfig

Cluster.Builder encryptionConfig(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.

encryptionConfig

Cluster.Builder encryptionConfig(Consumer<EncryptionConfig.Builder>... encryptionConfig)

The encryption configuration for the cluster.

This is a convenience method that creates an instance of the EncryptionConfig.Builder avoiding the need to create one manually via EncryptionConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #encryptionConfig(List).

Parameters:

encryptionConfig - a consumer that will call methods on EncryptionConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#encryptionConfig(java.util.Collection)

connectorConfig

Cluster.Builder connectorConfig(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.

connectorConfig

default Cluster.Builder connectorConfig(Consumer<ConnectorConfigResponse.Builder> connectorConfig)

The configuration used to connect to a cluster for registration.

This is a convenience method that creates an instance of the ConnectorConfigResponse.Builder avoiding the need to create one manually via ConnectorConfigResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to connectorConfig(ConnectorConfigResponse).

Parameters:

connectorConfig - a consumer that will call methods on ConnectorConfigResponse.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

connectorConfig(ConnectorConfigResponse)

id

Cluster.Builder id(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

health

Cluster.Builder health(ClusterHealth health)

An object representing the health of your Amazon EKS cluster.

Parameters:

health - An object representing the health of your Amazon EKS cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

health

default Cluster.Builder health(Consumer<ClusterHealth.Builder> health)

An object representing the health of your Amazon EKS cluster.

This is a convenience method that creates an instance of the ClusterHealth.Builder avoiding the need to create one manually via ClusterHealth.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to health(ClusterHealth).

Parameters:

health - a consumer that will call methods on ClusterHealth.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

health(ClusterHealth)

outpostConfig

Cluster.Builder outpostConfig(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

outpostConfig

default Cluster.Builder outpostConfig(Consumer<OutpostConfigResponse.Builder> 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.

This is a convenience method that creates an instance of the OutpostConfigResponse.Builder avoiding the need to create one manually via OutpostConfigResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outpostConfig(OutpostConfigResponse).

Parameters:

outpostConfig - a consumer that will call methods on OutpostConfigResponse.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

outpostConfig(OutpostConfigResponse)

accessConfig

Cluster.Builder accessConfig(AccessConfigResponse accessConfig)

The access configuration for the cluster.

Parameters:

accessConfig - The access configuration for the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

accessConfig

default Cluster.Builder accessConfig(Consumer<AccessConfigResponse.Builder> accessConfig)

The access configuration for the cluster.

This is a convenience method that creates an instance of the AccessConfigResponse.Builder avoiding the need to create one manually via AccessConfigResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessConfig(AccessConfigResponse).

Parameters:

accessConfig - a consumer that will call methods on AccessConfigResponse.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

accessConfig(AccessConfigResponse)

upgradePolicy

Cluster.Builder upgradePolicy(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

upgradePolicy

default Cluster.Builder upgradePolicy(Consumer<UpgradePolicyResponse.Builder> 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.

This is a convenience method that creates an instance of the UpgradePolicyResponse.Builder avoiding the need to create one manually via UpgradePolicyResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to upgradePolicy(UpgradePolicyResponse).

Parameters:

upgradePolicy - a consumer that will call methods on UpgradePolicyResponse.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

upgradePolicy(UpgradePolicyResponse)