AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::EMR::Model::SpotProvisioningSpecification Class Reference

#include <SpotProvisioningSpecification.h>

Public Member Functions

 SpotProvisioningSpecification ()
 
 SpotProvisioningSpecification (Aws::Utils::Json::JsonView jsonValue)
 
SpotProvisioningSpecificationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetTimeoutDurationMinutes () const
 
bool TimeoutDurationMinutesHasBeenSet () const
 
void SetTimeoutDurationMinutes (int value)
 
SpotProvisioningSpecificationWithTimeoutDurationMinutes (int value)
 
const SpotProvisioningTimeoutActionGetTimeoutAction () const
 
bool TimeoutActionHasBeenSet () const
 
void SetTimeoutAction (const SpotProvisioningTimeoutAction &value)
 
void SetTimeoutAction (SpotProvisioningTimeoutAction &&value)
 
SpotProvisioningSpecificationWithTimeoutAction (const SpotProvisioningTimeoutAction &value)
 
SpotProvisioningSpecificationWithTimeoutAction (SpotProvisioningTimeoutAction &&value)
 
int GetBlockDurationMinutes () const
 
bool BlockDurationMinutesHasBeenSet () const
 
void SetBlockDurationMinutes (int value)
 
SpotProvisioningSpecificationWithBlockDurationMinutes (int value)
 
const SpotProvisioningAllocationStrategyGetAllocationStrategy () const
 
bool AllocationStrategyHasBeenSet () const
 
void SetAllocationStrategy (const SpotProvisioningAllocationStrategy &value)
 
void SetAllocationStrategy (SpotProvisioningAllocationStrategy &&value)
 
SpotProvisioningSpecificationWithAllocationStrategy (const SpotProvisioningAllocationStrategy &value)
 
SpotProvisioningSpecificationWithAllocationStrategy (SpotProvisioningAllocationStrategy &&value)
 

Detailed Description

The launch specification for Spot Instances in the instance fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation strategy is available in Amazon EMR version 5.12.1 and later.

See Also:

AWS API Reference

Definition at line 37 of file SpotProvisioningSpecification.h.

Constructor & Destructor Documentation

◆ SpotProvisioningSpecification() [1/2]

Aws::EMR::Model::SpotProvisioningSpecification::SpotProvisioningSpecification ( )

◆ SpotProvisioningSpecification() [2/2]

Aws::EMR::Model::SpotProvisioningSpecification::SpotProvisioningSpecification ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AllocationStrategyHasBeenSet()

bool Aws::EMR::Model::SpotProvisioningSpecification::AllocationStrategyHasBeenSet ( ) const
inline

Specifies the strategy to use in launching Spot Instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

Definition at line 205 of file SpotProvisioningSpecification.h.

◆ BlockDurationMinutesHasBeenSet()

bool Aws::EMR::Model::SpotProvisioningSpecification::BlockDurationMinutesHasBeenSet ( ) const
inline

The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.

Definition at line 166 of file SpotProvisioningSpecification.h.

◆ GetAllocationStrategy()

const SpotProvisioningAllocationStrategy& Aws::EMR::Model::SpotProvisioningSpecification::GetAllocationStrategy ( ) const
inline

Specifies the strategy to use in launching Spot Instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

Definition at line 197 of file SpotProvisioningSpecification.h.

◆ GetBlockDurationMinutes()

int Aws::EMR::Model::SpotProvisioningSpecification::GetBlockDurationMinutes ( ) const
inline

The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.

Definition at line 155 of file SpotProvisioningSpecification.h.

◆ GetTimeoutAction()

const SpotProvisioningTimeoutAction& Aws::EMR::Model::SpotProvisioningSpecification::GetTimeoutAction ( ) const
inline

The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.

Definition at line 88 of file SpotProvisioningSpecification.h.

◆ GetTimeoutDurationMinutes()

int Aws::EMR::Model::SpotProvisioningSpecification::GetTimeoutDurationMinutes ( ) const
inline

The spot provisioning timeout period in minutes. If Spot Instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.

Definition at line 52 of file SpotProvisioningSpecification.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EMR::Model::SpotProvisioningSpecification::Jsonize ( ) const

◆ operator=()

SpotProvisioningSpecification& Aws::EMR::Model::SpotProvisioningSpecification::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAllocationStrategy() [1/2]

void Aws::EMR::Model::SpotProvisioningSpecification::SetAllocationStrategy ( const SpotProvisioningAllocationStrategy value)
inline

Specifies the strategy to use in launching Spot Instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

Definition at line 213 of file SpotProvisioningSpecification.h.

◆ SetAllocationStrategy() [2/2]

void Aws::EMR::Model::SpotProvisioningSpecification::SetAllocationStrategy ( SpotProvisioningAllocationStrategy &&  value)
inline

Specifies the strategy to use in launching Spot Instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

Definition at line 221 of file SpotProvisioningSpecification.h.

◆ SetBlockDurationMinutes()

void Aws::EMR::Model::SpotProvisioningSpecification::SetBlockDurationMinutes ( int  value)
inline

The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.

Definition at line 177 of file SpotProvisioningSpecification.h.

◆ SetTimeoutAction() [1/2]

void Aws::EMR::Model::SpotProvisioningSpecification::SetTimeoutAction ( const SpotProvisioningTimeoutAction value)
inline

The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.

Definition at line 110 of file SpotProvisioningSpecification.h.

◆ SetTimeoutAction() [2/2]

void Aws::EMR::Model::SpotProvisioningSpecification::SetTimeoutAction ( SpotProvisioningTimeoutAction &&  value)
inline

The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.

Definition at line 121 of file SpotProvisioningSpecification.h.

◆ SetTimeoutDurationMinutes()

void Aws::EMR::Model::SpotProvisioningSpecification::SetTimeoutDurationMinutes ( int  value)
inline

The spot provisioning timeout period in minutes. If Spot Instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.

Definition at line 68 of file SpotProvisioningSpecification.h.

◆ TimeoutActionHasBeenSet()

bool Aws::EMR::Model::SpotProvisioningSpecification::TimeoutActionHasBeenSet ( ) const
inline

The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.

Definition at line 99 of file SpotProvisioningSpecification.h.

◆ TimeoutDurationMinutesHasBeenSet()

bool Aws::EMR::Model::SpotProvisioningSpecification::TimeoutDurationMinutesHasBeenSet ( ) const
inline

The spot provisioning timeout period in minutes. If Spot Instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.

Definition at line 60 of file SpotProvisioningSpecification.h.

◆ WithAllocationStrategy() [1/2]

SpotProvisioningSpecification& Aws::EMR::Model::SpotProvisioningSpecification::WithAllocationStrategy ( const SpotProvisioningAllocationStrategy value)
inline

Specifies the strategy to use in launching Spot Instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

Definition at line 229 of file SpotProvisioningSpecification.h.

◆ WithAllocationStrategy() [2/2]

SpotProvisioningSpecification& Aws::EMR::Model::SpotProvisioningSpecification::WithAllocationStrategy ( SpotProvisioningAllocationStrategy &&  value)
inline

Specifies the strategy to use in launching Spot Instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

Definition at line 237 of file SpotProvisioningSpecification.h.

◆ WithBlockDurationMinutes()

SpotProvisioningSpecification& Aws::EMR::Model::SpotProvisioningSpecification::WithBlockDurationMinutes ( int  value)
inline

The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.

Definition at line 188 of file SpotProvisioningSpecification.h.

◆ WithTimeoutAction() [1/2]

SpotProvisioningSpecification& Aws::EMR::Model::SpotProvisioningSpecification::WithTimeoutAction ( const SpotProvisioningTimeoutAction value)
inline

The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.

Definition at line 132 of file SpotProvisioningSpecification.h.

◆ WithTimeoutAction() [2/2]

SpotProvisioningSpecification& Aws::EMR::Model::SpotProvisioningSpecification::WithTimeoutAction ( SpotProvisioningTimeoutAction &&  value)
inline

The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.

Definition at line 143 of file SpotProvisioningSpecification.h.

◆ WithTimeoutDurationMinutes()

SpotProvisioningSpecification& Aws::EMR::Model::SpotProvisioningSpecification::WithTimeoutDurationMinutes ( int  value)
inline

The spot provisioning timeout period in minutes. If Spot Instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.

Definition at line 76 of file SpotProvisioningSpecification.h.


The documentation for this class was generated from the following file: