Interface Cluster.Builder

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

  • Method Details

    • name

      Cluster.Builder name(String name)

      The name that identifies the cluster.

      Parameters:
      name - The name that identifies the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • id

      Cluster.Builder id(String id)

      The generated unique ID of the cluster.

      Parameters:
      id - The generated unique ID of the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      Cluster.Builder arn(String arn)

      The unique Amazon Resource Name (ARN) of the cluster.

      Parameters:
      arn - The unique Amazon Resource Name (ARN) of the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      Cluster.Builder status(String status)

      The provisioning status of the cluster.

      The provisioning status doesn't indicate the overall health of the cluster.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

      Parameters:
      status - The provisioning status of the cluster.

      The provisioning status doesn't indicate the overall health of the cluster.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

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

    • status

      Cluster.Builder status(ClusterStatus status)

      The provisioning status of the cluster.

      The provisioning status doesn't indicate the overall health of the cluster.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

      Parameters:
      status - The provisioning status of the cluster.

      The provisioning status doesn't indicate the overall health of the cluster.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

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

    • createdAt

      Cluster.Builder createdAt(Instant createdAt)

      The date and time the resource was created.

      Parameters:
      createdAt - The date and time the resource was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modifiedAt

      Cluster.Builder modifiedAt(Instant modifiedAt)

      The date and time the resource was modified.

      Parameters:
      modifiedAt - The date and time the resource was modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduler

      Cluster.Builder scheduler(Scheduler scheduler)
      Sets the value of the Scheduler property for this object.
      Parameters:
      scheduler - The new value for the Scheduler property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduler

      default Cluster.Builder scheduler(Consumer<Scheduler.Builder> scheduler)
      Sets the value of the Scheduler property for this object. This is a convenience method that creates an instance of the Scheduler.Builder avoiding the need to create one manually via Scheduler.builder().

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

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

    • size

      Cluster.Builder size(String size)

      The size of the cluster.

      • SMALL: 32 compute nodes and 256 jobs

      • MEDIUM: 512 compute nodes and 8192 jobs

      • LARGE: 2048 compute nodes and 16,384 jobs

      Parameters:
      size - The size of the cluster.

      • 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

      Cluster.Builder size(Size size)

      The size of the cluster.

      • SMALL: 32 compute nodes and 256 jobs

      • MEDIUM: 512 compute nodes and 8192 jobs

      • LARGE: 2048 compute nodes and 16,384 jobs

      Parameters:
      size - The size of the cluster.

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

    • slurmConfiguration

      Cluster.Builder slurmConfiguration(ClusterSlurmConfiguration 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 Cluster.Builder slurmConfiguration(Consumer<ClusterSlurmConfiguration.Builder> slurmConfiguration)

      Additional options related to the Slurm scheduler.

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

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

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

    • networking

      Cluster.Builder networking(Networking networking)
      Sets the value of the Networking property for this object.
      Parameters:
      networking - The new value for the Networking property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networking

      default Cluster.Builder networking(Consumer<Networking.Builder> networking)
      Sets the value of the Networking property for this object. This is a convenience method that creates an instance of the Networking.Builder avoiding the need to create one manually via Networking.builder().

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

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

    • endpoints

      Cluster.Builder endpoints(Collection<Endpoint> endpoints)

      The list of endpoints available for interaction with the scheduler.

      Parameters:
      endpoints - The list of endpoints available for interaction with the scheduler.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoints

      Cluster.Builder endpoints(Endpoint... endpoints)

      The list of endpoints available for interaction with the scheduler.

      Parameters:
      endpoints - The list of endpoints available for interaction with the scheduler.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoints

      Cluster.Builder endpoints(Consumer<Endpoint.Builder>... endpoints)

      The list of endpoints available for interaction with the scheduler.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpoints(List<Endpoint>).

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

    • errorInfo

      Cluster.Builder errorInfo(Collection<ErrorInfo> errorInfo)

      The list of errors that occurred during cluster provisioning.

      Parameters:
      errorInfo - The list of errors that occurred during cluster provisioning.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorInfo

      Cluster.Builder errorInfo(ErrorInfo... errorInfo)

      The list of errors that occurred during cluster provisioning.

      Parameters:
      errorInfo - The list of errors that occurred during cluster provisioning.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorInfo

      Cluster.Builder errorInfo(Consumer<ErrorInfo.Builder>... errorInfo)

      The list of errors that occurred during cluster provisioning.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to errorInfo(List<ErrorInfo>).

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