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
Creates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Batch::ServiceEnvironment", "Properties" : { "CapacityLimits" :
[ CapacityLimit, ... ]
, "ServiceEnvironmentName" :String
, "ServiceEnvironmentType" :String
, "State" :String
, "Tags" :{
} }Key
:Value
, ...}
YAML
Type: AWS::Batch::ServiceEnvironment Properties: CapacityLimits:
- CapacityLimit
ServiceEnvironmentName:String
ServiceEnvironmentType:String
State:String
Tags:
Key
:Value
Properties
CapacityLimits
-
The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.
Required: Yes
Type: Array of CapacityLimit
Update requires: No interruption
ServiceEnvironmentName
-
The name of the service environment.
Required: No
Type: String
Update requires: Replacement
ServiceEnvironmentType
-
The type of service environment. For SageMaker Training jobs, this value is
SAGEMAKER_TRAINING
.Required: Yes
Type: String
Allowed values:
SAGEMAKER_TRAINING
Update requires: Replacement
State
-
The state of the service environment. Valid values are
ENABLED
andDISABLED
.Required: No
Type: String
Allowed values:
ENABLED | DISABLED
Update requires: No interruption
-
The tags associated with the service environment. Each tag consists of a key and an optional value. For more information, see Tagging your Amazon Batch resources.
Required: No
Type: Object of String
Pattern:
.*
Update requires: No interruption
Return values
Ref
Fn::GetAtt
ServiceEnvironmentArn
-
The Amazon Resource Name (ARN) of the service environment.