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

#include <StartInstanceRefreshRequest.h>

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

Public Member Functions

 StartInstanceRefreshRequest ()
 
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)
 
StartInstanceRefreshRequestWithAutoScalingGroupName (const Aws::String &value)
 
StartInstanceRefreshRequestWithAutoScalingGroupName (Aws::String &&value)
 
StartInstanceRefreshRequestWithAutoScalingGroupName (const char *value)
 
const RefreshStrategyGetStrategy () const
 
bool StrategyHasBeenSet () const
 
void SetStrategy (const RefreshStrategy &value)
 
void SetStrategy (RefreshStrategy &&value)
 
StartInstanceRefreshRequestWithStrategy (const RefreshStrategy &value)
 
StartInstanceRefreshRequestWithStrategy (RefreshStrategy &&value)
 
const RefreshPreferencesGetPreferences () const
 
bool PreferencesHasBeenSet () const
 
void SetPreferences (const RefreshPreferences &value)
 
void SetPreferences (RefreshPreferences &&value)
 
StartInstanceRefreshRequestWithPreferences (const RefreshPreferences &value)
 
StartInstanceRefreshRequestWithPreferences (RefreshPreferences &&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 23 of file StartInstanceRefreshRequest.h.

Constructor & Destructor Documentation

◆ StartInstanceRefreshRequest()

Aws::AutoScaling::Model::StartInstanceRefreshRequest::StartInstanceRefreshRequest ( )

Member Function Documentation

◆ AutoScalingGroupNameHasBeenSet()

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

The name of the Auto Scaling group.

Definition at line 49 of file StartInstanceRefreshRequest.h.

◆ DumpBodyToUrl()

void Aws::AutoScaling::Model::StartInstanceRefreshRequest::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::StartInstanceRefreshRequest::GetAutoScalingGroupName ( ) const
inline

The name of the Auto Scaling group.

Definition at line 44 of file StartInstanceRefreshRequest.h.

◆ GetPreferences()

const RefreshPreferences& Aws::AutoScaling::Model::StartInstanceRefreshRequest::GetPreferences ( ) const
inline

Set of preferences associated with the instance refresh request.

If not provided, the default values are used. For MinHealthyPercentage, the default value is 90. For InstanceWarmup, the default is to use the value specified for the health check grace period for the Auto Scaling group.

For more information, see RefreshPreferences in the Amazon EC2 Auto Scaling API Reference.

Definition at line 159 of file StartInstanceRefreshRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file StartInstanceRefreshRequest.h.

◆ GetStrategy()

const RefreshStrategy& Aws::AutoScaling::Model::StartInstanceRefreshRequest::GetStrategy ( ) const
inline

The strategy to use for the instance refresh. The only valid value is Rolling.

A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration.

Definition at line 91 of file StartInstanceRefreshRequest.h.

◆ PreferencesHasBeenSet()

bool Aws::AutoScaling::Model::StartInstanceRefreshRequest::PreferencesHasBeenSet ( ) const
inline

Set of preferences associated with the instance refresh request.

If not provided, the default values are used. For MinHealthyPercentage, the default value is 90. For InstanceWarmup, the default is to use the value specified for the health check grace period for the Auto Scaling group.

For more information, see RefreshPreferences in the Amazon EC2 Auto Scaling API Reference.

Definition at line 171 of file StartInstanceRefreshRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAutoScalingGroupName() [1/3]

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

The name of the Auto Scaling group.

Definition at line 54 of file StartInstanceRefreshRequest.h.

◆ SetAutoScalingGroupName() [2/3]

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

The name of the Auto Scaling group.

Definition at line 59 of file StartInstanceRefreshRequest.h.

◆ SetAutoScalingGroupName() [3/3]

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

The name of the Auto Scaling group.

Definition at line 64 of file StartInstanceRefreshRequest.h.

◆ SetPreferences() [1/2]

void Aws::AutoScaling::Model::StartInstanceRefreshRequest::SetPreferences ( const RefreshPreferences value)
inline

Set of preferences associated with the instance refresh request.

If not provided, the default values are used. For MinHealthyPercentage, the default value is 90. For InstanceWarmup, the default is to use the value specified for the health check grace period for the Auto Scaling group.

For more information, see RefreshPreferences in the Amazon EC2 Auto Scaling API Reference.

Definition at line 183 of file StartInstanceRefreshRequest.h.

◆ SetPreferences() [2/2]

void Aws::AutoScaling::Model::StartInstanceRefreshRequest::SetPreferences ( RefreshPreferences &&  value)
inline

Set of preferences associated with the instance refresh request.

If not provided, the default values are used. For MinHealthyPercentage, the default value is 90. For InstanceWarmup, the default is to use the value specified for the health check grace period for the Auto Scaling group.

For more information, see RefreshPreferences in the Amazon EC2 Auto Scaling API Reference.

Definition at line 195 of file StartInstanceRefreshRequest.h.

◆ SetStrategy() [1/2]

void Aws::AutoScaling::Model::StartInstanceRefreshRequest::SetStrategy ( const RefreshStrategy value)
inline

The strategy to use for the instance refresh. The only valid value is Rolling.

A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration.

Definition at line 113 of file StartInstanceRefreshRequest.h.

◆ SetStrategy() [2/2]

void Aws::AutoScaling::Model::StartInstanceRefreshRequest::SetStrategy ( RefreshStrategy &&  value)
inline

The strategy to use for the instance refresh. The only valid value is Rolling.

A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration.

Definition at line 124 of file StartInstanceRefreshRequest.h.

◆ StrategyHasBeenSet()

bool Aws::AutoScaling::Model::StartInstanceRefreshRequest::StrategyHasBeenSet ( ) const
inline

The strategy to use for the instance refresh. The only valid value is Rolling.

A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration.

Definition at line 102 of file StartInstanceRefreshRequest.h.

◆ WithAutoScalingGroupName() [1/3]

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

The name of the Auto Scaling group.

Definition at line 69 of file StartInstanceRefreshRequest.h.

◆ WithAutoScalingGroupName() [2/3]

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

The name of the Auto Scaling group.

Definition at line 74 of file StartInstanceRefreshRequest.h.

◆ WithAutoScalingGroupName() [3/3]

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

The name of the Auto Scaling group.

Definition at line 79 of file StartInstanceRefreshRequest.h.

◆ WithPreferences() [1/2]

StartInstanceRefreshRequest& Aws::AutoScaling::Model::StartInstanceRefreshRequest::WithPreferences ( const RefreshPreferences value)
inline

Set of preferences associated with the instance refresh request.

If not provided, the default values are used. For MinHealthyPercentage, the default value is 90. For InstanceWarmup, the default is to use the value specified for the health check grace period for the Auto Scaling group.

For more information, see RefreshPreferences in the Amazon EC2 Auto Scaling API Reference.

Definition at line 207 of file StartInstanceRefreshRequest.h.

◆ WithPreferences() [2/2]

StartInstanceRefreshRequest& Aws::AutoScaling::Model::StartInstanceRefreshRequest::WithPreferences ( RefreshPreferences &&  value)
inline

Set of preferences associated with the instance refresh request.

If not provided, the default values are used. For MinHealthyPercentage, the default value is 90. For InstanceWarmup, the default is to use the value specified for the health check grace period for the Auto Scaling group.

For more information, see RefreshPreferences in the Amazon EC2 Auto Scaling API Reference.

Definition at line 219 of file StartInstanceRefreshRequest.h.

◆ WithStrategy() [1/2]

StartInstanceRefreshRequest& Aws::AutoScaling::Model::StartInstanceRefreshRequest::WithStrategy ( const RefreshStrategy value)
inline

The strategy to use for the instance refresh. The only valid value is Rolling.

A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration.

Definition at line 135 of file StartInstanceRefreshRequest.h.

◆ WithStrategy() [2/2]

StartInstanceRefreshRequest& Aws::AutoScaling::Model::StartInstanceRefreshRequest::WithStrategy ( RefreshStrategy &&  value)
inline

The strategy to use for the instance refresh. The only valid value is Rolling.

A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration.

Definition at line 146 of file StartInstanceRefreshRequest.h.


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