Interface LaunchTemplateSpecification.Builder

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

  • Method Details

    • launchTemplateId

      LaunchTemplateSpecification.Builder launchTemplateId(String launchTemplateId)

      The ID of the launch template.

      Parameters:
      launchTemplateId - The ID of the launch template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchTemplateName

      LaunchTemplateSpecification.Builder launchTemplateName(String launchTemplateName)

      The name of the launch template.

      Parameters:
      launchTemplateName - The name of the launch template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      LaunchTemplateSpecification.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.

    • overrides

      LaunchTemplateSpecification.Builder overrides(Collection<LaunchTemplateSpecificationOverride> 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 overrides parameter when submitting the UpdateComputeEnvironment API operation.

      Parameters:
      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 overrides parameter when submitting the UpdateComputeEnvironment API operation.

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

    • overrides

      LaunchTemplateSpecification.Builder overrides(LaunchTemplateSpecificationOverride... 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 overrides parameter when submitting the UpdateComputeEnvironment API operation.

      Parameters:
      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 overrides parameter when submitting the UpdateComputeEnvironment API operation.

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

    • overrides

      LaunchTemplateSpecification.Builder overrides(Consumer<LaunchTemplateSpecificationOverride.Builder>... 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 overrides parameter when submitting the UpdateComputeEnvironment API operation.

      This is a convenience method that creates an instance of the LaunchTemplateSpecificationOverride.Builder avoiding the need to create one manually via LaunchTemplateSpecificationOverride.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overrides(List<LaunchTemplateSpecificationOverride>).

      Parameters:
      overrides - a consumer that will call methods on LaunchTemplateSpecificationOverride.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userdataType

      LaunchTemplateSpecification.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

      LaunchTemplateSpecification.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: