software.amazon.awssdk.services.ec2.model

Class RequestLaunchTemplateData

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

Method Summary

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 set to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API.
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.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LaunchTemplateHibernationOptionsRequest	hibernationOptions() Indicates whether an instance is enabled for hibernation.
LaunchTemplateIamInstanceProfileSpecificationRequest	iamInstanceProfile() The IAM instance profile.
String	imageId() The ID of the AMI, which you can get by using DescribeImages.
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.
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()
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 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 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 LaunchTemplateIamInstanceProfileSpecificationRequest iamInstanceProfile()

The IAM instance profile.

Returns:

The IAM instance profile.

blockDeviceMappings

public List<LaunchTemplateBlockDeviceMappingRequest> blockDeviceMappings()

The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

networkInterfaces

public List<LaunchTemplateInstanceNetworkInterfaceSpecificationRequest> networkInterfaces()

One or more network interfaces.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more network interfaces.

imageId

public String imageId()

The ID of the AMI, which you can get by using DescribeImages.

Returns:

The ID of the AMI, which you can get by using DescribeImages.

instanceType

public 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 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 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 LaunchTemplatesMonitoringRequest monitoring()

The monitoring for the instance.

Returns:

The monitoring for the instance.

placement

public LaunchTemplatePlacementRequest placement()

The placement for the instance.

Returns:

The placement for the instance.

ramDiskId

public 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 Boolean disableApiTermination()

If set to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute to false after launch, use ModifyInstanceAttribute.

Returns:

If set to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute to false after launch, use ModifyInstanceAttribute.

instanceInitiatedShutdownBehavior

public 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 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 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).

tagSpecifications

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

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.

elasticGpuSpecifications

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

Returns:

An elastic GPU to associate with the instance.

elasticInferenceAccelerators

public List<LaunchTemplateElasticInferenceAccelerator> elasticInferenceAccelerators()

The elastic inference accelerator for the instance.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The elastic inference accelerator for the instance.

securityGroupIds

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

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.

securityGroups

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

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 LaunchTemplateInstanceMarketOptionsRequest instanceMarketOptions()

The market (purchasing) option for the instances.

Returns:

The market (purchasing) option for the instances.

creditSpecification

public CreditSpecificationRequest creditSpecification()

The credit option for CPU usage of the instance. Valid for T2 or T3 instances only.

Returns:

The credit option for CPU usage of the instance. Valid for T2 or T3 instances only.

cpuOptions

public 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 LaunchTemplateCapacityReservationSpecificationRequest capacityReservationSpecification()

The Capacity Reservation targeting option.

Returns:

The Capacity Reservation targeting option.

hibernationOptions

public LaunchTemplateHibernationOptionsRequest hibernationOptions()

Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. Hibernation is currently supported only for Amazon Linux. 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. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

licenseSpecifications

public List<LaunchTemplateLicenseConfigurationRequest> licenseSpecifications()

The license configurations.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The license configurations.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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