Class SpotFleetLaunchSpecification
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.SpotFleetLaunchSpecification
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SpotFleetLaunchSpecification.Builder,SpotFleetLaunchSpecification>
@Generated("software.amazon.awssdk:codegen") public final class SpotFleetLaunchSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SpotFleetLaunchSpecification.Builder,SpotFleetLaunchSpecification>
Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use
SpotFleetLaunchSpecification
; you must use LaunchTemplateConfig.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
SpotFleetLaunchSpecification.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
addressingType()
Deprecated.List<BlockDeviceMapping>
blockDeviceMappings()
One or more block devices that are mapped to the Spot Instances.static SpotFleetLaunchSpecification.Builder
builder()
Boolean
ebsOptimized()
Indicates whether the instances are 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
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.IamInstanceProfileSpecification
iamInstanceProfile()
The IAM instance profile.String
imageId()
The ID of the AMI.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.String
keyName()
The name of the key pair.SpotFleetMonitoring
monitoring()
Enable or disable monitoring for the instances.List<InstanceNetworkInterfaceSpecification>
networkInterfaces()
One or more network interfaces.SpotPlacement
placement()
The placement information.String
ramdiskId()
The ID of the RAM disk.List<SdkField<?>>
sdkFields()
List<GroupIdentifier>
securityGroups()
The security groups.static Class<? extends SpotFleetLaunchSpecification.Builder>
serializableBuilderClass()
String
spotPrice()
The maximum price per unit hour that you are willing to pay for a Spot Instance.String
subnetId()
The IDs of the subnets in which to launch the instances.List<SpotFleetTagSpecification>
tagSpecifications()
The tags to apply during creation.SpotFleetLaunchSpecification.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
userData()
The base64-encoded user data that instances use when starting up.Double
weightedCapacity()
The number of units provided by the specified instance type.-
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
-
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 theisEmpty()
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<GroupIdentifier> securityGroups()
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:
- 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 theisEmpty()
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 devices that are mapped to the Spot Instances. 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 devices that are mapped to the Spot Instances. 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 instances are 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 instances are 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.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- 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 returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type.
- 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 SpotFleetMonitoring monitoring()
Enable or disable monitoring for the instances.
- Returns:
- Enable or disable monitoring for the instances.
-
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 theisEmpty()
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.
SpotFleetLaunchSpecification
currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.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.
SpotFleetLaunchSpecification
currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
-
placement
public final SpotPlacement placement()
The placement information.
- Returns:
- The placement information.
-
ramdiskId
public final String ramdiskId()
The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
- Returns:
- The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
-
spotPrice
public final String spotPrice()
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
- Returns:
- The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend
using this parameter because it can lead to increased interruptions. If you do not specify this
parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
-
subnetId
public final String subnetId()
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
- Returns:
- The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
-
userData
public final String userData()
The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
- Returns:
- The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
-
weightedCapacity
public final Double weightedCapacity()
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
- Returns:
- The number of units provided by the specified instance type. These are the same units that you chose to
set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or
I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
-
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 theisEmpty()
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<SpotFleetTagSpecification> tagSpecifications()
The tags to apply during creation.
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 during creation.
-
instanceRequirements
public final InstanceRequirements instanceRequirements()
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify
InstanceRequirements
, you can't specifyInstanceType
.- Returns:
- The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify
instance types with those attributes.
If you specify
InstanceRequirements
, you can't specifyInstanceType
.
-
toBuilder
public SpotFleetLaunchSpecification.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<SpotFleetLaunchSpecification.Builder,SpotFleetLaunchSpecification>
-
builder
public static SpotFleetLaunchSpecification.Builder builder()
-
serializableBuilderClass
public static Class<? extends SpotFleetLaunchSpecification.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-