Package software.amazon.awscdk.services.batch

Interface CfnComputeEnvironment.LaunchTemplateSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComputeEnvironment.LaunchTemplateSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnComputeEnvironment

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

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.

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.*;
 LaunchTemplateSpecificationProperty launchTemplateSpecificationProperty = LaunchTemplateSpecificationProperty.builder()
         .launchTemplateId("launchTemplateId")
         .launchTemplateName("launchTemplateName")
         .overrides(List.of(LaunchTemplateSpecificationOverrideProperty.builder()
                 .launchTemplateId("launchTemplateId")
                 .launchTemplateName("launchTemplateName")
                 .targetInstanceTypes(List.of("targetInstanceTypes"))
                 .userdataType("userdataType")
                 .version("version")
                 .build()))
         .userdataType("userdataType")
         .version("version")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnComputeEnvironment.LaunchTemplateSpecificationProperty.Builder	builder()
default String	getLaunchTemplateId()	The ID of the launch template.
default String	getLaunchTemplateName()	The name of the launch template.
default Object	getOverrides()	A launch template to use in place of the default launch template.
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.

See Also:

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

getLaunchTemplateName

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

The name of the launch template.

See Also:

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

getOverrides

@Stability(Stable)
@Nullable
default Object getOverrides()

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty>

See Also:

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

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-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-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-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-version

builder

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

Returns:

a CfnComputeEnvironment.LaunchTemplateSpecificationProperty.Builder of CfnComputeEnvironment.LaunchTemplateSpecificationProperty