257 lines
13 KiB
C
257 lines
13 KiB
C
|
/**
|
|||
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|||
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
#pragma once
|
|||
|
|
#include <aws/elasticmapreduce/EMR_EXPORTS.h>
|
|||
|
|
#include <aws/elasticmapreduce/model/SpotProvisioningTimeoutAction.h>
|
|||
|
|
#include <aws/elasticmapreduce/model/SpotProvisioningAllocationStrategy.h>
|
|||
|
|
#include <utility>
|
|||
|
|
|
|||
|
|
namespace Aws
|
|||
|
|
{
|
|||
|
|
namespace Utils
|
|||
|
|
{
|
|||
|
|
namespace Json
|
|||
|
|
{
|
|||
|
|
class JsonValue;
|
|||
|
|
class JsonView;
|
|||
|
|
} // namespace Json
|
|||
|
|
} // namespace Utils
|
|||
|
|
namespace EMR
|
|||
|
|
{
|
|||
|
|
namespace Model
|
|||
|
|
{
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The launch specification for Spot instances in the instance fleet, which
|
|||
|
|
* determines the defined duration, provisioning timeout behavior, and allocation
|
|||
|
|
* strategy.</p> <p>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.</p>
|
|||
|
|
* <p><h3>See Also:</h3> <a
|
|||
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/elasticmapreduce-2009-03-31/SpotProvisioningSpecification">AWS
|
|||
|
|
* API Reference</a></p>
|
|||
|
|
*/
|
|||
|
|
class AWS_EMR_API SpotProvisioningSpecification
|
|||
|
|
{
|
|||
|
|
public:
|
|||
|
|
SpotProvisioningSpecification();
|
|||
|
|
SpotProvisioningSpecification(Aws::Utils::Json::JsonView jsonValue);
|
|||
|
|
SpotProvisioningSpecification& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|||
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The spot provisioning timeout period in minutes. If Spot instances are not
|
|||
|
|
* provisioned within this time period, the <code>TimeOutAction</code> is taken.
|
|||
|
|
* Minimum value is 5 and maximum value is 1440. The timeout applies only during
|
|||
|
|
* initial provisioning, when the cluster is first created.</p>
|
|||
|
|
*/
|
|||
|
|
inline int GetTimeoutDurationMinutes() const{ return m_timeoutDurationMinutes; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The spot provisioning timeout period in minutes. If Spot instances are not
|
|||
|
|
* provisioned within this time period, the <code>TimeOutAction</code> is taken.
|
|||
|
|
* Minimum value is 5 and maximum value is 1440. The timeout applies only during
|
|||
|
|
* initial provisioning, when the cluster is first created.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool TimeoutDurationMinutesHasBeenSet() const { return m_timeoutDurationMinutesHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The spot provisioning timeout period in minutes. If Spot instances are not
|
|||
|
|
* provisioned within this time period, the <code>TimeOutAction</code> is taken.
|
|||
|
|
* Minimum value is 5 and maximum value is 1440. The timeout applies only during
|
|||
|
|
* initial provisioning, when the cluster is first created.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetTimeoutDurationMinutes(int value) { m_timeoutDurationMinutesHasBeenSet = true; m_timeoutDurationMinutes = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The spot provisioning timeout period in minutes. If Spot instances are not
|
|||
|
|
* provisioned within this time period, the <code>TimeOutAction</code> is taken.
|
|||
|
|
* Minimum value is 5 and maximum value is 1440. The timeout applies only during
|
|||
|
|
* initial provisioning, when the cluster is first created.</p>
|
|||
|
|
*/
|
|||
|
|
inline SpotProvisioningSpecification& WithTimeoutDurationMinutes(int value) { SetTimeoutDurationMinutes(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The action to take when <code>TargetSpotCapacity</code> has not been
|
|||
|
|
* fulfilled when the <code>TimeoutDurationMinutes</code> has expired; that is,
|
|||
|
|
* when all Spot instances could not be provisioned within the Spot provisioning
|
|||
|
|
* timeout. Valid values are <code>TERMINATE_CLUSTER</code> and
|
|||
|
|
* <code>SWITCH_TO_ON_DEMAND</code>. SWITCH_TO_ON_DEMAND specifies that if no Spot
|
|||
|
|
* instances are available, On-Demand Instances should be provisioned to fulfill
|
|||
|
|
* any remaining Spot capacity.</p>
|
|||
|
|
*/
|
|||
|
|
inline const SpotProvisioningTimeoutAction& GetTimeoutAction() const{ return m_timeoutAction; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The action to take when <code>TargetSpotCapacity</code> has not been
|
|||
|
|
* fulfilled when the <code>TimeoutDurationMinutes</code> has expired; that is,
|
|||
|
|
* when all Spot instances could not be provisioned within the Spot provisioning
|
|||
|
|
* timeout. Valid values are <code>TERMINATE_CLUSTER</code> and
|
|||
|
|
* <code>SWITCH_TO_ON_DEMAND</code>. SWITCH_TO_ON_DEMAND specifies that if no Spot
|
|||
|
|
* instances are available, On-Demand Instances should be provisioned to fulfill
|
|||
|
|
* any remaining Spot capacity.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool TimeoutActionHasBeenSet() const { return m_timeoutActionHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The action to take when <code>TargetSpotCapacity</code> has not been
|
|||
|
|
* fulfilled when the <code>TimeoutDurationMinutes</code> has expired; that is,
|
|||
|
|
* when all Spot instances could not be provisioned within the Spot provisioning
|
|||
|
|
* timeout. Valid values are <code>TERMINATE_CLUSTER</code> and
|
|||
|
|
* <code>SWITCH_TO_ON_DEMAND</code>. SWITCH_TO_ON_DEMAND specifies that if no Spot
|
|||
|
|
* instances are available, On-Demand Instances should be provisioned to fulfill
|
|||
|
|
* any remaining Spot capacity.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetTimeoutAction(const SpotProvisioningTimeoutAction& value) { m_timeoutActionHasBeenSet = true; m_timeoutAction = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The action to take when <code>TargetSpotCapacity</code> has not been
|
|||
|
|
* fulfilled when the <code>TimeoutDurationMinutes</code> has expired; that is,
|
|||
|
|
* when all Spot instances could not be provisioned within the Spot provisioning
|
|||
|
|
* timeout. Valid values are <code>TERMINATE_CLUSTER</code> and
|
|||
|
|
* <code>SWITCH_TO_ON_DEMAND</code>. SWITCH_TO_ON_DEMAND specifies that if no Spot
|
|||
|
|
* instances are available, On-Demand Instances should be provisioned to fulfill
|
|||
|
|
* any remaining Spot capacity.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetTimeoutAction(SpotProvisioningTimeoutAction&& value) { m_timeoutActionHasBeenSet = true; m_timeoutAction = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The action to take when <code>TargetSpotCapacity</code> has not been
|
|||
|
|
* fulfilled when the <code>TimeoutDurationMinutes</code> has expired; that is,
|
|||
|
|
* when all Spot instances could not be provisioned within the Spot provisioning
|
|||
|
|
* timeout. Valid values are <code>TERMINATE_CLUSTER</code> and
|
|||
|
|
* <code>SWITCH_TO_ON_DEMAND</code>. SWITCH_TO_ON_DEMAND specifies that if no Spot
|
|||
|
|
* instances are available, On-Demand Instances should be provisioned to fulfill
|
|||
|
|
* any remaining Spot capacity.</p>
|
|||
|
|
*/
|
|||
|
|
inline SpotProvisioningSpecification& WithTimeoutAction(const SpotProvisioningTimeoutAction& value) { SetTimeoutAction(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The action to take when <code>TargetSpotCapacity</code> has not been
|
|||
|
|
* fulfilled when the <code>TimeoutDurationMinutes</code> has expired; that is,
|
|||
|
|
* when all Spot instances could not be provisioned within the Spot provisioning
|
|||
|
|
* timeout. Valid values are <code>TERMINATE_CLUSTER</code> and
|
|||
|
|
* <code>SWITCH_TO_ON_DEMAND</code>. SWITCH_TO_ON_DEMAND specifies that if no Spot
|
|||
|
|
* instances are available, On-Demand Instances should be provisioned to fulfill
|
|||
|
|
* any remaining Spot capacity.</p>
|
|||
|
|
*/
|
|||
|
|
inline SpotProvisioningSpecification& WithTimeoutAction(SpotProvisioningTimeoutAction&& value) { SetTimeoutAction(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>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. </p>
|
|||
|
|
*/
|
|||
|
|
inline int GetBlockDurationMinutes() const{ return m_blockDurationMinutes; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>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. </p>
|
|||
|
|
*/
|
|||
|
|
inline bool BlockDurationMinutesHasBeenSet() const { return m_blockDurationMinutesHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>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. </p>
|
|||
|
|
*/
|
|||
|
|
inline void SetBlockDurationMinutes(int value) { m_blockDurationMinutesHasBeenSet = true; m_blockDurationMinutes = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>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. </p>
|
|||
|
|
*/
|
|||
|
|
inline SpotProvisioningSpecification& WithBlockDurationMinutes(int value) { SetBlockDurationMinutes(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p> 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. </p>
|
|||
|
|
*/
|
|||
|
|
inline const SpotProvisioningAllocationStrategy& GetAllocationStrategy() const{ return m_allocationStrategy; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p> 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. </p>
|
|||
|
|
*/
|
|||
|
|
inline bool AllocationStrategyHasBeenSet() const { return m_allocationStrategyHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p> 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. </p>
|
|||
|
|
*/
|
|||
|
|
inline void SetAllocationStrategy(const SpotProvisioningAllocationStrategy& value) { m_allocationStrategyHasBeenSet = true; m_allocationStrategy = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p> 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. </p>
|
|||
|
|
*/
|
|||
|
|
inline void SetAllocationStrategy(SpotProvisioningAllocationStrategy&& value) { m_allocationStrategyHasBeenSet = true; m_allocationStrategy = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p> 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. </p>
|
|||
|
|
*/
|
|||
|
|
inline SpotProvisioningSpecification& WithAllocationStrategy(const SpotProvisioningAllocationStrategy& value) { SetAllocationStrategy(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p> 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. </p>
|
|||
|
|
*/
|
|||
|
|
inline SpotProvisioningSpecification& WithAllocationStrategy(SpotProvisioningAllocationStrategy&& value) { SetAllocationStrategy(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
private:
|
|||
|
|
|
|||
|
|
int m_timeoutDurationMinutes;
|
|||
|
|
bool m_timeoutDurationMinutesHasBeenSet;
|
|||
|
|
|
|||
|
|
SpotProvisioningTimeoutAction m_timeoutAction;
|
|||
|
|
bool m_timeoutActionHasBeenSet;
|
|||
|
|
|
|||
|
|
int m_blockDurationMinutes;
|
|||
|
|
bool m_blockDurationMinutesHasBeenSet;
|
|||
|
|
|
|||
|
|
SpotProvisioningAllocationStrategy m_allocationStrategy;
|
|||
|
|
bool m_allocationStrategyHasBeenSet;
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
} // namespace Model
|
|||
|
|
} // namespace EMR
|
|||
|
|
} // namespace Aws
|