Struct LaunchTemplateSpecification

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

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.

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.

launch_template_name: Option<String>

The name of the launch template.

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

overrides: Option<Vec<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.

Implementations

impl LaunchTemplateSpecification

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

The ID of the launch template.

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

The name of the launch template.

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 overrides(&self) -> &[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.

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

impl LaunchTemplateSpecification

pub fn builder() -> LaunchTemplateSpecificationBuilder

Creates a new builder-style object to manufacture LaunchTemplateSpecification.

Trait Implementations

impl Clone for LaunchTemplateSpecification

fn clone(&self) -> LaunchTemplateSpecification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LaunchTemplateSpecification

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

Formats the value using the given formatter.

impl PartialEq for LaunchTemplateSpecification

fn eq(&self, other: &LaunchTemplateSpecification) -> 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 LaunchTemplateSpecification