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

#include <PutLifecycleHookRequest.h>

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

Public Member Functions

 PutLifecycleHookRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetLifecycleHookName () const
 
bool LifecycleHookNameHasBeenSet () const
 
void SetLifecycleHookName (const Aws::String &value)
 
void SetLifecycleHookName (Aws::String &&value)
 
void SetLifecycleHookName (const char *value)
 
PutLifecycleHookRequestWithLifecycleHookName (const Aws::String &value)
 
PutLifecycleHookRequestWithLifecycleHookName (Aws::String &&value)
 
PutLifecycleHookRequestWithLifecycleHookName (const char *value)
 
const Aws::StringGetAutoScalingGroupName () const
 
bool AutoScalingGroupNameHasBeenSet () const
 
void SetAutoScalingGroupName (const Aws::String &value)
 
void SetAutoScalingGroupName (Aws::String &&value)
 
void SetAutoScalingGroupName (const char *value)
 
PutLifecycleHookRequestWithAutoScalingGroupName (const Aws::String &value)
 
PutLifecycleHookRequestWithAutoScalingGroupName (Aws::String &&value)
 
PutLifecycleHookRequestWithAutoScalingGroupName (const char *value)
 
const Aws::StringGetLifecycleTransition () const
 
bool LifecycleTransitionHasBeenSet () const
 
void SetLifecycleTransition (const Aws::String &value)
 
void SetLifecycleTransition (Aws::String &&value)
 
void SetLifecycleTransition (const char *value)
 
PutLifecycleHookRequestWithLifecycleTransition (const Aws::String &value)
 
PutLifecycleHookRequestWithLifecycleTransition (Aws::String &&value)
 
PutLifecycleHookRequestWithLifecycleTransition (const char *value)
 
const Aws::StringGetRoleARN () const
 
bool RoleARNHasBeenSet () const
 
void SetRoleARN (const Aws::String &value)
 
void SetRoleARN (Aws::String &&value)
 
void SetRoleARN (const char *value)
 
PutLifecycleHookRequestWithRoleARN (const Aws::String &value)
 
PutLifecycleHookRequestWithRoleARN (Aws::String &&value)
 
PutLifecycleHookRequestWithRoleARN (const char *value)
 
const Aws::StringGetNotificationTargetARN () const
 
bool NotificationTargetARNHasBeenSet () const
 
void SetNotificationTargetARN (const Aws::String &value)
 
void SetNotificationTargetARN (Aws::String &&value)
 
void SetNotificationTargetARN (const char *value)
 
PutLifecycleHookRequestWithNotificationTargetARN (const Aws::String &value)
 
PutLifecycleHookRequestWithNotificationTargetARN (Aws::String &&value)
 
PutLifecycleHookRequestWithNotificationTargetARN (const char *value)
 
const Aws::StringGetNotificationMetadata () const
 
bool NotificationMetadataHasBeenSet () const
 
void SetNotificationMetadata (const Aws::String &value)
 
void SetNotificationMetadata (Aws::String &&value)
 
void SetNotificationMetadata (const char *value)
 
PutLifecycleHookRequestWithNotificationMetadata (const Aws::String &value)
 
PutLifecycleHookRequestWithNotificationMetadata (Aws::String &&value)
 
PutLifecycleHookRequestWithNotificationMetadata (const char *value)
 
int GetHeartbeatTimeout () const
 
bool HeartbeatTimeoutHasBeenSet () const
 
void SetHeartbeatTimeout (int value)
 
PutLifecycleHookRequestWithHeartbeatTimeout (int value)
 
const Aws::StringGetDefaultResult () const
 
bool DefaultResultHasBeenSet () const
 
void SetDefaultResult (const Aws::String &value)
 
void SetDefaultResult (Aws::String &&value)
 
void SetDefaultResult (const char *value)
 
PutLifecycleHookRequestWithDefaultResult (const Aws::String &value)
 
PutLifecycleHookRequestWithDefaultResult (Aws::String &&value)
 
PutLifecycleHookRequestWithDefaultResult (const char *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 PutLifecycleHookRequest.h.

Constructor & Destructor Documentation

◆ PutLifecycleHookRequest()

Aws::AutoScaling::Model::PutLifecycleHookRequest::PutLifecycleHookRequest ( )

Member Function Documentation

◆ AutoScalingGroupNameHasBeenSet()

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

The name of the Auto Scaling group.

Definition at line 88 of file PutLifecycleHookRequest.h.

◆ DefaultResultHasBeenSet()

bool Aws::AutoScaling::Model::PutLifecycleHookRequest::DefaultResultHasBeenSet ( ) const
inline

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

Definition at line 460 of file PutLifecycleHookRequest.h.

◆ DumpBodyToUrl()

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

The name of the Auto Scaling group.

Definition at line 83 of file PutLifecycleHookRequest.h.

◆ GetDefaultResult()

const Aws::String& Aws::AutoScaling::Model::PutLifecycleHookRequest::GetDefaultResult ( ) const
inline

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

Definition at line 452 of file PutLifecycleHookRequest.h.

◆ GetHeartbeatTimeout()

int Aws::AutoScaling::Model::PutLifecycleHookRequest::GetHeartbeatTimeout ( ) const
inline

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling the RecordLifecycleActionHeartbeat API.

Definition at line 413 of file PutLifecycleHookRequest.h.

◆ GetLifecycleHookName()

const Aws::String& Aws::AutoScaling::Model::PutLifecycleHookRequest::GetLifecycleHookName ( ) const
inline

The name of the lifecycle hook.

Definition at line 42 of file PutLifecycleHookRequest.h.

◆ GetLifecycleTransition()

const Aws::String& Aws::AutoScaling::Model::PutLifecycleHookRequest::GetLifecycleTransition ( ) const
inline

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 127 of file PutLifecycleHookRequest.h.

◆ GetNotificationMetadata()

const Aws::String& Aws::AutoScaling::Model::PutLifecycleHookRequest::GetNotificationMetadata ( ) const
inline

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

Definition at line 360 of file PutLifecycleHookRequest.h.

◆ GetNotificationTargetARN()

const Aws::String& Aws::AutoScaling::Model::PutLifecycleHookRequest::GetNotificationTargetARN ( ) const
inline

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Definition at line 262 of file PutLifecycleHookRequest.h.

◆ GetRoleARN()

const Aws::String& Aws::AutoScaling::Model::PutLifecycleHookRequest::GetRoleARN ( ) const
inline

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 192 of file PutLifecycleHookRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file PutLifecycleHookRequest.h.

◆ HeartbeatTimeoutHasBeenSet()

bool Aws::AutoScaling::Model::PutLifecycleHookRequest::HeartbeatTimeoutHasBeenSet ( ) const
inline

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling the RecordLifecycleActionHeartbeat API.

Definition at line 423 of file PutLifecycleHookRequest.h.

◆ LifecycleHookNameHasBeenSet()

bool Aws::AutoScaling::Model::PutLifecycleHookRequest::LifecycleHookNameHasBeenSet ( ) const
inline

The name of the lifecycle hook.

Definition at line 47 of file PutLifecycleHookRequest.h.

◆ LifecycleTransitionHasBeenSet()

bool Aws::AutoScaling::Model::PutLifecycleHookRequest::LifecycleTransitionHasBeenSet ( ) const
inline

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 135 of file PutLifecycleHookRequest.h.

◆ NotificationMetadataHasBeenSet()

bool Aws::AutoScaling::Model::PutLifecycleHookRequest::NotificationMetadataHasBeenSet ( ) const
inline

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

Definition at line 366 of file PutLifecycleHookRequest.h.

◆ NotificationTargetARNHasBeenSet()

bool Aws::AutoScaling::Model::PutLifecycleHookRequest::NotificationTargetARNHasBeenSet ( ) const
inline

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Definition at line 275 of file PutLifecycleHookRequest.h.

◆ RoleARNHasBeenSet()

bool Aws::AutoScaling::Model::PutLifecycleHookRequest::RoleARNHasBeenSet ( ) const
inline

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 200 of file PutLifecycleHookRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAutoScalingGroupName() [1/3]

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

The name of the Auto Scaling group.

Definition at line 93 of file PutLifecycleHookRequest.h.

◆ SetAutoScalingGroupName() [2/3]

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

The name of the Auto Scaling group.

Definition at line 98 of file PutLifecycleHookRequest.h.

◆ SetAutoScalingGroupName() [3/3]

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

The name of the Auto Scaling group.

Definition at line 103 of file PutLifecycleHookRequest.h.

◆ SetDefaultResult() [1/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetDefaultResult ( const Aws::String value)
inline

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

Definition at line 468 of file PutLifecycleHookRequest.h.

◆ SetDefaultResult() [2/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetDefaultResult ( Aws::String &&  value)
inline

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

Definition at line 476 of file PutLifecycleHookRequest.h.

◆ SetDefaultResult() [3/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetDefaultResult ( const char *  value)
inline

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

Definition at line 484 of file PutLifecycleHookRequest.h.

◆ SetHeartbeatTimeout()

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetHeartbeatTimeout ( int  value)
inline

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling the RecordLifecycleActionHeartbeat API.

Definition at line 433 of file PutLifecycleHookRequest.h.

◆ SetLifecycleHookName() [1/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetLifecycleHookName ( const Aws::String value)
inline

The name of the lifecycle hook.

Definition at line 52 of file PutLifecycleHookRequest.h.

◆ SetLifecycleHookName() [2/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetLifecycleHookName ( Aws::String &&  value)
inline

The name of the lifecycle hook.

Definition at line 57 of file PutLifecycleHookRequest.h.

◆ SetLifecycleHookName() [3/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetLifecycleHookName ( const char *  value)
inline

The name of the lifecycle hook.

Definition at line 62 of file PutLifecycleHookRequest.h.

◆ SetLifecycleTransition() [1/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetLifecycleTransition ( const Aws::String value)
inline

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 143 of file PutLifecycleHookRequest.h.

◆ SetLifecycleTransition() [2/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetLifecycleTransition ( Aws::String &&  value)
inline

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 151 of file PutLifecycleHookRequest.h.

◆ SetLifecycleTransition() [3/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetLifecycleTransition ( const char *  value)
inline

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 159 of file PutLifecycleHookRequest.h.

◆ SetNotificationMetadata() [1/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetNotificationMetadata ( const Aws::String value)
inline

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

Definition at line 372 of file PutLifecycleHookRequest.h.

◆ SetNotificationMetadata() [2/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetNotificationMetadata ( Aws::String &&  value)
inline

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

Definition at line 378 of file PutLifecycleHookRequest.h.

◆ SetNotificationMetadata() [3/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetNotificationMetadata ( const char *  value)
inline

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

Definition at line 384 of file PutLifecycleHookRequest.h.

◆ SetNotificationTargetARN() [1/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetNotificationTargetARN ( const Aws::String value)
inline

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Definition at line 288 of file PutLifecycleHookRequest.h.

◆ SetNotificationTargetARN() [2/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetNotificationTargetARN ( Aws::String &&  value)
inline

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Definition at line 301 of file PutLifecycleHookRequest.h.

◆ SetNotificationTargetARN() [3/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetNotificationTargetARN ( const char *  value)
inline

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Definition at line 314 of file PutLifecycleHookRequest.h.

◆ SetRoleARN() [1/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetRoleARN ( const Aws::String value)
inline

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 208 of file PutLifecycleHookRequest.h.

◆ SetRoleARN() [2/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetRoleARN ( Aws::String &&  value)
inline

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 216 of file PutLifecycleHookRequest.h.

◆ SetRoleARN() [3/3]

void Aws::AutoScaling::Model::PutLifecycleHookRequest::SetRoleARN ( const char *  value)
inline

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 224 of file PutLifecycleHookRequest.h.

◆ WithAutoScalingGroupName() [1/3]

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

The name of the Auto Scaling group.

Definition at line 108 of file PutLifecycleHookRequest.h.

◆ WithAutoScalingGroupName() [2/3]

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

The name of the Auto Scaling group.

Definition at line 113 of file PutLifecycleHookRequest.h.

◆ WithAutoScalingGroupName() [3/3]

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

The name of the Auto Scaling group.

Definition at line 118 of file PutLifecycleHookRequest.h.

◆ WithDefaultResult() [1/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithDefaultResult ( const Aws::String value)
inline

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

Definition at line 492 of file PutLifecycleHookRequest.h.

◆ WithDefaultResult() [2/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithDefaultResult ( Aws::String &&  value)
inline

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

Definition at line 500 of file PutLifecycleHookRequest.h.

◆ WithDefaultResult() [3/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithDefaultResult ( const char *  value)
inline

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

Definition at line 508 of file PutLifecycleHookRequest.h.

◆ WithHeartbeatTimeout()

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithHeartbeatTimeout ( int  value)
inline

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling the RecordLifecycleActionHeartbeat API.

Definition at line 443 of file PutLifecycleHookRequest.h.

◆ WithLifecycleHookName() [1/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithLifecycleHookName ( const Aws::String value)
inline

The name of the lifecycle hook.

Definition at line 67 of file PutLifecycleHookRequest.h.

◆ WithLifecycleHookName() [2/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithLifecycleHookName ( Aws::String &&  value)
inline

The name of the lifecycle hook.

Definition at line 72 of file PutLifecycleHookRequest.h.

◆ WithLifecycleHookName() [3/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithLifecycleHookName ( const char *  value)
inline

The name of the lifecycle hook.

Definition at line 77 of file PutLifecycleHookRequest.h.

◆ WithLifecycleTransition() [1/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithLifecycleTransition ( const Aws::String value)
inline

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 167 of file PutLifecycleHookRequest.h.

◆ WithLifecycleTransition() [2/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithLifecycleTransition ( Aws::String &&  value)
inline

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 175 of file PutLifecycleHookRequest.h.

◆ WithLifecycleTransition() [3/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithLifecycleTransition ( const char *  value)
inline

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 183 of file PutLifecycleHookRequest.h.

◆ WithNotificationMetadata() [1/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithNotificationMetadata ( const Aws::String value)
inline

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

Definition at line 390 of file PutLifecycleHookRequest.h.

◆ WithNotificationMetadata() [2/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithNotificationMetadata ( Aws::String &&  value)
inline

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

Definition at line 396 of file PutLifecycleHookRequest.h.

◆ WithNotificationMetadata() [3/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithNotificationMetadata ( const char *  value)
inline

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

Definition at line 402 of file PutLifecycleHookRequest.h.

◆ WithNotificationTargetARN() [1/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithNotificationTargetARN ( const Aws::String value)
inline

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Definition at line 327 of file PutLifecycleHookRequest.h.

◆ WithNotificationTargetARN() [2/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithNotificationTargetARN ( Aws::String &&  value)
inline

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Definition at line 340 of file PutLifecycleHookRequest.h.

◆ WithNotificationTargetARN() [3/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithNotificationTargetARN ( const char *  value)
inline

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Definition at line 353 of file PutLifecycleHookRequest.h.

◆ WithRoleARN() [1/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithRoleARN ( const Aws::String value)
inline

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 232 of file PutLifecycleHookRequest.h.

◆ WithRoleARN() [2/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithRoleARN ( Aws::String &&  value)
inline

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 240 of file PutLifecycleHookRequest.h.

◆ WithRoleARN() [3/3]

PutLifecycleHookRequest& Aws::AutoScaling::Model::PutLifecycleHookRequest::WithRoleARN ( const char *  value)
inline

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Required for new lifecycle hooks, but optional when updating existing hooks.

Definition at line 248 of file PutLifecycleHookRequest.h.


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