AWS::Batch::ServiceEnvironment CapacityLimit - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Batch::ServiceEnvironment CapacityLimit

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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "CapacityUnit" : String,
  "MaxCapacity" : Integer
}

YAML

  CapacityUnit: String
  MaxCapacity: Integer

Properties

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.

Required: No

Type: String

Update requires: No interruption

MaxCapacity

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.

Required: No

Type: Integer

Update requires: No interruption