/AWS1/CL_BTCLAUNCHTEMPLATESPEC¶
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.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_launchtemplateid TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The ID of the launch template.
iv_launchtemplatename TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The name of the launch template.
iv_version TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
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
updateToLatestImageVersionparameter for the compute environment is set totrue. During an infrastructure update, if either$Defaultor$Latestis 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:
$DefaultLatest:
$Latest
it_overrides TYPE /AWS1/CL_BTCLAUNCHTMPLSPECOV00=>TT_LAUNCHTMPLSPECOVERRIDELIST TT_LAUNCHTMPLSPECOVERRIDELIST¶
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
overridesparameter when submitting theUpdateComputeEnvironmentAPI operation.
iv_userdatatype TYPE /AWS1/BTCUSERDATATYPE /AWS1/BTCUSERDATATYPE¶
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 chooseEKS_NODEADM.
Queryable Attributes¶
launchTemplateId¶
The ID of the launch template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LAUNCHTEMPLATEID() |
Getter for LAUNCHTEMPLATEID, with configurable default |
ASK_LAUNCHTEMPLATEID() |
Getter for LAUNCHTEMPLATEID w/ exceptions if field has no va |
HAS_LAUNCHTEMPLATEID() |
Determine if LAUNCHTEMPLATEID has a value |
launchTemplateName¶
The name of the launch template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LAUNCHTEMPLATENAME() |
Getter for LAUNCHTEMPLATENAME, with configurable default |
ASK_LAUNCHTEMPLATENAME() |
Getter for LAUNCHTEMPLATENAME w/ exceptions if field has no |
HAS_LAUNCHTEMPLATENAME() |
Determine if LAUNCHTEMPLATENAME has a value |
version¶
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
updateToLatestImageVersionparameter for the compute environment is set totrue. During an infrastructure update, if either$Defaultor$Latestis 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:
$DefaultLatest:
$Latest
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSION() |
Getter for VERSION, with configurable default |
ASK_VERSION() |
Getter for VERSION w/ exceptions if field has no value |
HAS_VERSION() |
Determine if VERSION has a value |
overrides¶
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
overridesparameter when submitting theUpdateComputeEnvironmentAPI operation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OVERRIDES() |
Getter for OVERRIDES, with configurable default |
ASK_OVERRIDES() |
Getter for OVERRIDES w/ exceptions if field has no value |
HAS_OVERRIDES() |
Determine if OVERRIDES has a value |
userdataType¶
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 chooseEKS_NODEADM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERDATATYPE() |
Getter for USERDATATYPE, with configurable default |
ASK_USERDATATYPE() |
Getter for USERDATATYPE w/ exceptions if field has no value |
HAS_USERDATATYPE() |
Determine if USERDATATYPE has a value |