Class RequestLaunchTemplateData

java.lang.Object
software.amazon.awssdk.services.ec2.model.RequestLaunchTemplateData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RequestLaunchTemplateData.Builder,RequestLaunchTemplateData>
@Generated("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.

You must specify at least one parameter for the launch template data.

See Also:

  • Method Details

    • 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 EC2 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 EC2 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()
      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<LaunchTemplateBlockDeviceMappingRequest> blockDeviceMappings()

      The block device mapping.

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

    • 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<LaunchTemplateInstanceNetworkInterfaceSpecificationRequest> networkInterfaces()

      The network interfaces for the instance.

      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 for the instance.

    • imageId

      public final String imageId()

      The ID of the AMI in the format ami-0ac394d6a3example.

      Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch.

      To reference a public parameter:

      • resolve:ssm:public-parameter

      To reference a parameter stored in the same account:

      • resolve:ssm:parameter-name

      • resolve:ssm:parameter-name:version-number

      • resolve:ssm:parameter-name:label

      To reference a parameter shared from another Amazon Web Services account:

      • resolve:ssm:parameter-ARN

      • resolve:ssm:parameter-ARN:version-number

      • resolve:ssm:parameter-ARN:label

      For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.

      If the launch template will be used for an EC2 Fleet or Spot Fleet, note the following:

      • Only EC2 Fleets of type instant support specifying a Systems Manager parameter.

      • For EC2 Fleets of type maintain or request, or for Spot Fleets, you must specify the AMI ID.

      Returns:
      The ID of the AMI in the format ami-0ac394d6a3example.

      Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch.

      To reference a public parameter:

      • resolve:ssm:public-parameter

      To reference a parameter stored in the same account:

      • resolve:ssm:parameter-name

      • resolve:ssm:parameter-name:version-number

      • resolve:ssm:parameter-name:label

      To reference a parameter shared from another Amazon Web Services account:

      • resolve:ssm:parameter-ARN

      • resolve:ssm:parameter-ARN:version-number

      • resolve:ssm:parameter-ARN:label

      For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.

      If the launch template will be used for an EC2 Fleet or Spot Fleet, note the following:

      • Only EC2 Fleets of type instant support specifying a Systems Manager parameter.

      • For EC2 Fleets of type maintain or request, or for Spot Fleets, you must specify the AMI ID.

    • instanceType

      public final InstanceType instanceType()

      The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.

      If you specify InstanceType, you can't specify InstanceRequirements.

      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 Amazon EC2 instance types in the Amazon EC2 User Guide.

      If you specify InstanceType, you can't specify InstanceRequirements.

      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.

      If you specify InstanceType, you can't specify InstanceRequirements.

      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 Amazon EC2 instance types in the Amazon EC2 User Guide.

      If you specify InstanceType, you can't specify InstanceRequirements.

      See Also:

    • 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 EC2 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 EC2 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:

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

    • userData

      public final String userData()

      The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands on your Amazon EC2 instance at launch in the Amazon EC2 User Guide.

      If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

      Returns:
      The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands on your Amazon EC2 instance at launch in the Amazon EC2 User Guide.

      If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

    • 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<LaunchTemplateTagSpecificationRequest> tagSpecifications()

      The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.

      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 to apply to the resources that are created during instance launch. These tags are not applied to the launch template.

    • 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<ElasticGpuSpecification> elasticGpuSpecifications()

      Deprecated.

      Amazon Elastic Graphics reached end of life on January 8, 2024.

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

      Amazon Elastic Graphics reached end of life on January 8, 2024.

    • 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<LaunchTemplateElasticInferenceAccelerator> elasticInferenceAccelerators()

      Deprecated.

      Amazon Elastic Inference is no longer available.

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

      Amazon Elastic Inference is no longer available.

    • 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 IDs of the security groups.

      If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

      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 IDs of the security groups.

      If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

    • 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 names of the security groups. For a nondefault VPC, you must use security group IDs instead.

      If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

      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 names of the security groups. For a nondefault VPC, you must use security group IDs instead.

      If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

    • 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 only for T instances.

      Returns:
      The credit option for CPU usage of the instance. Valid only for T instances.

    • cpuOptions

      public final LaunchTemplateCpuOptionsRequest cpuOptions()

      The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

      Returns:
      The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 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()
      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<LaunchTemplateLicenseConfigurationRequest> 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 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 Amazon EC2 instance in the Amazon EC2 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 Amazon EC2 instance in the Amazon EC2 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 EC2 User Guide.

      Returns:
      The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

    • enclaveOptions

      public final LaunchTemplateEnclaveOptionsRequest enclaveOptions()

      Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

      You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

      Returns:
      Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

      You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

    • instanceRequirements

      public final InstanceRequirementsRequest instanceRequirements()

      The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

      You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.

      When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.

      To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:

      • AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.

      • ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.

      If you specify InstanceRequirements, you can't specify InstanceType.

      Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2:: Instance Amazon Web Services CloudFormation resource, you can't specify InstanceRequirements.

      For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.

      Returns:
      The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

      You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.

      When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.

      To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:

      • AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.

      • ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.

      If you specify InstanceRequirements, you can't specify InstanceType.

      Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify InstanceRequirements.

      For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.

    • privateDnsNameOptions

      public final LaunchTemplatePrivateDnsNameOptionsRequest privateDnsNameOptions()

      The options for the instance hostname. The default values are inherited from the subnet.

      Returns:
      The options for the instance hostname. The default values are inherited from the subnet.

    • maintenanceOptions

      public final LaunchTemplateInstanceMaintenanceOptionsRequest maintenanceOptions()

      The maintenance options for the instance.

      Returns:
      The maintenance options for the instance.

    • disableApiStop

      public final Boolean disableApiStop()

      Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.

      Returns:
      Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.

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