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

Class LaunchTemplateSpecification

    • 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, $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

      • hasOverrides

        public final boolean hasOverrides()
        For responses, this returns true if the service returned a value for the Overrides 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.

      • overrides

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

        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 hasOverrides() method.

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

      • hashCode

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

      • equals

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

      • 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)