RequestSpotLaunchSpecification (AWS Java SDK :: Services

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

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

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

Describes the launch specification for an instance.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RequestSpotLaunchSpecification.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addressingType()` Deprecated.
`List<BlockDeviceMapping>`	`blockDeviceMappings()` One or more block device mapping entries.
`static RequestSpotLaunchSpecification.Builder`	`builder()`
`Boolean`	`ebsOptimized()` Indicates whether the instance is optimized for EBS I/O.
`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.
`int`	`hashCode()`
`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.
`IamInstanceProfileSpecification`	`iamInstanceProfile()` The IAM instance profile.
`String`	`imageId()` The ID of the AMI.
`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.
`RunInstancesMonitoringEnabled`	`monitoring()` Indicates whether basic or detailed monitoring is enabled for the instance.
`List<InstanceNetworkInterfaceSpecification>`	`networkInterfaces()` One or more network interfaces.
`SpotPlacement`	`placement()` The placement information 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()` One or more security groups.
`static Class<? extends RequestSpotLaunchSpecification.Builder>`	`serializableBuilderClass()`
`String`	`subnetId()` The ID of the subnet in which to launch the instance.
`RequestSpotLaunchSpecification.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`userData()` The Base64-encoded 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
  - 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()
```
    One or more 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:
    
    One or more 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()
```
    One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
    
    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:
    
    One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
  - addressingType
```
public final String addressingType()
```
    Deprecated.
    
    Returns:
    
    Deprecated.
  - 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<BlockDeviceMapping> blockDeviceMappings()
```
    One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
    
    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:
    
    One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
  - ebsOptimized
```
public final Boolean ebsOptimized()
```
    Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
    
    Default: false
    
    Returns:
    
    Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
    
    Default: false
  - iamInstanceProfile
```
public final IamInstanceProfileSpecification iamInstanceProfile()
```
    The IAM instance profile.
    
    Returns:
    
    The IAM instance profile.
  - imageId
```
public final String imageId()
```
    The ID of the AMI.
    
    Returns:
    
    The ID of the AMI.
  - instanceType
```
public final InstanceType instanceType()
```
    The instance type. Only one instance type can be specified.
    
    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. Only one instance type can be specified.
    
    See Also:
    
    InstanceType
  - instanceTypeAsString
```
public final String instanceTypeAsString()
```
    The instance type. Only one instance type can be specified.
    
    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. Only one instance type can be specified.
    
    See Also:
    
    InstanceType
  - kernelId
```
public final String kernelId()
```
    The ID of the kernel.
    
    Returns:
    
    The ID of the kernel.
  - keyName
```
public final String keyName()
```
    The name of the key pair.
    
    Returns:
    
    The name of the key pair.
  - monitoring
```
public final RunInstancesMonitoringEnabled monitoring()
```
    Indicates whether basic or detailed monitoring is enabled for the instance.
    
    Default: Disabled
    
    Returns:
    
    Indicates whether basic or detailed monitoring is enabled for the instance.
    
    Default: Disabled
  - 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<InstanceNetworkInterfaceSpecification> networkInterfaces()
```
    One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
    
    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:
    
    One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
  - placement
```
public final SpotPlacement placement()
```
    The placement information for the instance.
    
    Returns:
    
    The placement information for the instance.
  - ramdiskId
```
public final String ramdiskId()
```
    The ID of the RAM disk.
    
    Returns:
    
    The ID of the RAM disk.
  - subnetId
```
public final String subnetId()
```
    The ID of the subnet in which to launch the instance.
    
    Returns:
    
    The ID of the subnet in which to launch the instance.
  - userData
```
public final String userData()
```
    The Base64-encoded user data for the instance. User data is limited to 16 KB.
    
    Returns:
    
    The Base64-encoded user data for the instance. User data is limited to 16 KB.
  - toBuilder
```
public RequestSpotLaunchSpecification.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RequestSpotLaunchSpecification.Builder,RequestSpotLaunchSpecification>
  - builder
```
public static RequestSpotLaunchSpecification.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RequestSpotLaunchSpecification.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 RequestSpotLaunchSpecification

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasSecurityGroupIds

securityGroupIds

hasSecurityGroups

securityGroups

addressingType

hasBlockDeviceMappings

blockDeviceMappings

ebsOptimized

iamInstanceProfile

imageId

instanceType

instanceTypeAsString

kernelId

keyName

monitoring

hasNetworkInterfaces

networkInterfaces

placement

ramdiskId

subnetId

userData

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields