Interface CreateClusterRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>, EksRequest.Builder, SdkBuilder<CreateClusterRequest.Builder,CreateClusterRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateClusterRequest
@Mutable @NotThreadSafe public static interface CreateClusterRequest.Builder extends EksRequest.Builder, SdkPojo, CopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

  • Method Details

    • name

      CreateClusterRequest.Builder name(String name)

      The unique name to give to your cluster. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the cluster in.

      Parameters:
      name - The unique name to give to your cluster. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the cluster in.
      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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 add-ons 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 add-ons 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:

    • zonalShiftConfig

      CreateClusterRequest.Builder zonalShiftConfig(ZonalShiftConfigRequest zonalShiftConfig)

      Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.

      Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary.

      You can start a zonal shift for an Amazon EKS cluster, or you can allow Amazon Web Services to do it for you by enabling zonal autoshift. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your Amazon EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS in the Amazon EKS User Guide .

      Parameters:
      zonalShiftConfig - Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.

      Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary.

      You can start a zonal shift for an Amazon EKS cluster, or you can allow Amazon Web Services to do it for you by enabling zonal autoshift. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your Amazon EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS in the Amazon EKS User Guide .

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

    • zonalShiftConfig

      default CreateClusterRequest.Builder zonalShiftConfig(Consumer<ZonalShiftConfigRequest.Builder> zonalShiftConfig)

      Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.

      Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary.

      You can start a zonal shift for an Amazon EKS cluster, or you can allow Amazon Web Services to do it for you by enabling zonal autoshift. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your Amazon EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS in the Amazon EKS User Guide .

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

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

      Parameters:
      zonalShiftConfig - a consumer that will call methods on ZonalShiftConfigRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • remoteNetworkConfig

      CreateClusterRequest.Builder remoteNetworkConfig(RemoteNetworkConfigRequest remoteNetworkConfig)

      The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.

      Parameters:
      remoteNetworkConfig - The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • remoteNetworkConfig

      default CreateClusterRequest.Builder remoteNetworkConfig(Consumer<RemoteNetworkConfigRequest.Builder> remoteNetworkConfig)

      The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.

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

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

      Parameters:
      remoteNetworkConfig - a consumer that will call methods on RemoteNetworkConfigRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • computeConfig

      CreateClusterRequest.Builder computeConfig(ComputeConfigRequest computeConfig)

      Enable or disable the compute capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account

      Parameters:
      computeConfig - Enable or disable the compute capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • computeConfig

      default CreateClusterRequest.Builder computeConfig(Consumer<ComputeConfigRequest.Builder> computeConfig)

      Enable or disable the compute capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account

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

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

      Parameters:
      computeConfig - a consumer that will call methods on ComputeConfigRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageConfig

      CreateClusterRequest.Builder storageConfig(StorageConfigRequest storageConfig)

      Enable or disable the block storage capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.

      Parameters:
      storageConfig - Enable or disable the block storage capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageConfig

      default CreateClusterRequest.Builder storageConfig(Consumer<StorageConfigRequest.Builder> storageConfig)

      Enable or disable the block storage capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.

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

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

      Parameters:
      storageConfig - a consumer that will call methods on StorageConfigRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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