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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/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.

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

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) 


6575
6576
6577
6578
6579
6580
6581
6582
6583
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 6575

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

#launch_template_name ⇒ String

The name of the launch template.

Returns:

  • (String) 


6575
6576
6577
6578
6579
6580
6581
6582
6583
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 6575

class LaunchTemplateSpecification < Struct.new(
  :launch_template_id,
  :launch_template_name,
  :version,
  :overrides,
  :userdata_type)
  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.

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.

Returns:



6575
6576
6577
6578
6579
6580
6581
6582
6583
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 6575

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

#userdata_type ⇒ String

The EKS node initialization process to use. You only need to specify this value if you are using a custom AMI. The default value is EKS_BOOTSTRAP_SH. If imageType is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you must choose EKS_NODEADM.

Returns:

  • (String) 


6575
6576
6577
6578
6579
6580
6581
6582
6583
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 6575

class LaunchTemplateSpecification < Struct.new(
  :launch_template_id,
  :launch_template_name,
  :version,
  :overrides,
  :userdata_type)
  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

Returns:

  • (String) 


6575
6576
6577
6578
6579
6580
6581
6582
6583
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 6575

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