Package software.amazon.awscdk.services.batch

Interface CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty.Jsii$Proxy

Enclosing class:

CfnComputeEnvironment

@Stability(Stable)
public static interface CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 LaunchTemplateSpecificationOverrideProperty launchTemplateSpecificationOverrideProperty = LaunchTemplateSpecificationOverrideProperty.builder()
         .launchTemplateId("launchTemplateId")
         .launchTemplateName("launchTemplateName")
         .targetInstanceTypes(List.of("targetInstanceTypes"))
         .userdataType("userdataType")
         .version("version")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty.Builder	A builder for CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty
static final class	CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty.Jsii$Proxy	An implementation for CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty

Method Summary

Modifier and Type	Method	Description
static CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty.Builder	builder()
default String	getLaunchTemplateId()	The ID of the launch template.
default String	getLaunchTemplateName()	The name of the launch template.
default List<String>	getTargetInstanceTypes()	The instance type or family that this override launch template should be applied to.
default String	getUserdataType()	The EKS node initialization process to use.
default String	getVersion()	The version number of the launch template, $Default , or $Latest .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLaunchTemplateId

@Stability(Stable)
@Nullable
default String getLaunchTemplateId()

The ID of the launch template.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html#cfn-batch-computeenvironment-launchtemplatespecificationoverride-launchtemplateid

getLaunchTemplateName

@Stability(Stable)
@Nullable
default String getLaunchTemplateName()

The name of the launch template.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html#cfn-batch-computeenvironment-launchtemplatespecificationoverride-launchtemplatename

getTargetInstanceTypes

@Stability(Stable)
@Nullable
default List<String> getTargetInstanceTypes()

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.
• The following AWS Batch InstanceTypes are not allowed: optimal , default_x86_64 , and default_arm64 .
• 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html#cfn-batch-computeenvironment-launchtemplatespecificationoverride-targetinstancetypes

getUserdataType

@Stability(Stable)
@Nullable
default String getUserdataType()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html#cfn-batch-computeenvironment-launchtemplatespecificationoverride-userdatatype

getVersion

@Stability(Stable)
@Nullable
default String getVersion()

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, 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html#cfn-batch-computeenvironment-launchtemplatespecificationoverride-version

builder

@Stability(Stable)
static CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty.Builder builder()

Returns:

a CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty.Builder of CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty