AWS::Batch::ComputeEnvironment LaunchTemplateSpecification - AWS CloudFormation
SyntaxPropertiesSee also

AWS::Batch::ComputeEnvironment LaunchTemplateSpecification

An object that represents a launch template that's associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.

If security groups are specified using both the securityGroupIds parameter of CreateComputeEnvironment and the launch template, the values in the securityGroupIds parameter of CreateComputeEnvironment will be used.

Note

This object isn't applicable to jobs that are running on Fargate resources.

Syntax

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

JSON

{
  "LaunchTemplateId" : String,
  "LaunchTemplateName" : String,
  "Overrides" : [ LaunchTemplateSpecificationOverride, ... ],
  "Version" : String
}

Properties

LaunchTemplateId

The ID of the launch template.

Required: No

Type: String

Update requires: Some interruptions

LaunchTemplateName

The name of the launch template.

Required: No

Type: String

Update requires: Some interruptions

Overrides

A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.

You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.

Note

To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.

Required: No

Type: Array of LaunchTemplateSpecificationOverride

Update requires: Some interruptions

Version

The version number of the launch template, $Default, or $Latest.

If the value is $Default, the default version of the launch template is used. If the value is $Latest, the latest version of the launch template is used.

Important

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true. During an infrastructure update, if either $Default or $Latest is specified, AWS Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the AWS Batch User Guide.

Default: $Default

Latest: $Latest

Required: No

Type: String

Update requires: Some interruptions

See also