Package software.amazon.awssdk.services.batch.model

Class LaunchTemplateSpecification

java.lang.Object

software.amazon.awssdk.services.batch.model.LaunchTemplateSpecification

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LaunchTemplateSpecification.Builder,LaunchTemplateSpecification>

@Generated("software.amazon.awssdk:codegen")
public final class LaunchTemplateSpecification
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LaunchTemplateSpecification.Builder,LaunchTemplateSpecification>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LaunchTemplateSpecification.Builder

Method Summary

Modifier and Type	Method	Description
static LaunchTemplateSpecification.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	launchTemplateId()	The ID of the launch template.
String	launchTemplateName()	The name of the launch template.
List<SdkField<?>>	sdkFields()
static Class<? extends LaunchTemplateSpecification.Builder>	serializableBuilderClass()
LaunchTemplateSpecification.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	version()	The version number of the launch template, $Latest, or $Default.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

launchTemplateId

public final String launchTemplateId()

The ID of the launch template.

Returns:

The ID of the launch template.

launchTemplateName

public final String launchTemplateName()

The name of the launch template.

Returns:

The name of the launch template.

version

public final String version()

The version number of the launch template, $Latest, or $Default.

If the value is $Latest, the latest version of the launch template is used. If the value is $Default, the default 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 $Latest or $Default 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.

Returns:

The version number of the launch template, $Latest, or $Default.

If the value is $Latest, the latest version of the launch template is used. If the value is $Default, the default 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 $Latest or $Default 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.

toBuilder

public LaunchTemplateSpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LaunchTemplateSpecification.Builder,LaunchTemplateSpecification>

builder

public static LaunchTemplateSpecification.Builder builder()

serializableBuilderClass

public static Class<? extends LaunchTemplateSpecification.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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