Interface LaunchTemplateSpecificationOverride.Builder

All Superinterfaces:
Buildable, CopyableBuilder<LaunchTemplateSpecificationOverride.Builder,LaunchTemplateSpecificationOverride>, SdkBuilder<LaunchTemplateSpecificationOverride.Builder,LaunchTemplateSpecificationOverride>, SdkPojo
Enclosing class:
LaunchTemplateSpecificationOverride
@Mutable @NotThreadSafe public static interface LaunchTemplateSpecificationOverride.Builder extends SdkPojo, CopyableBuilder<LaunchTemplateSpecificationOverride.Builder,LaunchTemplateSpecificationOverride>

  • Method Details

    • launchTemplateId

      LaunchTemplateSpecificationOverride.Builder launchTemplateId(String launchTemplateId)

      The ID of the launch template.

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

      Parameters:
      launchTemplateId - The ID of the launch template.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchTemplateName

      LaunchTemplateSpecificationOverride.Builder launchTemplateName(String launchTemplateName)

      The name of the launch template.

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

      Parameters:
      launchTemplateName - The name of the launch template.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      LaunchTemplateSpecificationOverride.Builder version(String 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 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

      Parameters:
      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 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetInstanceTypes

      LaunchTemplateSpecificationOverride.Builder targetInstanceTypes(Collection<String> targetInstanceTypes)

      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.

      Parameters:
      targetInstanceTypes - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetInstanceTypes

      LaunchTemplateSpecificationOverride.Builder targetInstanceTypes(String... targetInstanceTypes)

      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.

      Parameters:
      targetInstanceTypes - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userdataType

      LaunchTemplateSpecificationOverride.Builder userdataType(String 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 choose EKS_NODEADM.

      Parameters:
      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 choose EKS_NODEADM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userdataType

      LaunchTemplateSpecificationOverride.Builder userdataType(UserdataType 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 choose EKS_NODEADM.

      Parameters:
      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 choose EKS_NODEADM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: