Class: Aws::EC2::Types::SpotFleetRequestConfigData

Inherits:

Struct

Object
Struct
Aws::EC2::Types::SpotFleetRequestConfigData

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ec2/types.rb

Overview

Describes the configuration of a Spot Fleet request.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#allocation_strategy ⇒ String

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration.
#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings.
#context ⇒ String

Reserved.
#excess_capacity_termination_policy ⇒ String

Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
#fulfilled_capacity ⇒ Float

The number of units fulfilled by this request compared to the set target capacity.
#iam_fleet_role ⇒ String

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf.
#instance_interruption_behavior ⇒ String

The behavior when a Spot Instance is interrupted.
#instance_pools_to_use_count ⇒ Integer

The number of Spot pools across which to allocate your target Spot capacity.
#launch_specifications ⇒ Array<Types::SpotFleetLaunchSpecification>

The launch specifications for the Spot Fleet request.
#launch_template_configs ⇒ Array<Types::LaunchTemplateConfig>

The launch template and overrides.
#load_balancers_config ⇒ Types::LoadBalancersConfig

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request.
#on_demand_allocation_strategy ⇒ String

The order of the launch template overrides to use in fulfilling On-Demand capacity.
#on_demand_fulfilled_capacity ⇒ Float

The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
#on_demand_max_total_price ⇒ String

The maximum amount per hour for On-Demand Instances that you’re willing to pay.
#on_demand_target_capacity ⇒ Integer

The number of On-Demand units to request.
#replace_unhealthy_instances ⇒ Boolean

Indicates whether Spot Fleet should replace unhealthy instances.
#spot_maintenance_strategies ⇒ Types::SpotMaintenanceStrategies

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
#spot_max_total_price ⇒ String

The maximum amount per hour for Spot Instances that you’re willing to pay.
#spot_price ⇒ String

The maximum price per unit hour that you are willing to pay for a Spot Instance.
#tag_specifications ⇒ Array<Types::TagSpecification>

The key-value pair for tagging the Spot Fleet request on creation.
#target_capacity ⇒ Integer

The number of units to request for the Spot Fleet.
#target_capacity_unit_type ⇒ String

The unit for the target capacity.
#terminate_instances_with_expiration ⇒ Boolean

Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
#type ⇒ String

The type of request.
#valid_from ⇒ Time

The start date and time of the request, in UTC format (YYYY-MM-*DD*T*HH*:MM:*SS*Z).
#valid_until ⇒ Time

The end date and time of the request, in UTC format (YYYY-MM-*DD*T*HH*:MM:*SS*Z).

Instance Attribute Details

#allocation_strategy ⇒ `String`

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see

Allocation strategies for Spot Instances][1: in the *Amazon EC2

User Guide*.

priceCapacityOptimized (recommended)

: Spot Fleet identifies the pools with the highest capacity

availability for the number of instances that are launching. This
means that we will request Spot Instances from the pools that we
believe have the lowest chance of interruption in the near term.
Spot Fleet then requests Spot Instances from the lowest priced of
these pools.

capacityOptimized

: Spot Fleet identifies the pools with the highest capacity

availability for the number of instances that are launching. This
means that we will request Spot Instances from the pools that we
believe have the lowest chance of interruption in the near term.
To give certain instance types a higher chance of launching first,
use `capacityOptimizedPrioritized`. Set a priority for each
instance type by using the `Priority` parameter for
`LaunchTemplateOverrides`. You can assign the same priority to
different `LaunchTemplateOverrides`. EC2 implements the priorities
on a best-effort basis, but optimizes for capacity first.
`capacityOptimizedPrioritized` is supported only if your Spot
Fleet uses a launch template. Note that if the
`OnDemandAllocationStrategy` is set to `prioritized`, the same
priority is applied when fulfilling On-Demand capacity.

diversified

: Spot Fleet requests instances from all of the Spot Instance pools

that you specify.

lowestPrice

: Spot Fleet requests instances from the lowest priced Spot Instance

pool that has available capacity. If the lowest priced pool
doesn't have available capacity, the Spot Instances come from the
next lowest priced pool that has available capacity. If a pool
runs out of capacity before fulfilling your desired capacity, Spot
Fleet will continue to fulfill your request by drawing from the
next lowest priced pool. To ensure that your desired capacity is
met, you might receive Spot Instances from several pools. Because
this strategy only considers instance price and not capacity
availability, it might lead to high interruption rates.

Default: ‘lowestPrice`

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see [Ensuring Idempotency].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#context ⇒ `String`

Reserved.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#excess_capacity_termination_policy ⇒ `String`

Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.

Supported only for fleets of type ‘maintain`.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#fulfilled_capacity ⇒ `Float`

The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.

Returns:

(Float)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#iam_fleet_role ⇒ `String`

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see [Spot Fleet prerequisites] in the *Amazon EC2 User Guide*. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using

CancelSpotFleetRequests][2: or when the Spot Fleet request expires,

if you set ‘TerminateInstancesWithExpiration`.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CancelSpotFleetRequests

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#instance_interruption_behavior ⇒ `String`

The behavior when a Spot Instance is interrupted. The default is ‘terminate`.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#instance_pools_to_use_count ⇒ `Integer`

The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to ‘lowest-price`. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

Returns:

(Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#launch_specifications ⇒ `Array<Types::SpotFleetLaunchSpecification>`

The launch specifications for the Spot Fleet request. If you specify ‘LaunchSpecifications`, you can’t specify ‘LaunchTemplateConfigs`. If you include On-Demand capacity in your request, you must use `LaunchTemplateConfigs`.

Returns:

(Array<Types::SpotFleetLaunchSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#launch_template_configs ⇒ `Array<Types::LaunchTemplateConfig>`

The launch template and overrides. If you specify ‘LaunchTemplateConfigs`, you can’t specify ‘LaunchSpecifications`. If you include On-Demand capacity in your request, you must use `LaunchTemplateConfigs`.

Returns:

(Array<Types::LaunchTemplateConfig>)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#load_balancers_config ⇒ `Types::LoadBalancersConfig`

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.

Returns:

(Types::LoadBalancersConfig)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_allocation_strategy ⇒ `String`

The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify ‘lowestPrice`, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify `prioritized`, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to `lowestPrice`.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_fulfilled_capacity ⇒ `Float`

The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.

Returns:

(Float)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_max_total_price ⇒ `String`

The maximum amount per hour for On-Demand Instances that you’re willing to pay. You can use the ‘onDemandMaxTotalPrice` parameter, the `spotMaxTotalPrice` parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you’re willing to pay. When the maximum amount you’re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

<note markdown=“1”> If your fleet includes T instances that are configured as ‘unlimited`, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `onDemandMaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `onDemandMaxTotalPrice`. For more information, see [Surplus credits can incur charges] in the *EC2 User Guide*.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_target_capacity ⇒ `Integer`

The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is ‘maintain`, you can specify a target capacity of 0 and add capacity later.

Returns:

(Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#replace_unhealthy_instances ⇒ `Boolean`

Indicates whether Spot Fleet should replace unhealthy instances.

Returns:

(Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#spot_maintenance_strategies ⇒ `Types::SpotMaintenanceStrategies`

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Returns:

(Types::SpotMaintenanceStrategies)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#spot_max_total_price ⇒ `String`

The maximum amount per hour for Spot Instances that you’re willing to pay. You can use the ‘spotMaxTotalPrice` parameter, the `onDemandMaxTotalPrice` parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you’re willing to pay. When the maximum amount you’re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

<note markdown=“1”> If your fleet includes T instances that are configured as ‘unlimited`, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `spotMaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `spotMaxTotalPrice`. For more information, see

Surplus credits can incur charges][1: in the *EC2 User Guide*.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#spot_price ⇒ `String`

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:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ `Array<Types::TagSpecification>`

The key-value pair for tagging the Spot Fleet request on creation. The value for ‘ResourceType` must be `spot-fleet-request`, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the [launch template] (valid only if you use `LaunchTemplateConfigs`) or in the ` SpotFleetTagSpecification ` (valid only if you use `LaunchSpecifications`). For information about tagging after launch, see [Tag your resources].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources

Returns:

(Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#target_capacity ⇒ `Integer`

The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is ‘maintain`, you can specify a target capacity of 0 and add capacity later.

Returns:

(Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#target_capacity_unit_type ⇒ `String`

The unit for the target capacity. ‘TargetCapacityUnitType` can only be specified when `InstanceRequirements` is specified.

Default: ‘units` (translates to number of instances)

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#terminate_instances_with_expiration ⇒ `Boolean`

Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.

Returns:

(Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ `String`

The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is ‘request`, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is `maintain`, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: `maintain`. `instant` is listed but is not used by Spot Fleet.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#valid_from ⇒ `Time`

The start date and time of the request, in UTC format (YYYY-MM-*DD*T*HH*:MM:*SS*Z). By default, Amazon EC2 starts fulfilling the request immediately.

Returns:

(Time)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#valid_until ⇒ `Time`

The end date and time of the request, in UTC format (YYYY-MM-*DD*T*HH*:MM:*SS*Z). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.

Returns:

(Time)

# File 'lib/aws-sdk-ec2/types.rb', line 61124

class SpotFleetRequestConfigData < Struct.new(
  :allocation_strategy,
  :on_demand_allocation_strategy,
  :spot_maintenance_strategies,
  :client_token,
  :excess_capacity_termination_policy,
  :fulfilled_capacity,
  :on_demand_fulfilled_capacity,
  :iam_fleet_role,
  :launch_specifications,
  :launch_template_configs,
  :spot_price,
  :target_capacity,
  :on_demand_target_capacity,
  :on_demand_max_total_price,
  :spot_max_total_price,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :instance_interruption_behavior,
  :load_balancers_config,
  :instance_pools_to_use_count,
  :context,
  :target_capacity_unit_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::EC2::Types::SpotFleetRequestConfigData

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#allocation_strategy ⇒ String

#client_token ⇒ String

#context ⇒ String

#excess_capacity_termination_policy ⇒ String

#fulfilled_capacity ⇒ Float

#iam_fleet_role ⇒ String

#instance_interruption_behavior ⇒ String

#instance_pools_to_use_count ⇒ Integer

#launch_specifications ⇒ Array<Types::SpotFleetLaunchSpecification>

#launch_template_configs ⇒ Array<Types::LaunchTemplateConfig>

#load_balancers_config ⇒ Types::LoadBalancersConfig

#on_demand_allocation_strategy ⇒ String

#on_demand_fulfilled_capacity ⇒ Float

#on_demand_max_total_price ⇒ String

#on_demand_target_capacity ⇒ Integer

#replace_unhealthy_instances ⇒ Boolean

#spot_maintenance_strategies ⇒ Types::SpotMaintenanceStrategies

#spot_max_total_price ⇒ String

#spot_price ⇒ String

#tag_specifications ⇒ Array<Types::TagSpecification>

#target_capacity ⇒ Integer

#target_capacity_unit_type ⇒ String

#terminate_instances_with_expiration ⇒ Boolean

#type ⇒ String

#valid_from ⇒ Time

#valid_until ⇒ Time

#allocation_strategy ⇒ `String`

#client_token ⇒ `String`

#context ⇒ `String`

#excess_capacity_termination_policy ⇒ `String`

#fulfilled_capacity ⇒ `Float`

#iam_fleet_role ⇒ `String`

#instance_interruption_behavior ⇒ `String`

#instance_pools_to_use_count ⇒ `Integer`

#launch_specifications ⇒ `Array<Types::SpotFleetLaunchSpecification>`

#launch_template_configs ⇒ `Array<Types::LaunchTemplateConfig>`

#load_balancers_config ⇒ `Types::LoadBalancersConfig`

#on_demand_allocation_strategy ⇒ `String`

#on_demand_fulfilled_capacity ⇒ `Float`

#on_demand_max_total_price ⇒ `String`

#on_demand_target_capacity ⇒ `Integer`

#replace_unhealthy_instances ⇒ `Boolean`

#spot_maintenance_strategies ⇒ `Types::SpotMaintenanceStrategies`

#spot_max_total_price ⇒ `String`

#spot_price ⇒ `String`

#tag_specifications ⇒ `Array<Types::TagSpecification>`

#target_capacity ⇒ `Integer`

#target_capacity_unit_type ⇒ `String`

#terminate_instances_with_expiration ⇒ `Boolean`

#type ⇒ `String`

#valid_from ⇒ `Time`

#valid_until ⇒ `Time`