Interface CreateClusterRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>, EksRequest.Builder, SdkBuilder<CreateClusterRequest.Builder,CreateClusterRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateClusterRequest

public static interface CreateClusterRequest.Builder
extends EksRequest.Builder, SdkPojo, CopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

Method Summary

Modifier and Type	Method	Description
default CreateClusterRequest.Builder	accessConfig(Consumer<CreateAccessConfigRequest.Builder> accessConfig)	The access configuration for the cluster.
CreateClusterRequest.Builder	accessConfig(CreateAccessConfigRequest accessConfig)	The access configuration for the cluster.
CreateClusterRequest.Builder	bootstrapSelfManagedAddons(Boolean bootstrapSelfManagedAddons)	If you set this value to False when creating a cluster, the default networking add-ons will not be installed.
CreateClusterRequest.Builder	clientRequestToken(String clientRequestToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateClusterRequest.Builder	encryptionConfig(Collection<EncryptionConfig> encryptionConfig)	The encryption configuration for the cluster.
CreateClusterRequest.Builder	encryptionConfig(Consumer<EncryptionConfig.Builder>... encryptionConfig)	The encryption configuration for the cluster.
CreateClusterRequest.Builder	encryptionConfig(EncryptionConfig... encryptionConfig)	The encryption configuration for the cluster.
default CreateClusterRequest.Builder	kubernetesNetworkConfig(Consumer<KubernetesNetworkConfigRequest.Builder> kubernetesNetworkConfig)	The Kubernetes network configuration for the cluster.
CreateClusterRequest.Builder	kubernetesNetworkConfig(KubernetesNetworkConfigRequest kubernetesNetworkConfig)	The Kubernetes network configuration for the cluster.
default CreateClusterRequest.Builder	logging(Consumer<Logging.Builder> logging)	Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs.
CreateClusterRequest.Builder	logging(Logging logging)	Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs.
CreateClusterRequest.Builder	name(String name)	The unique name to give to your cluster.
default CreateClusterRequest.Builder	outpostConfig(Consumer<OutpostConfigRequest.Builder> outpostConfig)	An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost.
CreateClusterRequest.Builder	outpostConfig(OutpostConfigRequest outpostConfig)	An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost.
CreateClusterRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateClusterRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateClusterRequest.Builder	resourcesVpcConfig(Consumer<VpcConfigRequest.Builder> resourcesVpcConfig)	The VPC configuration that's used by the cluster control plane.
CreateClusterRequest.Builder	resourcesVpcConfig(VpcConfigRequest resourcesVpcConfig)	The VPC configuration that's used by the cluster control plane.
CreateClusterRequest.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.
CreateClusterRequest.Builder	tags(Map<String,String> tags)	Metadata that assists with categorization and organization.
default CreateClusterRequest.Builder	upgradePolicy(Consumer<UpgradePolicyRequest.Builder> upgradePolicy)	New clusters, by default, have extended support enabled.
CreateClusterRequest.Builder	upgradePolicy(UpgradePolicyRequest upgradePolicy)	New clusters, by default, have extended support enabled.
CreateClusterRequest.Builder	version(String version)	The desired Kubernetes version for your cluster.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.eks.model.EksRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

name

CreateClusterRequest.Builder name(String name)

The unique name to give to your cluster.

Parameters:

name - The unique name to give to your cluster.

Returns:

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

version

CreateClusterRequest.Builder version(String version)

The desired Kubernetes version for your cluster. If you don't specify a value here, the default version available in Amazon EKS is used.

The default version might not be the latest version available.

Parameters:

version - The desired Kubernetes version for your cluster. If you don't specify a value here, the default version available in Amazon EKS is used.

The default version might not be the latest version available.

Returns:

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

roleArn

CreateClusterRequest.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. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

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. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

Returns:

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

resourcesVpcConfig

CreateClusterRequest.Builder resourcesVpcConfig(VpcConfigRequest resourcesVpcConfig)

The VPC configuration that's 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. You must specify at least two subnets. You can specify up to five security groups. However, we recommend that you use a dedicated security group for your cluster control plane.

Parameters:

resourcesVpcConfig - The VPC configuration that's 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. You must specify at least two subnets. You can specify up to five security groups. However, we recommend that you use a dedicated security group for your cluster control plane.

Returns:

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

resourcesVpcConfig

default CreateClusterRequest.Builder resourcesVpcConfig(Consumer<VpcConfigRequest.Builder> resourcesVpcConfig)

The VPC configuration that's 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. You must specify at least two subnets. You can specify up to five security groups. However, we recommend that you use a dedicated security group for your cluster control plane.

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

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

Parameters:

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

Returns:

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

See Also:

• resourcesVpcConfig(VpcConfigRequest)

kubernetesNetworkConfig

CreateClusterRequest.Builder kubernetesNetworkConfig(KubernetesNetworkConfigRequest 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 CreateClusterRequest.Builder kubernetesNetworkConfig(Consumer<KubernetesNetworkConfigRequest.Builder> kubernetesNetworkConfig)

The Kubernetes network configuration for the cluster.

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

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

Parameters:

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

Returns:

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

See Also:

• kubernetesNetworkConfig(KubernetesNetworkConfigRequest)

logging

CreateClusterRequest.Builder logging(Logging logging)

Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.

Parameters:

logging - Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.

Returns:

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

logging

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

Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.

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)

clientRequestToken

CreateClusterRequest.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.

tags

CreateClusterRequest.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

CreateClusterRequest.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

CreateClusterRequest.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

CreateClusterRequest.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<EncryptionConfig>).

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<EncryptionConfig>)

outpostConfig

CreateClusterRequest.Builder outpostConfig(OutpostConfigRequest outpostConfig)

An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review Local clusters for Amazon EKS on Amazon Web Services Outposts in the Amazon EKS User Guide. This object isn't available for creating Amazon EKS 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. Before creating a local cluster on an Outpost, review Local clusters for Amazon EKS on Amazon Web Services Outposts in the Amazon EKS User Guide. This object isn't available for creating Amazon EKS clusters on the Amazon Web Services cloud.

Returns:

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

outpostConfig

default CreateClusterRequest.Builder outpostConfig(Consumer<OutpostConfigRequest.Builder> outpostConfig)

An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review Local clusters for Amazon EKS on Amazon Web Services Outposts in the Amazon EKS User Guide. This object isn't available for creating Amazon EKS clusters on the Amazon Web Services cloud.

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

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

Parameters:

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

Returns:

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

See Also:

• outpostConfig(OutpostConfigRequest)

accessConfig

CreateClusterRequest.Builder accessConfig(CreateAccessConfigRequest 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 CreateClusterRequest.Builder accessConfig(Consumer<CreateAccessConfigRequest.Builder> accessConfig)

The access configuration for the cluster.

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

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

Parameters:

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

Returns:

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

See Also:

• accessConfig(CreateAccessConfigRequest)

bootstrapSelfManagedAddons

CreateClusterRequest.Builder bootstrapSelfManagedAddons(Boolean bootstrapSelfManagedAddons)

If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

The default networking addons include vpc-cni, coredns, and kube-proxy.

Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

Parameters:

bootstrapSelfManagedAddons - If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

The default networking addons include vpc-cni, coredns, and kube-proxy.

Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

Returns:

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

upgradePolicy

CreateClusterRequest.Builder upgradePolicy(UpgradePolicyRequest upgradePolicy)

New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to STANDARD.

Parameters:

upgradePolicy - New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to STANDARD.

Returns:

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

upgradePolicy

default CreateClusterRequest.Builder upgradePolicy(Consumer<UpgradePolicyRequest.Builder> upgradePolicy)

New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to STANDARD.

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

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

Parameters:

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

Returns:

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

See Also:

• upgradePolicy(UpgradePolicyRequest)

overrideConfiguration

CreateClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.