Class FleetLaunchTemplateOverridesRequest
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.FleetLaunchTemplateOverridesRequest
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FleetLaunchTemplateOverridesRequest.Builder,FleetLaunchTemplateOverridesRequest>
@Generated("software.amazon.awssdk:codegen") public final class FleetLaunchTemplateOverridesRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FleetLaunchTemplateOverridesRequest.Builder,FleetLaunchTemplateOverridesRequest>
Describes overrides for a launch template.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
FleetLaunchTemplateOverridesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
availabilityZone()
The Availability Zone in which to launch the instances.static FleetLaunchTemplateOverridesRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
imageId()
The ID of the AMI in the formatami-17characters00000
.InstanceRequirementsRequest
instanceRequirements()
The attributes for the instance types.InstanceType
instanceType()
The instance type.String
instanceTypeAsString()
The instance type.String
maxPrice()
The maximum price per unit hour that you are willing to pay for a Spot Instance.Placement
placement()
The location where the instance launched, if applicable.Double
priority()
The priority for the launch template override.List<SdkField<?>>
sdkFields()
static Class<? extends FleetLaunchTemplateOverridesRequest.Builder>
serializableBuilderClass()
String
subnetId()
The IDs of the subnets in which to launch the instances.FleetLaunchTemplateOverridesRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.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
-
instanceType
public final InstanceType instanceType()
The instance type.
mac1.metal
is not supported as a launch template override.If you specify
InstanceType
, you can't specifyInstanceRequirements
.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.
mac1.metal
is not supported as a launch template override.If you specify
InstanceType
, you can't specifyInstanceRequirements
. - See Also:
InstanceType
-
instanceTypeAsString
public final String instanceTypeAsString()
The instance type.
mac1.metal
is not supported as a launch template override.If you specify
InstanceType
, you can't specifyInstanceRequirements
.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.
mac1.metal
is not supported as a launch template override.If you specify
InstanceType
, you can't specifyInstanceRequirements
. - See Also:
InstanceType
-
maxPrice
public final String maxPrice()
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. Separate multiple subnet IDs using commas (for example,
subnet-1234abcdeexample1, subnet-0987cdef6example2
). A request of typeinstant
can have only one subnet ID.- Returns:
- The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for
example,
subnet-1234abcdeexample1, subnet-0987cdef6example2
). A request of typeinstant
can have only one subnet ID.
-
availabilityZone
public final String availabilityZone()
The Availability Zone in which to launch the instances.
- Returns:
- The Availability Zone in which to launch the instances.
-
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.
When specifying weights, the price used in the
lowest-price
andprice-capacity-optimized
allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requestedTargetCapacity
, resulting in only 1 instance being launched, the price used is per instance hour.- 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.
When specifying weights, the price used in the
lowest-price
andprice-capacity-optimized
allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requestedTargetCapacity
, resulting in only 1 instance being launched, the price used is per instance hour.
-
priority
public final Double priority()
The priority for the launch template override. The highest priority is launched first.
If the On-Demand
AllocationStrategy
is set toprioritized
, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.If the Spot
AllocationStrategy
is set tocapacity-optimized-prioritized
, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.Valid values are whole numbers starting at
0
. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.- Returns:
- The priority for the launch template override. The highest priority is launched first.
If the On-Demand
AllocationStrategy
is set toprioritized
, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.If the Spot
AllocationStrategy
is set tocapacity-optimized-prioritized
, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.Valid values are whole numbers starting at
0
. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
-
placement
public final Placement placement()
The location where the instance launched, if applicable.
- Returns:
- The location where the instance launched, if applicable.
-
instanceRequirements
public final InstanceRequirementsRequest 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
.
-
imageId
public final String imageId()
The ID of the AMI in the format
ami-17characters00000
.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.
This parameter is only available for fleets of type
instant
. For fleets of typemaintain
andrequest
, you must specify the AMI ID in the launch template.- Returns:
- The ID of the AMI in the format
ami-17characters00000
.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.
This parameter is only available for fleets of type
instant
. For fleets of typemaintain
andrequest
, you must specify the AMI ID in the launch template. -
-
-
toBuilder
public FleetLaunchTemplateOverridesRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<FleetLaunchTemplateOverridesRequest.Builder,FleetLaunchTemplateOverridesRequest>
-
builder
public static FleetLaunchTemplateOverridesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends FleetLaunchTemplateOverridesRequest.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.
-
-