AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | List of all members
Aws::EventBridge::Model::PutRuleRequest Class Reference

#include <PutRuleRequest.h>

+ Inheritance diagram for Aws::EventBridge::Model::PutRuleRequest:

Public Member Functions

 PutRuleRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
PutRuleRequestWithName (const Aws::String &value)
 
PutRuleRequestWithName (Aws::String &&value)
 
PutRuleRequestWithName (const char *value)
 
const Aws::StringGetScheduleExpression () const
 
bool ScheduleExpressionHasBeenSet () const
 
void SetScheduleExpression (const Aws::String &value)
 
void SetScheduleExpression (Aws::String &&value)
 
void SetScheduleExpression (const char *value)
 
PutRuleRequestWithScheduleExpression (const Aws::String &value)
 
PutRuleRequestWithScheduleExpression (Aws::String &&value)
 
PutRuleRequestWithScheduleExpression (const char *value)
 
const Aws::StringGetEventPattern () const
 
bool EventPatternHasBeenSet () const
 
void SetEventPattern (const Aws::String &value)
 
void SetEventPattern (Aws::String &&value)
 
void SetEventPattern (const char *value)
 
PutRuleRequestWithEventPattern (const Aws::String &value)
 
PutRuleRequestWithEventPattern (Aws::String &&value)
 
PutRuleRequestWithEventPattern (const char *value)
 
const RuleStateGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const RuleState &value)
 
void SetState (RuleState &&value)
 
PutRuleRequestWithState (const RuleState &value)
 
PutRuleRequestWithState (RuleState &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
PutRuleRequestWithDescription (const Aws::String &value)
 
PutRuleRequestWithDescription (Aws::String &&value)
 
PutRuleRequestWithDescription (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)
 
PutRuleRequestWithRoleArn (const Aws::String &value)
 
PutRuleRequestWithRoleArn (Aws::String &&value)
 
PutRuleRequestWithRoleArn (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
PutRuleRequestWithTags (const Aws::Vector< Tag > &value)
 
PutRuleRequestWithTags (Aws::Vector< Tag > &&value)
 
PutRuleRequestAddTags (const Tag &value)
 
PutRuleRequestAddTags (Tag &&value)
 
const Aws::StringGetEventBusName () const
 
bool EventBusNameHasBeenSet () const
 
void SetEventBusName (const Aws::String &value)
 
void SetEventBusName (Aws::String &&value)
 
void SetEventBusName (const char *value)
 
PutRuleRequestWithEventBusName (const Aws::String &value)
 
PutRuleRequestWithEventBusName (Aws::String &&value)
 
PutRuleRequestWithEventBusName (const char *value)
 
- Public Member Functions inherited from Aws::EventBridge::EventBridgeRequest
virtual ~EventBridgeRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file PutRuleRequest.h.

Constructor & Destructor Documentation

◆ PutRuleRequest()

Aws::EventBridge::Model::PutRuleRequest::PutRuleRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::AddTags ( const Tag value)
inline

The list of key-value pairs to associate with the rule.

Definition at line 333 of file PutRuleRequest.h.

◆ AddTags() [2/2]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::AddTags ( Tag &&  value)
inline

The list of key-value pairs to associate with the rule.

Definition at line 338 of file PutRuleRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::EventBridge::Model::PutRuleRequest::DescriptionHasBeenSet ( ) const
inline

A description of the rule.

Definition at line 226 of file PutRuleRequest.h.

◆ EventBusNameHasBeenSet()

bool Aws::EventBridge::Model::PutRuleRequest::EventBusNameHasBeenSet ( ) const
inline

The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

Definition at line 351 of file PutRuleRequest.h.

◆ EventPatternHasBeenSet()

bool Aws::EventBridge::Model::PutRuleRequest::EventPatternHasBeenSet ( ) const
inline

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Definition at line 142 of file PutRuleRequest.h.

◆ GetDescription()

const Aws::String& Aws::EventBridge::Model::PutRuleRequest::GetDescription ( ) const
inline

A description of the rule.

Definition at line 221 of file PutRuleRequest.h.

◆ GetEventBusName()

const Aws::String& Aws::EventBridge::Model::PutRuleRequest::GetEventBusName ( ) const
inline

The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

Definition at line 345 of file PutRuleRequest.h.

◆ GetEventPattern()

const Aws::String& Aws::EventBridge::Model::PutRuleRequest::GetEventPattern ( ) const
inline

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Definition at line 135 of file PutRuleRequest.h.

◆ GetName()

const Aws::String& Aws::EventBridge::Model::PutRuleRequest::GetName ( ) const
inline

The name of the rule that you are creating or updating.

Definition at line 43 of file PutRuleRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::EventBridge::Model::PutRuleRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetRoleArn()

const Aws::String& Aws::EventBridge::Model::PutRuleRequest::GetRoleArn ( ) const
inline

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Definition at line 262 of file PutRuleRequest.h.

◆ GetScheduleExpression()

const Aws::String& Aws::EventBridge::Model::PutRuleRequest::GetScheduleExpression ( ) const
inline

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

Definition at line 85 of file PutRuleRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EventBridge::Model::PutRuleRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file PutRuleRequest.h.

◆ GetState()

const RuleState& Aws::EventBridge::Model::PutRuleRequest::GetState ( ) const
inline

Indicates whether the rule is enabled or disabled.

Definition at line 190 of file PutRuleRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::EventBridge::Model::PutRuleRequest::GetTags ( ) const
inline

The list of key-value pairs to associate with the rule.

Definition at line 303 of file PutRuleRequest.h.

◆ NameHasBeenSet()

bool Aws::EventBridge::Model::PutRuleRequest::NameHasBeenSet ( ) const
inline

The name of the rule that you are creating or updating.

Definition at line 48 of file PutRuleRequest.h.

◆ RoleArnHasBeenSet()

bool Aws::EventBridge::Model::PutRuleRequest::RoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Definition at line 267 of file PutRuleRequest.h.

◆ ScheduleExpressionHasBeenSet()

bool Aws::EventBridge::Model::PutRuleRequest::ScheduleExpressionHasBeenSet ( ) const
inline

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

Definition at line 91 of file PutRuleRequest.h.

◆ SerializePayload()

Aws::String Aws::EventBridge::Model::PutRuleRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::EventBridge::Model::PutRuleRequest::SetDescription ( const Aws::String value)
inline

A description of the rule.

Definition at line 231 of file PutRuleRequest.h.

◆ SetDescription() [2/3]

void Aws::EventBridge::Model::PutRuleRequest::SetDescription ( Aws::String &&  value)
inline

A description of the rule.

Definition at line 236 of file PutRuleRequest.h.

◆ SetDescription() [3/3]

void Aws::EventBridge::Model::PutRuleRequest::SetDescription ( const char *  value)
inline

A description of the rule.

Definition at line 241 of file PutRuleRequest.h.

◆ SetEventBusName() [1/3]

void Aws::EventBridge::Model::PutRuleRequest::SetEventBusName ( const Aws::String value)
inline

The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

Definition at line 357 of file PutRuleRequest.h.

◆ SetEventBusName() [2/3]

void Aws::EventBridge::Model::PutRuleRequest::SetEventBusName ( Aws::String &&  value)
inline

The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

Definition at line 363 of file PutRuleRequest.h.

◆ SetEventBusName() [3/3]

void Aws::EventBridge::Model::PutRuleRequest::SetEventBusName ( const char *  value)
inline

The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

Definition at line 369 of file PutRuleRequest.h.

◆ SetEventPattern() [1/3]

void Aws::EventBridge::Model::PutRuleRequest::SetEventPattern ( const Aws::String value)
inline

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Definition at line 149 of file PutRuleRequest.h.

◆ SetEventPattern() [2/3]

void Aws::EventBridge::Model::PutRuleRequest::SetEventPattern ( Aws::String &&  value)
inline

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Definition at line 156 of file PutRuleRequest.h.

◆ SetEventPattern() [3/3]

void Aws::EventBridge::Model::PutRuleRequest::SetEventPattern ( const char *  value)
inline

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Definition at line 163 of file PutRuleRequest.h.

◆ SetName() [1/3]

void Aws::EventBridge::Model::PutRuleRequest::SetName ( const Aws::String value)
inline

The name of the rule that you are creating or updating.

Definition at line 53 of file PutRuleRequest.h.

◆ SetName() [2/3]

void Aws::EventBridge::Model::PutRuleRequest::SetName ( Aws::String &&  value)
inline

The name of the rule that you are creating or updating.

Definition at line 58 of file PutRuleRequest.h.

◆ SetName() [3/3]

void Aws::EventBridge::Model::PutRuleRequest::SetName ( const char *  value)
inline

The name of the rule that you are creating or updating.

Definition at line 63 of file PutRuleRequest.h.

◆ SetRoleArn() [1/3]

void Aws::EventBridge::Model::PutRuleRequest::SetRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Definition at line 272 of file PutRuleRequest.h.

◆ SetRoleArn() [2/3]

void Aws::EventBridge::Model::PutRuleRequest::SetRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Definition at line 277 of file PutRuleRequest.h.

◆ SetRoleArn() [3/3]

void Aws::EventBridge::Model::PutRuleRequest::SetRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Definition at line 282 of file PutRuleRequest.h.

◆ SetScheduleExpression() [1/3]

void Aws::EventBridge::Model::PutRuleRequest::SetScheduleExpression ( const Aws::String value)
inline

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

Definition at line 97 of file PutRuleRequest.h.

◆ SetScheduleExpression() [2/3]

void Aws::EventBridge::Model::PutRuleRequest::SetScheduleExpression ( Aws::String &&  value)
inline

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

Definition at line 103 of file PutRuleRequest.h.

◆ SetScheduleExpression() [3/3]

void Aws::EventBridge::Model::PutRuleRequest::SetScheduleExpression ( const char *  value)
inline

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

Definition at line 109 of file PutRuleRequest.h.

◆ SetState() [1/2]

void Aws::EventBridge::Model::PutRuleRequest::SetState ( const RuleState value)
inline

Indicates whether the rule is enabled or disabled.

Definition at line 200 of file PutRuleRequest.h.

◆ SetState() [2/2]

void Aws::EventBridge::Model::PutRuleRequest::SetState ( RuleState &&  value)
inline

Indicates whether the rule is enabled or disabled.

Definition at line 205 of file PutRuleRequest.h.

◆ SetTags() [1/2]

void Aws::EventBridge::Model::PutRuleRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

The list of key-value pairs to associate with the rule.

Definition at line 313 of file PutRuleRequest.h.

◆ SetTags() [2/2]

void Aws::EventBridge::Model::PutRuleRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

The list of key-value pairs to associate with the rule.

Definition at line 318 of file PutRuleRequest.h.

◆ StateHasBeenSet()

bool Aws::EventBridge::Model::PutRuleRequest::StateHasBeenSet ( ) const
inline

Indicates whether the rule is enabled or disabled.

Definition at line 195 of file PutRuleRequest.h.

◆ TagsHasBeenSet()

bool Aws::EventBridge::Model::PutRuleRequest::TagsHasBeenSet ( ) const
inline

The list of key-value pairs to associate with the rule.

Definition at line 308 of file PutRuleRequest.h.

◆ WithDescription() [1/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithDescription ( const Aws::String value)
inline

A description of the rule.

Definition at line 246 of file PutRuleRequest.h.

◆ WithDescription() [2/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithDescription ( Aws::String &&  value)
inline

A description of the rule.

Definition at line 251 of file PutRuleRequest.h.

◆ WithDescription() [3/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithDescription ( const char *  value)
inline

A description of the rule.

Definition at line 256 of file PutRuleRequest.h.

◆ WithEventBusName() [1/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithEventBusName ( const Aws::String value)
inline

The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

Definition at line 375 of file PutRuleRequest.h.

◆ WithEventBusName() [2/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithEventBusName ( Aws::String &&  value)
inline

The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

Definition at line 381 of file PutRuleRequest.h.

◆ WithEventBusName() [3/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithEventBusName ( const char *  value)
inline

The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

Definition at line 387 of file PutRuleRequest.h.

◆ WithEventPattern() [1/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithEventPattern ( const Aws::String value)
inline

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Definition at line 170 of file PutRuleRequest.h.

◆ WithEventPattern() [2/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithEventPattern ( Aws::String &&  value)
inline

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Definition at line 177 of file PutRuleRequest.h.

◆ WithEventPattern() [3/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithEventPattern ( const char *  value)
inline

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Definition at line 184 of file PutRuleRequest.h.

◆ WithName() [1/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithName ( const Aws::String value)
inline

The name of the rule that you are creating or updating.

Definition at line 68 of file PutRuleRequest.h.

◆ WithName() [2/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithName ( Aws::String &&  value)
inline

The name of the rule that you are creating or updating.

Definition at line 73 of file PutRuleRequest.h.

◆ WithName() [3/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithName ( const char *  value)
inline

The name of the rule that you are creating or updating.

Definition at line 78 of file PutRuleRequest.h.

◆ WithRoleArn() [1/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Definition at line 287 of file PutRuleRequest.h.

◆ WithRoleArn() [2/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Definition at line 292 of file PutRuleRequest.h.

◆ WithRoleArn() [3/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Definition at line 297 of file PutRuleRequest.h.

◆ WithScheduleExpression() [1/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithScheduleExpression ( const Aws::String value)
inline

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

Definition at line 115 of file PutRuleRequest.h.

◆ WithScheduleExpression() [2/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithScheduleExpression ( Aws::String &&  value)
inline

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

Definition at line 121 of file PutRuleRequest.h.

◆ WithScheduleExpression() [3/3]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithScheduleExpression ( const char *  value)
inline

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

Definition at line 127 of file PutRuleRequest.h.

◆ WithState() [1/2]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithState ( const RuleState value)
inline

Indicates whether the rule is enabled or disabled.

Definition at line 210 of file PutRuleRequest.h.

◆ WithState() [2/2]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithState ( RuleState &&  value)
inline

Indicates whether the rule is enabled or disabled.

Definition at line 215 of file PutRuleRequest.h.

◆ WithTags() [1/2]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

The list of key-value pairs to associate with the rule.

Definition at line 323 of file PutRuleRequest.h.

◆ WithTags() [2/2]

PutRuleRequest& Aws::EventBridge::Model::PutRuleRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

The list of key-value pairs to associate with the rule.

Definition at line 328 of file PutRuleRequest.h.


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