Package software.amazon.awssdk.services.batch.model

Interface CapacityLimit.Builder

All Superinterfaces:

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

Enclosing class:

CapacityLimit

@Mutable
@NotThreadSafe
public static interface CapacityLimit.Builder
extends SdkPojo, CopyableBuilder<CapacityLimit.Builder,CapacityLimit>

Method Summary

Modifier and Type	Method	Description
CapacityLimit.Builder	capacityUnit(String capacityUnit)	The unit of measure for the capacity limit.
CapacityLimit.Builder	maxCapacity(Integer maxCapacity)	The maximum capacity available for the service environment.

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, sdkFieldNameToField, sdkFields

Method Detail

maxCapacity

CapacityLimit.Builder maxCapacity(Integer maxCapacity)

The maximum capacity available for the service environment. This value represents the maximum amount of resources that can be allocated to service jobs.

For example, maxCapacity=50, capacityUnit=NUM_INSTANCES. This indicates that the maximum number of instances that can be run on this service environment is 50. You could then run 5 SageMaker Training jobs that each use 10 instances. However, if you submit another job that requires 10 instances, it will wait in the queue.

Parameters:

maxCapacity - The maximum capacity available for the service environment. This value represents the maximum amount of resources that can be allocated to service jobs.

For example, maxCapacity=50, capacityUnit=NUM_INSTANCES. This indicates that the maximum number of instances that can be run on this service environment is 50. You could then run 5 SageMaker Training jobs that each use 10 instances. However, if you submit another job that requires 10 instances, it will wait in the queue.

Returns:

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

capacityUnit

CapacityLimit.Builder capacityUnit(String capacityUnit)

The unit of measure for the capacity limit. This defines how the maxCapacity value should be interpreted. For SAGEMAKER_TRAINING jobs, use NUM_INSTANCES.

Parameters:

capacityUnit - The unit of measure for the capacity limit. This defines how the maxCapacity value should be interpreted. For SAGEMAKER_TRAINING jobs, use NUM_INSTANCES.

Returns:

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