AWS SDK for C++  1.8.59
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::CloudFormation::Model::SignalResourceRequest Class Reference

#include <SignalResourceRequest.h>

+ Inheritance diagram for Aws::CloudFormation::Model::SignalResourceRequest:

Public Member Functions

 SignalResourceRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetStackName () const
 
bool StackNameHasBeenSet () const
 
void SetStackName (const Aws::String &value)
 
void SetStackName (Aws::String &&value)
 
void SetStackName (const char *value)
 
SignalResourceRequestWithStackName (const Aws::String &value)
 
SignalResourceRequestWithStackName (Aws::String &&value)
 
SignalResourceRequestWithStackName (const char *value)
 
const Aws::StringGetLogicalResourceId () const
 
bool LogicalResourceIdHasBeenSet () const
 
void SetLogicalResourceId (const Aws::String &value)
 
void SetLogicalResourceId (Aws::String &&value)
 
void SetLogicalResourceId (const char *value)
 
SignalResourceRequestWithLogicalResourceId (const Aws::String &value)
 
SignalResourceRequestWithLogicalResourceId (Aws::String &&value)
 
SignalResourceRequestWithLogicalResourceId (const char *value)
 
const Aws::StringGetUniqueId () const
 
bool UniqueIdHasBeenSet () const
 
void SetUniqueId (const Aws::String &value)
 
void SetUniqueId (Aws::String &&value)
 
void SetUniqueId (const char *value)
 
SignalResourceRequestWithUniqueId (const Aws::String &value)
 
SignalResourceRequestWithUniqueId (Aws::String &&value)
 
SignalResourceRequestWithUniqueId (const char *value)
 
const ResourceSignalStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const ResourceSignalStatus &value)
 
void SetStatus (ResourceSignalStatus &&value)
 
SignalResourceRequestWithStatus (const ResourceSignalStatus &value)
 
SignalResourceRequestWithStatus (ResourceSignalStatus &&value)
 
- Public Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual ~CloudFormationRequest ()
 
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::CloudFormation::CloudFormationRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

The input for the SignalResource action.

See Also:

AWS API Reference

Definition at line 25 of file SignalResourceRequest.h.

Constructor & Destructor Documentation

◆ SignalResourceRequest()

Aws::CloudFormation::Model::SignalResourceRequest::SignalResourceRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::CloudFormation::Model::SignalResourceRequest::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.

◆ GetLogicalResourceId()

const Aws::String& Aws::CloudFormation::Model::SignalResourceRequest::GetLogicalResourceId ( ) const
inline

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

Definition at line 96 of file SignalResourceRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudFormation::Model::SignalResourceRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file SignalResourceRequest.h.

◆ GetStackName()

const Aws::String& Aws::CloudFormation::Model::SignalResourceRequest::GetStackName ( ) const
inline

The stack name or unique stack ID that includes the resource that you want to signal.

Definition at line 47 of file SignalResourceRequest.h.

◆ GetStatus()

const ResourceSignalStatus& Aws::CloudFormation::Model::SignalResourceRequest::GetStatus ( ) const
inline

The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

Definition at line 211 of file SignalResourceRequest.h.

◆ GetUniqueId()

const Aws::String& Aws::CloudFormation::Model::SignalResourceRequest::GetUniqueId ( ) const
inline

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

Definition at line 147 of file SignalResourceRequest.h.

◆ LogicalResourceIdHasBeenSet()

bool Aws::CloudFormation::Model::SignalResourceRequest::LogicalResourceIdHasBeenSet ( ) const
inline

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

Definition at line 102 of file SignalResourceRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudFormation::Model::SignalResourceRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLogicalResourceId() [1/3]

void Aws::CloudFormation::Model::SignalResourceRequest::SetLogicalResourceId ( const Aws::String value)
inline

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

Definition at line 108 of file SignalResourceRequest.h.

◆ SetLogicalResourceId() [2/3]

void Aws::CloudFormation::Model::SignalResourceRequest::SetLogicalResourceId ( Aws::String &&  value)
inline

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

Definition at line 114 of file SignalResourceRequest.h.

◆ SetLogicalResourceId() [3/3]

void Aws::CloudFormation::Model::SignalResourceRequest::SetLogicalResourceId ( const char *  value)
inline

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

Definition at line 120 of file SignalResourceRequest.h.

◆ SetStackName() [1/3]

void Aws::CloudFormation::Model::SignalResourceRequest::SetStackName ( const Aws::String value)
inline

The stack name or unique stack ID that includes the resource that you want to signal.

Definition at line 59 of file SignalResourceRequest.h.

◆ SetStackName() [2/3]

void Aws::CloudFormation::Model::SignalResourceRequest::SetStackName ( Aws::String &&  value)
inline

The stack name or unique stack ID that includes the resource that you want to signal.

Definition at line 65 of file SignalResourceRequest.h.

◆ SetStackName() [3/3]

void Aws::CloudFormation::Model::SignalResourceRequest::SetStackName ( const char *  value)
inline

The stack name or unique stack ID that includes the resource that you want to signal.

Definition at line 71 of file SignalResourceRequest.h.

◆ SetStatus() [1/2]

void Aws::CloudFormation::Model::SignalResourceRequest::SetStatus ( const ResourceSignalStatus value)
inline

The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

Definition at line 225 of file SignalResourceRequest.h.

◆ SetStatus() [2/2]

void Aws::CloudFormation::Model::SignalResourceRequest::SetStatus ( ResourceSignalStatus &&  value)
inline

The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

Definition at line 232 of file SignalResourceRequest.h.

◆ SetUniqueId() [1/3]

void Aws::CloudFormation::Model::SignalResourceRequest::SetUniqueId ( const Aws::String value)
inline

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

Definition at line 163 of file SignalResourceRequest.h.

◆ SetUniqueId() [2/3]

void Aws::CloudFormation::Model::SignalResourceRequest::SetUniqueId ( Aws::String &&  value)
inline

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

Definition at line 171 of file SignalResourceRequest.h.

◆ SetUniqueId() [3/3]

void Aws::CloudFormation::Model::SignalResourceRequest::SetUniqueId ( const char *  value)
inline

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

Definition at line 179 of file SignalResourceRequest.h.

◆ StackNameHasBeenSet()

bool Aws::CloudFormation::Model::SignalResourceRequest::StackNameHasBeenSet ( ) const
inline

The stack name or unique stack ID that includes the resource that you want to signal.

Definition at line 53 of file SignalResourceRequest.h.

◆ StatusHasBeenSet()

bool Aws::CloudFormation::Model::SignalResourceRequest::StatusHasBeenSet ( ) const
inline

The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

Definition at line 218 of file SignalResourceRequest.h.

◆ UniqueIdHasBeenSet()

bool Aws::CloudFormation::Model::SignalResourceRequest::UniqueIdHasBeenSet ( ) const
inline

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

Definition at line 155 of file SignalResourceRequest.h.

◆ WithLogicalResourceId() [1/3]

SignalResourceRequest& Aws::CloudFormation::Model::SignalResourceRequest::WithLogicalResourceId ( const Aws::String value)
inline

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

Definition at line 126 of file SignalResourceRequest.h.

◆ WithLogicalResourceId() [2/3]

SignalResourceRequest& Aws::CloudFormation::Model::SignalResourceRequest::WithLogicalResourceId ( Aws::String &&  value)
inline

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

Definition at line 132 of file SignalResourceRequest.h.

◆ WithLogicalResourceId() [3/3]

SignalResourceRequest& Aws::CloudFormation::Model::SignalResourceRequest::WithLogicalResourceId ( const char *  value)
inline

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

Definition at line 138 of file SignalResourceRequest.h.

◆ WithStackName() [1/3]

SignalResourceRequest& Aws::CloudFormation::Model::SignalResourceRequest::WithStackName ( const Aws::String value)
inline

The stack name or unique stack ID that includes the resource that you want to signal.

Definition at line 77 of file SignalResourceRequest.h.

◆ WithStackName() [2/3]

SignalResourceRequest& Aws::CloudFormation::Model::SignalResourceRequest::WithStackName ( Aws::String &&  value)
inline

The stack name or unique stack ID that includes the resource that you want to signal.

Definition at line 83 of file SignalResourceRequest.h.

◆ WithStackName() [3/3]

SignalResourceRequest& Aws::CloudFormation::Model::SignalResourceRequest::WithStackName ( const char *  value)
inline

The stack name or unique stack ID that includes the resource that you want to signal.

Definition at line 89 of file SignalResourceRequest.h.

◆ WithStatus() [1/2]

SignalResourceRequest& Aws::CloudFormation::Model::SignalResourceRequest::WithStatus ( const ResourceSignalStatus value)
inline

The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

Definition at line 239 of file SignalResourceRequest.h.

◆ WithStatus() [2/2]

SignalResourceRequest& Aws::CloudFormation::Model::SignalResourceRequest::WithStatus ( ResourceSignalStatus &&  value)
inline

The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

Definition at line 246 of file SignalResourceRequest.h.

◆ WithUniqueId() [1/3]

SignalResourceRequest& Aws::CloudFormation::Model::SignalResourceRequest::WithUniqueId ( const Aws::String value)
inline

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

Definition at line 187 of file SignalResourceRequest.h.

◆ WithUniqueId() [2/3]

SignalResourceRequest& Aws::CloudFormation::Model::SignalResourceRequest::WithUniqueId ( Aws::String &&  value)
inline

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

Definition at line 195 of file SignalResourceRequest.h.

◆ WithUniqueId() [3/3]

SignalResourceRequest& Aws::CloudFormation::Model::SignalResourceRequest::WithUniqueId ( const char *  value)
inline

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

Definition at line 203 of file SignalResourceRequest.h.


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