interface CapacityLimitProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Batch.CfnServiceEnvironment.CapacityLimitProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#CfnServiceEnvironment_CapacityLimitProperty |
 Java | software.amazon.awscdk.services.batch.CfnServiceEnvironment.CapacityLimitProperty |
 Python | aws_cdk.aws_batch.CfnServiceEnvironment.CapacityLimitProperty |
 TypeScript | aws-cdk-lib » aws_batch » CfnServiceEnvironment » CapacityLimitProperty |
Defines the capacity limit for a service environment.
This structure specifies the maximum amount of resources that can be used by service jobs in the environment.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_batch as batch } from 'aws-cdk-lib';
const capacityLimitProperty: batch.CfnServiceEnvironment.CapacityLimitProperty = {
capacityUnit: 'capacityUnit',
maxCapacity: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| capacity | string | The unit of measure for the capacity limit. |
| max | number | The maximum capacity available for the service environment. |
capacityUnit?
Type:
string
(optional)
The unit of measure for the capacity limit.
This defines how the maxCapacity value should be interpreted. For SAGEMAKER_TRAINING jobs, use NUM_INSTANCES .
maxCapacity?
Type:
number
(optional)
The maximum capacity available for the service environment.
This value represents the maximum amount 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.