Class LaunchTemplateSpecificationOverride

java.lang.Object
software.amazon.awssdk.services.batch.model.LaunchTemplateSpecificationOverride
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LaunchTemplateSpecificationOverride.Builder,LaunchTemplateSpecificationOverride>
@Generated("software.amazon.awssdk:codegen") public final class LaunchTemplateSpecificationOverride extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LaunchTemplateSpecificationOverride.Builder,LaunchTemplateSpecificationOverride>

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.

See Also:

  • Method Details

    • launchTemplateId

      public final String launchTemplateId()

      The ID of the launch template.

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

      Returns:
      The ID of the launch template.

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

    • launchTemplateName

      public final String launchTemplateName()

      The name of the launch template.

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

      Returns:
      The name of the launch template.

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

    • version

      public final 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

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

    • hasTargetInstanceTypes

      public final boolean hasTargetInstanceTypes()
      For responses, this returns true if the service returned a value for the TargetInstanceTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • targetInstanceTypes

      public final List<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.

      • The following 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetInstanceTypes() method.

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

    • userdataType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, userdataType will return UserdataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userdataTypeAsString().

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

    • userdataTypeAsString

      public final String userdataTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, userdataType will return UserdataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userdataTypeAsString().

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

    • toBuilder

      public LaunchTemplateSpecificationOverride.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LaunchTemplateSpecificationOverride.Builder,LaunchTemplateSpecificationOverride>
      Returns:
      a builder for type T

    • builder

      public static LaunchTemplateSpecificationOverride.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LaunchTemplateSpecificationOverride.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.