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(value="software.amazon.awssdk:codegen")
public final class LaunchTemplateSpecification
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LaunchTemplateSpecification.Builder,LaunchTemplateSpecification>

An object representing a launch template 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 running on Fargate resources.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LaunchTemplateSpecification.Builder

Method Summary

Modifier and Type	Method and Description
static LaunchTemplateSpecification.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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() Take this object and create a builder that contains all of the current property values of this object.
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

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.

After the compute environment is created, the launch template version used will not be changed, even if the $Default or $Latest version for the launch template is updated. To use a new launch template version, create a new compute environment, add the new compute environment to the existing job queue, remove the old compute environment from the job queue, and delete the old compute environment.

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.

After the compute environment is created, the launch template version used will not be changed, even if the $Default or $Latest version for the launch template is updated. To use a new launch template version, create a new compute environment, add the new compute environment to the existing job queue, remove the old compute environment from the job queue, and delete the old compute environment.

Default: $Default.

toBuilder

public LaunchTemplateSpecification.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<LaunchTemplateSpecification.Builder,LaunchTemplateSpecification>

Returns:

a builder for type T

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)

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.