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, which defines how maxCapacity is interpreted.
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. For a quota management enabled service environment, this value represents the maximum quantity of a particular resource type (specified by capacityUnit) that can be allocated to service jobs. For other service environments, this value represents the maximum quantity of all resources that can be allocated to service jobs.

For example, if maxCapacity=50 and capacityUnit=NUM_INSTANCES, you can run up to 50 instances concurrently. If you run 5 SageMaker Training jobs that each use 10 instances, a subsequent job requiring 10 instances waits in the queue until capacity is available. In a quota management enabled service environment with capacityUnit=ml.m5.large, only ml.m5.large instances count against this limit, and jobs requiring other instance types wait until a matching capacity limit is configured.

Parameters:

maxCapacity - The maximum capacity available for the service environment. For a quota management enabled service environment, this value represents the maximum quantity of a particular resource type (specified by capacityUnit) that can be allocated to service jobs. For other service environments, this value represents the maximum quantity of all resources that can be allocated to service jobs.

For example, if maxCapacity=50 and capacityUnit=NUM_INSTANCES, you can run up to 50 instances concurrently. If you run 5 SageMaker Training jobs that each use 10 instances, a subsequent job requiring 10 instances waits in the queue until capacity is available. In a quota management enabled service environment with capacityUnit=ml.m5.large, only ml.m5.large instances count against this limit, and jobs requiring other instance types wait until a matching capacity limit is configured.

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, which defines how maxCapacity is interpreted. For SAGEMAKER_TRAINING jobs in a quota management enabled service environment, specify the instance type (for example, ml.m5.large). Otherwise, use NUM_INSTANCES.

Parameters:

capacityUnit - The unit of measure for the capacity limit, which defines how maxCapacity is interpreted. For SAGEMAKER_TRAINING jobs in a quota management enabled service environment, specify the instance type (for example, ml.m5.large). Otherwise, use NUM_INSTANCES.

Returns:

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