RequestLaunchTemplateData (AWS SDK for Java

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

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

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

The information to include in the launch template.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RequestLaunchTemplateData.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RequestLaunchTemplateData.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<LaunchTemplateBlockDeviceMappingRequest>`	`blockDeviceMappings()` The block device mapping.
`static RequestLaunchTemplateData.Builder`	`builder()`
`LaunchTemplateCapacityReservationSpecificationRequest`	`capacityReservationSpecification()` The Capacity Reservation targeting option.
`LaunchTemplateCpuOptionsRequest`	`cpuOptions()` The CPU options for the instance.
`CreditSpecificationRequest`	`creditSpecification()` The credit option for CPU usage of the instance.
`Boolean`	`disableApiTermination()` If you set this parameter to `true`, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
`Boolean`	`ebsOptimized()` Indicates whether the instance is optimized for Amazon EBS I/O.
`List<ElasticGpuSpecification>`	`elasticGpuSpecifications()` An elastic GPU to associate with the instance.
`List<LaunchTemplateElasticInferenceAccelerator>`	`elasticInferenceAccelerators()` The elastic inference accelerator for the instance.
`LaunchTemplateEnclaveOptionsRequest`	`enclaveOptions()` Indicates whether the instance is enabled for AWS Nitro Enclaves.
`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)`
`boolean`	`hasBlockDeviceMappings()` Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasElasticGpuSpecifications()` Returns true if the ElasticGpuSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasElasticInferenceAccelerators()` Returns true if the ElasticInferenceAccelerators property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasLicenseSpecifications()` Returns true if the LicenseSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasNetworkInterfaces()` Returns true if the NetworkInterfaces property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSecurityGroupIds()` Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSecurityGroups()` Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTagSpecifications()` Returns true if the TagSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`LaunchTemplateHibernationOptionsRequest`	`hibernationOptions()` Indicates whether an instance is enabled for hibernation.
`LaunchTemplateIamInstanceProfileSpecificationRequest`	`iamInstanceProfile()` The name or Amazon Resource Name (ARN) of an IAM instance profile.
`String`	`imageId()` The ID of the AMI.
`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).
`LaunchTemplateInstanceMarketOptionsRequest`	`instanceMarketOptions()` The market (purchasing) option for the instances.
`InstanceType`	`instanceType()` The instance type.
`String`	`instanceTypeAsString()` The instance type.
`String`	`kernelId()` The ID of the kernel.
`String`	`keyName()` The name of the key pair.
`List<LaunchTemplateLicenseConfigurationRequest>`	`licenseSpecifications()` The license configurations.
`LaunchTemplateInstanceMetadataOptionsRequest`	`metadataOptions()` The metadata options for the instance.
`LaunchTemplatesMonitoringRequest`	`monitoring()` The monitoring for the instance.
`List<LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>`	`networkInterfaces()` One or more network interfaces.
`LaunchTemplatePlacementRequest`	`placement()` The placement for the instance.
`String`	`ramDiskId()` The ID of the RAM disk.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` One or more security group IDs.
`List<String>`	`securityGroups()` [EC2-Classic, default VPC] One or more security group names.
`static Class<? extends RequestLaunchTemplateData.Builder>`	`serializableBuilderClass()`
`List<LaunchTemplateTagSpecificationRequest>`	`tagSpecifications()` The tags to apply to the resources during launch.
`RequestLaunchTemplateData.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`	`userData()` The Base64-encoded user data to make available to the instance.

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
  - kernelId
```
public final String kernelId()
```
    The ID of the kernel.
    
    We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    The ID of the kernel.
    
    We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.
  - ebsOptimized
```
public final Boolean ebsOptimized()
```
    Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
    
    Returns:
    
    Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
  - iamInstanceProfile
```
public final LaunchTemplateIamInstanceProfileSpecificationRequest iamInstanceProfile()
```
    The name or Amazon Resource Name (ARN) of an IAM instance profile.
    
    Returns:
    
    The name or Amazon Resource Name (ARN) of an IAM instance profile.
  - hasBlockDeviceMappings
```
public final boolean hasBlockDeviceMappings()
```
    Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - blockDeviceMappings
```
public final List<LaunchTemplateBlockDeviceMappingRequest> blockDeviceMappings()
```
    The block device mapping.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasBlockDeviceMappings() to see if a value was sent in this field.
    
    Returns:
    
    The block device mapping.
  - hasNetworkInterfaces
```
public final boolean hasNetworkInterfaces()
```
    Returns true if the NetworkInterfaces property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - networkInterfaces
```
public final List<LaunchTemplateInstanceNetworkInterfaceSpecificationRequest> networkInterfaces()
```
    One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasNetworkInterfaces() to see if a value was sent in this field.
    
    Returns:
    
    One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
  - imageId
```
public final String imageId()
```
    The ID of the AMI.
    
    Returns:
    
    The ID of the AMI.
  - instanceType
```
public final InstanceType instanceType()
```
    The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
    
    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. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
    
    See Also:
    
    InstanceType
  - instanceTypeAsString
```
public final String instanceTypeAsString()
```
    The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
    
    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. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
    
    See Also:
    
    InstanceType
  - keyName
```
public final String keyName()
```
    The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
    
    If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
    
    Returns:
    
    The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
    
    If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
  - monitoring
```
public final LaunchTemplatesMonitoringRequest monitoring()
```
    The monitoring for the instance.
    
    Returns:
    
    The monitoring for the instance.
  - placement
```
public final LaunchTemplatePlacementRequest placement()
```
    The placement for the instance.
    
    Returns:
    
    The placement for the instance.
  - ramDiskId
```
public final String ramDiskId()
```
    The ID of the RAM disk.
    
    We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    The ID of the RAM disk.
    
    We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.
  - disableApiTermination
```
public final Boolean disableApiTermination()
```
    If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
    
    Returns:
    
    If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
  - 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).
    
    Default: stop
    
    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).
    
    Default: stop
    
    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).
    
    Default: stop
    
    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).
    
    Default: stop
    
    See Also:
    
    ShutdownBehavior
  - userData
```
public final String userData()
```
    The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).
    
    Returns:
    
    The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).
  - hasTagSpecifications
```
public final boolean hasTagSpecifications()
```
    Returns true if the TagSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tagSpecifications
```
public final List<LaunchTemplateTagSpecificationRequest> tagSpecifications()
```
    The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTagSpecifications() to see if a value was sent in this field.
    
    Returns:
    
    The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
  - hasElasticGpuSpecifications
```
public final boolean hasElasticGpuSpecifications()
```
    Returns true if the ElasticGpuSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - elasticGpuSpecifications
```
public final List<ElasticGpuSpecification> elasticGpuSpecifications()
```
    An elastic GPU to associate with the instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasElasticGpuSpecifications() to see if a value was sent in this field.
    
    Returns:
    
    An elastic GPU to associate with the instance.
  - hasElasticInferenceAccelerators
```
public final boolean hasElasticInferenceAccelerators()
```
    Returns true if the ElasticInferenceAccelerators property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - elasticInferenceAccelerators
```
public final List<LaunchTemplateElasticInferenceAccelerator> elasticInferenceAccelerators()
```
    The elastic inference accelerator for the instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasElasticInferenceAccelerators() to see if a value was sent in this field.
    
    Returns:
    
    The elastic inference accelerator for the instance.
  - hasSecurityGroupIds
```
public final boolean hasSecurityGroupIds()
```
    Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - securityGroupIds
```
public final List<String> securityGroupIds()
```
    One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSecurityGroupIds() to see if a value was sent in this field.
    
    Returns:
    
    One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.
  - hasSecurityGroups
```
public final boolean hasSecurityGroups()
```
    Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - securityGroups
```
public final List<String> securityGroups()
```
    [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSecurityGroups() to see if a value was sent in this field.
    
    Returns:
    
    [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
  - instanceMarketOptions
```
public final LaunchTemplateInstanceMarketOptionsRequest instanceMarketOptions()
```
    The market (purchasing) option for the instances.
    
    Returns:
    
    The market (purchasing) option for the instances.
  - creditSpecification
```
public final CreditSpecificationRequest creditSpecification()
```
    The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances only.
    
    Returns:
    
    The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances only.
  - cpuOptions
```
public final LaunchTemplateCpuOptionsRequest 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 LaunchTemplateCapacityReservationSpecificationRequest capacityReservationSpecification()
```
    The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
    
    Returns:
    
    The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
  - hasLicenseSpecifications
```
public final boolean hasLicenseSpecifications()
```
    Returns true if the LicenseSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - licenseSpecifications
```
public final List<LaunchTemplateLicenseConfigurationRequest> licenseSpecifications()
```
    The license configurations.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasLicenseSpecifications() to see if a value was sent in this field.
    
    Returns:
    
    The license configurations.
  - hibernationOptions
```
public final LaunchTemplateHibernationOptionsRequest hibernationOptions()
```
    Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
  - metadataOptions
```
public final LaunchTemplateInstanceMetadataOptionsRequest 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 LaunchTemplateEnclaveOptionsRequest enclaveOptions()
```
    Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see What is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide.
    
    You can't enable AWS Nitro Enclaves and hibernation on the same instance.
    
    Returns:
    
    Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see What is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide.
    
    You can't enable AWS Nitro Enclaves and hibernation on the same instance.
  - toBuilder
```
public RequestLaunchTemplateData.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<RequestLaunchTemplateData.Builder,RequestLaunchTemplateData>
    
    Returns:
    
    a builder for type T
  - builder
```
public static RequestLaunchTemplateData.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RequestLaunchTemplateData.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.

AWS SDK for Java API Reference - 2.16.43

Class RequestLaunchTemplateData

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields