java.lang.Object
- software.amazon.awssdk.services.ec2.model.ResponseLaunchTemplateData

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ResponseLaunchTemplateData.Builder,ResponseLaunchTemplateData>

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

The information for a launch template.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ResponseLaunchTemplateData.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<LaunchTemplateBlockDeviceMapping>`	`blockDeviceMappings()`	The block device mappings.
`static ResponseLaunchTemplateData.Builder`	`builder()`
`LaunchTemplateCapacityReservationSpecificationResponse`	`capacityReservationSpecification()`	Information about the Capacity Reservation targeting option.
`LaunchTemplateCpuOptions`	`cpuOptions()`	The CPU options for the instance.
`CreditSpecification`	`creditSpecification()`	The credit option for CPU usage of the instance.
`Boolean`	`disableApiStop()`	Indicates whether the instance is enabled for stop protection.
`Boolean`	`disableApiTermination()`	If set to `true`, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
`Boolean`	`ebsOptimized()`	Indicates whether the instance is optimized for Amazon EBS I/O.
`List<ElasticGpuSpecificationResponse>`	`elasticGpuSpecifications()`	The elastic GPU specification.
`List<LaunchTemplateElasticInferenceAcceleratorResponse>`	`elasticInferenceAccelerators()`	An elastic inference accelerator to associate with the instance.
`LaunchTemplateEnclaveOptions`	`enclaveOptions()`	Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBlockDeviceMappings()`	For responses, this returns true if the service returned a value for the BlockDeviceMappings property.
`boolean`	`hasElasticGpuSpecifications()`	For responses, this returns true if the service returned a value for the ElasticGpuSpecifications property.
`boolean`	`hasElasticInferenceAccelerators()`	For responses, this returns true if the service returned a value for the ElasticInferenceAccelerators property.
`int`	`hashCode()`
`boolean`	`hasLicenseSpecifications()`	For responses, this returns true if the service returned a value for the LicenseSpecifications property.
`boolean`	`hasNetworkInterfaces()`	For responses, this returns true if the service returned a value for the NetworkInterfaces property.
`boolean`	`hasSecurityGroupIds()`	For responses, this returns true if the service returned a value for the SecurityGroupIds property.
`boolean`	`hasSecurityGroups()`	For responses, this returns true if the service returned a value for the SecurityGroups property.
`boolean`	`hasTagSpecifications()`	For responses, this returns true if the service returned a value for the TagSpecifications property.
`LaunchTemplateHibernationOptions`	`hibernationOptions()`	Indicates whether an instance is configured for hibernation.
`LaunchTemplateIamInstanceProfileSpecification`	`iamInstanceProfile()`	The IAM instance profile.
`String`	`imageId()`	The ID of the AMI or a Systems Manager parameter.
`ShutdownBehavior`	`instanceInitiatedShutdownBehavior()`	Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
`String`	`instanceInitiatedShutdownBehaviorAsString()`	Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
`LaunchTemplateInstanceMarketOptions`	`instanceMarketOptions()`	The market (purchasing) option for the instances.
`InstanceRequirements`	`instanceRequirements()`	The attributes for the instance types.
`InstanceType`	`instanceType()`	The instance type.
`String`	`instanceTypeAsString()`	The instance type.
`String`	`kernelId()`	The ID of the kernel, if applicable.
`String`	`keyName()`	The name of the key pair.
`List<LaunchTemplateLicenseConfiguration>`	`licenseSpecifications()`	The license configurations.
`LaunchTemplateInstanceMaintenanceOptions`	`maintenanceOptions()`	The maintenance options for your instance.
`LaunchTemplateInstanceMetadataOptions`	`metadataOptions()`	The metadata options for the instance.
`LaunchTemplatesMonitoring`	`monitoring()`	The monitoring for the instance.
`List<LaunchTemplateInstanceNetworkInterfaceSpecification>`	`networkInterfaces()`	The network interfaces.
`LaunchTemplatePlacement`	`placement()`	The placement of the instance.
`LaunchTemplatePrivateDnsNameOptions`	`privateDnsNameOptions()`	The options for the instance hostname.
`String`	`ramDiskId()`	The ID of the RAM disk, if applicable.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()`	The security group IDs.
`List<String>`	`securityGroups()`	The security group names.
`static Class<? extends ResponseLaunchTemplateData.Builder>`	`serializableBuilderClass()`
`List<LaunchTemplateTagSpecification>`	`tagSpecifications()`	The tags that are applied to the resources that are created during instance launch.
`ResponseLaunchTemplateData.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userData()`	The user data for the instance.

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
  - kernelId
```
public final String kernelId()
```
    The ID of the kernel, if applicable.
    
    Returns:
    
    The ID of the kernel, if applicable.
  - ebsOptimized
```
public final Boolean ebsOptimized()
```
    Indicates whether the instance is optimized for Amazon EBS I/O.
    
    Returns:
    
    Indicates whether the instance is optimized for Amazon EBS I/O.
  - iamInstanceProfile
```
public final LaunchTemplateIamInstanceProfileSpecification iamInstanceProfile()
```
    The IAM instance profile.
    
    Returns:
    
    The IAM instance profile.
  - hasBlockDeviceMappings
```
public final boolean hasBlockDeviceMappings()
```
    For responses, this returns true if the service returned a value for the BlockDeviceMappings 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.
  - blockDeviceMappings
```
public final List<LaunchTemplateBlockDeviceMapping> blockDeviceMappings()
```
    The block device mappings.
    
    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 hasBlockDeviceMappings() method.
    
    Returns:
    
    The block device mappings.
  - hasNetworkInterfaces
```
public final boolean hasNetworkInterfaces()
```
    For responses, this returns true if the service returned a value for the NetworkInterfaces 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.
  - networkInterfaces
```
public final List<LaunchTemplateInstanceNetworkInterfaceSpecification> networkInterfaces()
```
    The network interfaces.
    
    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 hasNetworkInterfaces() method.
    
    Returns:
    
    The network interfaces.
  - imageId
```
public final String imageId()
```
    The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will resolve to the ID of the AMI at instance launch.
    
    The value depends on what you specified in the request. The possible values are:
    
    If an AMI ID was specified in the request, then this is the AMI ID.
    
    If a Systems Manager parameter was specified in the request, and ResolveAlias was configured as true, then this is the AMI ID that the parameter is mapped to in the Parameter Store.
    
    If a Systems Manager parameter was specified in the request, and ResolveAlias was configured as false, then this is the parameter value.
    
    For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
    Returns:
    
    The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will resolve to the ID of the AMI at instance launch.
    
    The value depends on what you specified in the request. The possible values are:
    
    If an AMI ID was specified in the request, then this is the AMI ID.
    
    If a Systems Manager parameter was specified in the request, and ResolveAlias was configured as true, then this is the AMI ID that the parameter is mapped to in the Parameter Store.
    
    If a Systems Manager parameter was specified in the request, and ResolveAlias was configured as false, then this is the parameter value.
    
    For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
  - instanceType
```
public final InstanceType instanceType()
```
    The instance type.
    
    If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().
    
    Returns:
    
    The instance type.
    
    See Also:
    
    InstanceType
  - instanceTypeAsString
```
public final String instanceTypeAsString()
```
    The instance type.
    
    If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().
    
    Returns:
    
    The instance type.
    
    See Also:
    
    InstanceType
  - keyName
```
public final String keyName()
```
    The name of the key pair.
    
    Returns:
    
    The name of the key pair.
  - monitoring
```
public final LaunchTemplatesMonitoring monitoring()
```
    The monitoring for the instance.
    
    Returns:
    
    The monitoring for the instance.
  - placement
```
public final LaunchTemplatePlacement placement()
```
    The placement of the instance.
    
    Returns:
    
    The placement of the instance.
  - ramDiskId
```
public final String ramDiskId()
```
    The ID of the RAM disk, if applicable.
    
    Returns:
    
    The ID of the RAM disk, if applicable.
  - disableApiTermination
```
public final Boolean disableApiTermination()
```
    If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
    
    Returns:
    
    If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
  - instanceInitiatedShutdownBehavior
```
public final ShutdownBehavior instanceInitiatedShutdownBehavior()
```
    Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
    
    If the service returns an enum value that is not available in the current SDK version, instanceInitiatedShutdownBehavior will return ShutdownBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceInitiatedShutdownBehaviorAsString().
    
    Returns:
    
    Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
    
    See Also:
    
    ShutdownBehavior
  - instanceInitiatedShutdownBehaviorAsString
```
public final String instanceInitiatedShutdownBehaviorAsString()
```
    Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
    
    If the service returns an enum value that is not available in the current SDK version, instanceInitiatedShutdownBehavior will return ShutdownBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceInitiatedShutdownBehaviorAsString().
    
    Returns:
    
    Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
    
    See Also:
    
    ShutdownBehavior
  - userData
```
public final String userData()
```
    The user data for the instance.
    
    Returns:
    
    The user data for the instance.
  - hasTagSpecifications
```
public final boolean hasTagSpecifications()
```
    For responses, this returns true if the service returned a value for the TagSpecifications 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.
  - tagSpecifications
```
public final List<LaunchTemplateTagSpecification> tagSpecifications()
```
    The tags that are applied to the resources that are created during instance launch.
    
    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 hasTagSpecifications() method.
    
    Returns:
    
    The tags that are applied to the resources that are created during instance launch.
  - hasElasticGpuSpecifications
```
public final boolean hasElasticGpuSpecifications()
```
    For responses, this returns true if the service returned a value for the ElasticGpuSpecifications 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.
  - elasticGpuSpecifications
```
public final List<ElasticGpuSpecificationResponse> elasticGpuSpecifications()
```
    The elastic GPU specification.
    
    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 hasElasticGpuSpecifications() method.
    
    Returns:
    
    The elastic GPU specification.
  - hasElasticInferenceAccelerators
```
public final boolean hasElasticInferenceAccelerators()
```
    For responses, this returns true if the service returned a value for the ElasticInferenceAccelerators 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.
  - elasticInferenceAccelerators
```
public final List<LaunchTemplateElasticInferenceAcceleratorResponse> elasticInferenceAccelerators()
```
    An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
    
    You cannot specify accelerators from different generations in the same request.
    
    Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
    
    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 hasElasticInferenceAccelerators() method.
    
    Returns:
    
    An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
    
    You cannot specify accelerators from different generations in the same request.
    
    Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
  - hasSecurityGroupIds
```
public final boolean hasSecurityGroupIds()
```
    For responses, this returns true if the service returned a value for the SecurityGroupIds 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.
  - securityGroupIds
```
public final List<String> securityGroupIds()
```
    The security group IDs.
    
    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 hasSecurityGroupIds() method.
    
    Returns:
    
    The security group IDs.
  - hasSecurityGroups
```
public final boolean hasSecurityGroups()
```
    For responses, this returns true if the service returned a value for the SecurityGroups 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.
  - securityGroups
```
public final List<String> securityGroups()
```
    The security group names.
    
    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 hasSecurityGroups() method.
    
    Returns:
    
    The security group names.
  - instanceMarketOptions
```
public final LaunchTemplateInstanceMarketOptions instanceMarketOptions()
```
    The market (purchasing) option for the instances.
    
    Returns:
    
    The market (purchasing) option for the instances.
  - creditSpecification
```
public final CreditSpecification creditSpecification()
```
    The credit option for CPU usage of the instance.
    
    Returns:
    
    The credit option for CPU usage of the instance.
  - cpuOptions
```
public final LaunchTemplateCpuOptions cpuOptions()
```
    The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.
  - capacityReservationSpecification
```
public final LaunchTemplateCapacityReservationSpecificationResponse capacityReservationSpecification()
```
    Information about the Capacity Reservation targeting option.
    
    Returns:
    
    Information about the Capacity Reservation targeting option.
  - hasLicenseSpecifications
```
public final boolean hasLicenseSpecifications()
```
    For responses, this returns true if the service returned a value for the LicenseSpecifications 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.
  - licenseSpecifications
```
public final List<LaunchTemplateLicenseConfiguration> licenseSpecifications()
```
    The license configurations.
    
    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 hasLicenseSpecifications() method.
    
    Returns:
    
    The license configurations.
  - hibernationOptions
```
public final LaunchTemplateHibernationOptions hibernationOptions()
```
    Indicates whether an instance is configured for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Indicates whether an instance is configured for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.
  - metadataOptions
```
public final LaunchTemplateInstanceMetadataOptions metadataOptions()
```
    The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.
  - enclaveOptions
```
public final LaunchTemplateEnclaveOptions enclaveOptions()
```
    Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
    
    Returns:
    
    Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
  - instanceRequirements
```
public final InstanceRequirements instanceRequirements()
```
    The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
    
    If you specify InstanceRequirements, you can't specify InstanceTypes.
    
    Returns:
    
    The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
    
    If you specify InstanceRequirements, you can't specify InstanceTypes.
  - privateDnsNameOptions
```
public final LaunchTemplatePrivateDnsNameOptions privateDnsNameOptions()
```
    The options for the instance hostname.
    
    Returns:
    
    The options for the instance hostname.
  - maintenanceOptions
```
public final LaunchTemplateInstanceMaintenanceOptions maintenanceOptions()
```
    The maintenance options for your instance.
    
    Returns:
    
    The maintenance options for your instance.
  - disableApiStop
```
public final Boolean disableApiStop()
```
    Indicates whether the instance is enabled for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Indicates whether the instance is enabled for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.
  - toBuilder
```
public ResponseLaunchTemplateData.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ResponseLaunchTemplateData.Builder,ResponseLaunchTemplateData>
  - builder
```
public static ResponseLaunchTemplateData.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ResponseLaunchTemplateData.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

Class ResponseLaunchTemplateData

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

kernelId

ebsOptimized

iamInstanceProfile

hasBlockDeviceMappings

blockDeviceMappings

hasNetworkInterfaces

networkInterfaces

imageId

instanceType

instanceTypeAsString

keyName

monitoring

placement

ramDiskId

disableApiTermination

instanceInitiatedShutdownBehavior

instanceInitiatedShutdownBehaviorAsString

userData

hasTagSpecifications

tagSpecifications

hasElasticGpuSpecifications

elasticGpuSpecifications

hasElasticInferenceAccelerators

elasticInferenceAccelerators

hasSecurityGroupIds

securityGroupIds

hasSecurityGroups

securityGroups

instanceMarketOptions

creditSpecification

cpuOptions

capacityReservationSpecification

hasLicenseSpecifications

licenseSpecifications

hibernationOptions

metadataOptions

enclaveOptions

instanceRequirements

privateDnsNameOptions

maintenanceOptions

disableApiStop

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields