AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::AutoScaling::Model::ExecutePolicyRequest Class Reference

#include <ExecutePolicyRequest.h>

+ Inheritance diagram for Aws::AutoScaling::Model::ExecutePolicyRequest:

Public Member Functions

 ExecutePolicyRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetAutoScalingGroupName () const
 
bool AutoScalingGroupNameHasBeenSet () const
 
void SetAutoScalingGroupName (const Aws::String &value)
 
void SetAutoScalingGroupName (Aws::String &&value)
 
void SetAutoScalingGroupName (const char *value)
 
ExecutePolicyRequestWithAutoScalingGroupName (const Aws::String &value)
 
ExecutePolicyRequestWithAutoScalingGroupName (Aws::String &&value)
 
ExecutePolicyRequestWithAutoScalingGroupName (const char *value)
 
const Aws::StringGetPolicyName () const
 
bool PolicyNameHasBeenSet () const
 
void SetPolicyName (const Aws::String &value)
 
void SetPolicyName (Aws::String &&value)
 
void SetPolicyName (const char *value)
 
ExecutePolicyRequestWithPolicyName (const Aws::String &value)
 
ExecutePolicyRequestWithPolicyName (Aws::String &&value)
 
ExecutePolicyRequestWithPolicyName (const char *value)
 
bool GetHonorCooldown () const
 
bool HonorCooldownHasBeenSet () const
 
void SetHonorCooldown (bool value)
 
ExecutePolicyRequestWithHonorCooldown (bool value)
 
double GetMetricValue () const
 
bool MetricValueHasBeenSet () const
 
void SetMetricValue (double value)
 
ExecutePolicyRequestWithMetricValue (double value)
 
double GetBreachThreshold () const
 
bool BreachThresholdHasBeenSet () const
 
void SetBreachThreshold (double value)
 
ExecutePolicyRequestWithBreachThreshold (double value)
 
- Public Member Functions inherited from Aws::AutoScaling::AutoScalingRequest
virtual ~AutoScalingRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::AutoScaling::AutoScalingRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 21 of file ExecutePolicyRequest.h.

Constructor & Destructor Documentation

◆ ExecutePolicyRequest()

Aws::AutoScaling::Model::ExecutePolicyRequest::ExecutePolicyRequest ( )

Member Function Documentation

◆ AutoScalingGroupNameHasBeenSet()

bool Aws::AutoScaling::Model::ExecutePolicyRequest::AutoScalingGroupNameHasBeenSet ( ) const
inline

The name of the Auto Scaling group.

Definition at line 47 of file ExecutePolicyRequest.h.

◆ BreachThresholdHasBeenSet()

bool Aws::AutoScaling::Model::ExecutePolicyRequest::BreachThresholdHasBeenSet ( ) const
inline

The breach threshold for the alarm.

Required if the policy type is StepScaling and not supported otherwise.

Definition at line 221 of file ExecutePolicyRequest.h.

◆ DumpBodyToUrl()

void Aws::AutoScaling::Model::ExecutePolicyRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetAutoScalingGroupName()

const Aws::String& Aws::AutoScaling::Model::ExecutePolicyRequest::GetAutoScalingGroupName ( ) const
inline

The name of the Auto Scaling group.

Definition at line 42 of file ExecutePolicyRequest.h.

◆ GetBreachThreshold()

double Aws::AutoScaling::Model::ExecutePolicyRequest::GetBreachThreshold ( ) const
inline

The breach threshold for the alarm.

Required if the policy type is StepScaling and not supported otherwise.

Definition at line 215 of file ExecutePolicyRequest.h.

◆ GetHonorCooldown()

bool Aws::AutoScaling::Model::ExecutePolicyRequest::GetHonorCooldown ( ) const
inline

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 129 of file ExecutePolicyRequest.h.

◆ GetMetricValue()

double Aws::AutoScaling::Model::ExecutePolicyRequest::GetMetricValue ( ) const
inline

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

Required if the policy type is StepScaling and not supported otherwise.

Definition at line 172 of file ExecutePolicyRequest.h.

◆ GetPolicyName()

const Aws::String& Aws::AutoScaling::Model::ExecutePolicyRequest::GetPolicyName ( ) const
inline

The name or ARN of the policy.

Definition at line 83 of file ExecutePolicyRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::AutoScaling::Model::ExecutePolicyRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ExecutePolicyRequest.h.

◆ HonorCooldownHasBeenSet()

bool Aws::AutoScaling::Model::ExecutePolicyRequest::HonorCooldownHasBeenSet ( ) const
inline

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 139 of file ExecutePolicyRequest.h.

◆ MetricValueHasBeenSet()

bool Aws::AutoScaling::Model::ExecutePolicyRequest::MetricValueHasBeenSet ( ) const
inline

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

Required if the policy type is StepScaling and not supported otherwise.

Definition at line 184 of file ExecutePolicyRequest.h.

◆ PolicyNameHasBeenSet()

bool Aws::AutoScaling::Model::ExecutePolicyRequest::PolicyNameHasBeenSet ( ) const
inline

The name or ARN of the policy.

Definition at line 88 of file ExecutePolicyRequest.h.

◆ SerializePayload()

Aws::String Aws::AutoScaling::Model::ExecutePolicyRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAutoScalingGroupName() [1/3]

void Aws::AutoScaling::Model::ExecutePolicyRequest::SetAutoScalingGroupName ( const Aws::String value)
inline

The name of the Auto Scaling group.

Definition at line 52 of file ExecutePolicyRequest.h.

◆ SetAutoScalingGroupName() [2/3]

void Aws::AutoScaling::Model::ExecutePolicyRequest::SetAutoScalingGroupName ( Aws::String &&  value)
inline

The name of the Auto Scaling group.

Definition at line 57 of file ExecutePolicyRequest.h.

◆ SetAutoScalingGroupName() [3/3]

void Aws::AutoScaling::Model::ExecutePolicyRequest::SetAutoScalingGroupName ( const char *  value)
inline

The name of the Auto Scaling group.

Definition at line 62 of file ExecutePolicyRequest.h.

◆ SetBreachThreshold()

void Aws::AutoScaling::Model::ExecutePolicyRequest::SetBreachThreshold ( double  value)
inline

The breach threshold for the alarm.

Required if the policy type is StepScaling and not supported otherwise.

Definition at line 227 of file ExecutePolicyRequest.h.

◆ SetHonorCooldown()

void Aws::AutoScaling::Model::ExecutePolicyRequest::SetHonorCooldown ( bool  value)
inline

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 149 of file ExecutePolicyRequest.h.

◆ SetMetricValue()

void Aws::AutoScaling::Model::ExecutePolicyRequest::SetMetricValue ( double  value)
inline

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

Required if the policy type is StepScaling and not supported otherwise.

Definition at line 196 of file ExecutePolicyRequest.h.

◆ SetPolicyName() [1/3]

void Aws::AutoScaling::Model::ExecutePolicyRequest::SetPolicyName ( const Aws::String value)
inline

The name or ARN of the policy.

Definition at line 93 of file ExecutePolicyRequest.h.

◆ SetPolicyName() [2/3]

void Aws::AutoScaling::Model::ExecutePolicyRequest::SetPolicyName ( Aws::String &&  value)
inline

The name or ARN of the policy.

Definition at line 98 of file ExecutePolicyRequest.h.

◆ SetPolicyName() [3/3]

void Aws::AutoScaling::Model::ExecutePolicyRequest::SetPolicyName ( const char *  value)
inline

The name or ARN of the policy.

Definition at line 103 of file ExecutePolicyRequest.h.

◆ WithAutoScalingGroupName() [1/3]

ExecutePolicyRequest& Aws::AutoScaling::Model::ExecutePolicyRequest::WithAutoScalingGroupName ( const Aws::String value)
inline

The name of the Auto Scaling group.

Definition at line 67 of file ExecutePolicyRequest.h.

◆ WithAutoScalingGroupName() [2/3]

ExecutePolicyRequest& Aws::AutoScaling::Model::ExecutePolicyRequest::WithAutoScalingGroupName ( Aws::String &&  value)
inline

The name of the Auto Scaling group.

Definition at line 72 of file ExecutePolicyRequest.h.

◆ WithAutoScalingGroupName() [3/3]

ExecutePolicyRequest& Aws::AutoScaling::Model::ExecutePolicyRequest::WithAutoScalingGroupName ( const char *  value)
inline

The name of the Auto Scaling group.

Definition at line 77 of file ExecutePolicyRequest.h.

◆ WithBreachThreshold()

ExecutePolicyRequest& Aws::AutoScaling::Model::ExecutePolicyRequest::WithBreachThreshold ( double  value)
inline

The breach threshold for the alarm.

Required if the policy type is StepScaling and not supported otherwise.

Definition at line 233 of file ExecutePolicyRequest.h.

◆ WithHonorCooldown()

ExecutePolicyRequest& Aws::AutoScaling::Model::ExecutePolicyRequest::WithHonorCooldown ( bool  value)
inline

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 159 of file ExecutePolicyRequest.h.

◆ WithMetricValue()

ExecutePolicyRequest& Aws::AutoScaling::Model::ExecutePolicyRequest::WithMetricValue ( double  value)
inline

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

Required if the policy type is StepScaling and not supported otherwise.

Definition at line 208 of file ExecutePolicyRequest.h.

◆ WithPolicyName() [1/3]

ExecutePolicyRequest& Aws::AutoScaling::Model::ExecutePolicyRequest::WithPolicyName ( const Aws::String value)
inline

The name or ARN of the policy.

Definition at line 108 of file ExecutePolicyRequest.h.

◆ WithPolicyName() [2/3]

ExecutePolicyRequest& Aws::AutoScaling::Model::ExecutePolicyRequest::WithPolicyName ( Aws::String &&  value)
inline

The name or ARN of the policy.

Definition at line 113 of file ExecutePolicyRequest.h.

◆ WithPolicyName() [3/3]

ExecutePolicyRequest& Aws::AutoScaling::Model::ExecutePolicyRequest::WithPolicyName ( const char *  value)
inline

The name or ARN of the policy.

Definition at line 118 of file ExecutePolicyRequest.h.


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