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

#include <PutWarmPoolRequest.h>

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

Public Member Functions

 PutWarmPoolRequest ()
 
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)
 
PutWarmPoolRequestWithAutoScalingGroupName (const Aws::String &value)
 
PutWarmPoolRequestWithAutoScalingGroupName (Aws::String &&value)
 
PutWarmPoolRequestWithAutoScalingGroupName (const char *value)
 
int GetMaxGroupPreparedCapacity () const
 
bool MaxGroupPreparedCapacityHasBeenSet () const
 
void SetMaxGroupPreparedCapacity (int value)
 
PutWarmPoolRequestWithMaxGroupPreparedCapacity (int value)
 
int GetMinSize () const
 
bool MinSizeHasBeenSet () const
 
void SetMinSize (int value)
 
PutWarmPoolRequestWithMinSize (int value)
 
const WarmPoolStateGetPoolState () const
 
bool PoolStateHasBeenSet () const
 
void SetPoolState (const WarmPoolState &value)
 
void SetPoolState (WarmPoolState &&value)
 
PutWarmPoolRequestWithPoolState (const WarmPoolState &value)
 
PutWarmPoolRequestWithPoolState (WarmPoolState &&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 22 of file PutWarmPoolRequest.h.

Constructor & Destructor Documentation

◆ PutWarmPoolRequest()

Aws::AutoScaling::Model::PutWarmPoolRequest::PutWarmPoolRequest ( )

Member Function Documentation

◆ AutoScalingGroupNameHasBeenSet()

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

The name of the Auto Scaling group.

Definition at line 48 of file PutWarmPoolRequest.h.

◆ DumpBodyToUrl()

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

The name of the Auto Scaling group.

Definition at line 43 of file PutWarmPoolRequest.h.

◆ GetMaxGroupPreparedCapacity()

int Aws::AutoScaling::Model::PutWarmPoolRequest::GetMaxGroupPreparedCapacity ( ) const
inline

Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity instead.

The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does the warm pool have an absolute size.

If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless you specify a value for MinSize. To remove a value that you previously set, include the property but specify -1 for the value.

Definition at line 100 of file PutWarmPoolRequest.h.

◆ GetMinSize()

int Aws::AutoScaling::Model::PutWarmPoolRequest::GetMinSize ( ) const
inline

Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.

Definition at line 171 of file PutWarmPoolRequest.h.

◆ GetPoolState()

const WarmPoolState& Aws::AutoScaling::Model::PutWarmPoolRequest::GetPoolState ( ) const
inline

Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

Definition at line 199 of file PutWarmPoolRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file PutWarmPoolRequest.h.

◆ MaxGroupPreparedCapacityHasBeenSet()

bool Aws::AutoScaling::Model::PutWarmPoolRequest::MaxGroupPreparedCapacityHasBeenSet ( ) const
inline

Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity instead.

The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does the warm pool have an absolute size.

If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless you specify a value for MinSize. To remove a value that you previously set, include the property but specify -1 for the value.

Definition at line 121 of file PutWarmPoolRequest.h.

◆ MinSizeHasBeenSet()

bool Aws::AutoScaling::Model::PutWarmPoolRequest::MinSizeHasBeenSet ( ) const
inline

Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.

Definition at line 178 of file PutWarmPoolRequest.h.

◆ PoolStateHasBeenSet()

bool Aws::AutoScaling::Model::PutWarmPoolRequest::PoolStateHasBeenSet ( ) const
inline

Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

Definition at line 205 of file PutWarmPoolRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAutoScalingGroupName() [1/3]

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

The name of the Auto Scaling group.

Definition at line 58 of file PutWarmPoolRequest.h.

◆ SetAutoScalingGroupName() [2/3]

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

The name of the Auto Scaling group.

Definition at line 53 of file PutWarmPoolRequest.h.

◆ SetAutoScalingGroupName() [3/3]

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

The name of the Auto Scaling group.

Definition at line 63 of file PutWarmPoolRequest.h.

◆ SetMaxGroupPreparedCapacity()

void Aws::AutoScaling::Model::PutWarmPoolRequest::SetMaxGroupPreparedCapacity ( int  value)
inline

Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity instead.

The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does the warm pool have an absolute size.

If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless you specify a value for MinSize. To remove a value that you previously set, include the property but specify -1 for the value.

Definition at line 142 of file PutWarmPoolRequest.h.

◆ SetMinSize()

void Aws::AutoScaling::Model::PutWarmPoolRequest::SetMinSize ( int  value)
inline

Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.

Definition at line 185 of file PutWarmPoolRequest.h.

◆ SetPoolState() [1/2]

void Aws::AutoScaling::Model::PutWarmPoolRequest::SetPoolState ( const WarmPoolState value)
inline

Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

Definition at line 211 of file PutWarmPoolRequest.h.

◆ SetPoolState() [2/2]

void Aws::AutoScaling::Model::PutWarmPoolRequest::SetPoolState ( WarmPoolState &&  value)
inline

Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

Definition at line 217 of file PutWarmPoolRequest.h.

◆ WithAutoScalingGroupName() [1/3]

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

The name of the Auto Scaling group.

Definition at line 73 of file PutWarmPoolRequest.h.

◆ WithAutoScalingGroupName() [2/3]

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

The name of the Auto Scaling group.

Definition at line 68 of file PutWarmPoolRequest.h.

◆ WithAutoScalingGroupName() [3/3]

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

The name of the Auto Scaling group.

Definition at line 78 of file PutWarmPoolRequest.h.

◆ WithMaxGroupPreparedCapacity()

PutWarmPoolRequest& Aws::AutoScaling::Model::PutWarmPoolRequest::WithMaxGroupPreparedCapacity ( int  value)
inline

Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity instead.

The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does the warm pool have an absolute size.

If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless you specify a value for MinSize. To remove a value that you previously set, include the property but specify -1 for the value.

Definition at line 163 of file PutWarmPoolRequest.h.

◆ WithMinSize()

PutWarmPoolRequest& Aws::AutoScaling::Model::PutWarmPoolRequest::WithMinSize ( int  value)
inline

Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.

Definition at line 192 of file PutWarmPoolRequest.h.

◆ WithPoolState() [1/2]

PutWarmPoolRequest& Aws::AutoScaling::Model::PutWarmPoolRequest::WithPoolState ( const WarmPoolState value)
inline

Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

Definition at line 223 of file PutWarmPoolRequest.h.

◆ WithPoolState() [2/2]

PutWarmPoolRequest& Aws::AutoScaling::Model::PutWarmPoolRequest::WithPoolState ( WarmPoolState &&  value)
inline

Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

Definition at line 229 of file PutWarmPoolRequest.h.


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