Interface CreateClusterRequest.Builder

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

  • Method Details

    • clusterName

      CreateClusterRequest.Builder clusterName(String clusterName)

      A name to identify the cluster. Example: MyCluster

      Parameters:
      clusterName - A name to identify the cluster. Example: MyCluster
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduler

      CreateClusterRequest.Builder scheduler(SchedulerRequest scheduler)

      The cluster management and job scheduling software associated with the cluster.

      Parameters:
      scheduler - The cluster management and job scheduling software associated with the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduler

      default CreateClusterRequest.Builder scheduler(Consumer<SchedulerRequest.Builder> scheduler)

      The cluster management and job scheduling software associated with the cluster.

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

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

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

    • size

      CreateClusterRequest.Builder size(String size)

      A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).

      • SMALL: 32 compute nodes and 256 jobs

      • MEDIUM: 512 compute nodes and 8192 jobs

      • LARGE: 2048 compute nodes and 16,384 jobs

      Parameters:
      size - A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).

      • SMALL: 32 compute nodes and 256 jobs

      • MEDIUM: 512 compute nodes and 8192 jobs

      • LARGE: 2048 compute nodes and 16,384 jobs

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

    • size

      CreateClusterRequest.Builder size(Size size)

      A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).

      • SMALL: 32 compute nodes and 256 jobs

      • MEDIUM: 512 compute nodes and 8192 jobs

      • LARGE: 2048 compute nodes and 16,384 jobs

      Parameters:
      size - A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).

      • SMALL: 32 compute nodes and 256 jobs

      • MEDIUM: 512 compute nodes and 8192 jobs

      • LARGE: 2048 compute nodes and 16,384 jobs

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

    • networking

      CreateClusterRequest.Builder networking(NetworkingRequest networking)

      The networking configuration used to set up the cluster's control plane.

      Parameters:
      networking - The networking configuration used to set up the cluster's control plane.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networking

      default CreateClusterRequest.Builder networking(Consumer<NetworkingRequest.Builder> networking)

      The networking configuration used to set up the cluster's control plane.

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

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

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

    • slurmConfiguration

      CreateClusterRequest.Builder slurmConfiguration(ClusterSlurmConfigurationRequest slurmConfiguration)

      Additional options related to the Slurm scheduler.

      Parameters:
      slurmConfiguration - Additional options related to the Slurm scheduler.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • slurmConfiguration

      default CreateClusterRequest.Builder slurmConfiguration(Consumer<ClusterSlurmConfigurationRequest.Builder> slurmConfiguration)

      Additional options related to the Slurm scheduler.

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

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

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

    • clientToken

      CreateClusterRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateClusterRequest.Builder tags(Map<String,String> tags)

      1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

      Parameters:
      tags - 1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

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