Struct LaunchTemplateSpecificationOverride

#[non_exhaustive]
pub struct LaunchTemplateSpecificationOverride {
    pub launch_template_id: Option<String>,
    pub launch_template_name: Option<String>,
    pub version: Option<String>,
    pub target_instance_types: Option<Vec<String>>,
}

An object that represents 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.

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.

You can define up to ten (10) overrides for each compute environment.

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

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

launch_template_id: Option<String>

The ID of the launch template.

Note: If you specify the launchTemplateId you can't specify the launchTemplateName as well.

launch_template_name: Option<String>

The name of the launch template.

Note: If you specify the launchTemplateName you can't specify the launchTemplateId as well.

version: Option<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

target_instance_types: Option<Vec<String>>

The instance type or family that this override launch template should be applied to.

This parameter is required when defining a launch template override.

Information included in this parameter must meet the following requirements:

• Must be a valid Amazon EC2 instance type or family.

• optimal isn't allowed.

• targetInstanceTypes can target only instance types and families that are included within the ComputeResource.instanceTypes set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes \[m5, g5\], targetInstanceTypes can include \[m5.2xlarge\] and \[m5.large\] but not \[c5.large\].

• targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.

Implementations

impl LaunchTemplateSpecificationOverride

pub fn launch_template_id(&self) -> Option<&str>

The ID of the launch template.

Note: If you specify the launchTemplateId you can't specify the launchTemplateName as well.

pub fn launch_template_name(&self) -> Option<&str>

The name of the launch template.

Note: If you specify the launchTemplateName you can't specify the launchTemplateId as well.

pub fn version(&self) -> Option<&str>

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

pub fn target_instance_types(&self) -> &[String]

The instance type or family that this override launch template should be applied to.

This parameter is required when defining a launch template override.

Information included in this parameter must meet the following requirements:

• Must be a valid Amazon EC2 instance type or family.

• optimal isn't allowed.

• targetInstanceTypes can target only instance types and families that are included within the ComputeResource.instanceTypes set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes \[m5, g5\], targetInstanceTypes can include \[m5.2xlarge\] and \[m5.large\] but not \[c5.large\].

• targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_instance_types.is_none().

impl LaunchTemplateSpecificationOverride

pub fn builder() -> LaunchTemplateSpecificationOverrideBuilder

Creates a new builder-style object to manufacture LaunchTemplateSpecificationOverride.

Trait Implementations

impl Clone for LaunchTemplateSpecificationOverride

fn clone(&self) -> LaunchTemplateSpecificationOverride

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LaunchTemplateSpecificationOverride

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for LaunchTemplateSpecificationOverride

fn eq(&self, other: &LaunchTemplateSpecificationOverride) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LaunchTemplateSpecificationOverride