Class: Aws::Batch::Types::LaunchTemplateSpecification

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-batch/types.rb

Overview

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 markdown=“1”> This object isn’t applicable to jobs that are running on Fargate resources.

</note>

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#launch_template_id ⇒ String

The ID of the launch template.

Returns:

  • (String) 


5605
5606
5607
5608
5609
5610
5611
5612
 
# File 'lib/aws-sdk-batch/types.rb', line 5605

class LaunchTemplateSpecification < Struct.new(
  :launch_template_id,
  :launch_template_name,
  :version,
  :overrides)
  SENSITIVE = []
  include Aws::Structure
end

#launch_template_name ⇒ String

The name of the launch template.

Returns:

  • (String) 


5605
5606
5607
5608
5609
5610
5611
5612
 
# File 'lib/aws-sdk-batch/types.rb', line 5605

class LaunchTemplateSpecification < Struct.new(
  :launch_template_id,
  :launch_template_name,
  :version,
  :overrides)
  SENSITIVE = []
  include Aws::Structure
end

#overrides ⇒ Array<Types::LaunchTemplateSpecificationOverride>

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 markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html

Returns:



5605
5606
5607
5608
5609
5610
5611
5612
 
# File 'lib/aws-sdk-batch/types.rb', line 5605

class LaunchTemplateSpecification < Struct.new(
  :launch_template_id,
  :launch_template_name,
  :version,
  :overrides)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

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.

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, 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 *Batch User Guide*.

Default: ‘$Default`

Latest: ‘$Latest`

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (String) 


5605
5606
5607
5608
5609
5610
5611
5612
 
# File 'lib/aws-sdk-batch/types.rb', line 5605

class LaunchTemplateSpecification < Struct.new(
  :launch_template_id,
  :launch_template_name,
  :version,
  :overrides)
  SENSITIVE = []
  include Aws::Structure
end