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

#include <Rule.h>

Public Member Functions

 Rule ()
 
 Rule (Aws::Utils::Json::JsonView jsonValue)
 
Ruleoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
RuleWithName (const Aws::String &value)
 
RuleWithName (Aws::String &&value)
 
RuleWithName (const char *value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
RuleWithArn (const Aws::String &value)
 
RuleWithArn (Aws::String &&value)
 
RuleWithArn (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)
 
RuleWithEventPattern (const Aws::String &value)
 
RuleWithEventPattern (Aws::String &&value)
 
RuleWithEventPattern (const char *value)
 
const RuleStateGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const RuleState &value)
 
void SetState (RuleState &&value)
 
RuleWithState (const RuleState &value)
 
RuleWithState (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)
 
RuleWithDescription (const Aws::String &value)
 
RuleWithDescription (Aws::String &&value)
 
RuleWithDescription (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)
 
RuleWithScheduleExpression (const Aws::String &value)
 
RuleWithScheduleExpression (Aws::String &&value)
 
RuleWithScheduleExpression (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)
 
RuleWithRoleArn (const Aws::String &value)
 
RuleWithRoleArn (Aws::String &&value)
 
RuleWithRoleArn (const char *value)
 
const Aws::StringGetManagedBy () const
 
bool ManagedByHasBeenSet () const
 
void SetManagedBy (const Aws::String &value)
 
void SetManagedBy (Aws::String &&value)
 
void SetManagedBy (const char *value)
 
RuleWithManagedBy (const Aws::String &value)
 
RuleWithManagedBy (Aws::String &&value)
 
RuleWithManagedBy (const char *value)
 
const Aws::StringGetEventBusName () const
 
bool EventBusNameHasBeenSet () const
 
void SetEventBusName (const Aws::String &value)
 
void SetEventBusName (Aws::String &&value)
 
void SetEventBusName (const char *value)
 
RuleWithEventBusName (const Aws::String &value)
 
RuleWithEventBusName (Aws::String &&value)
 
RuleWithEventBusName (const char *value)
 

Detailed Description

Contains information about a rule in Amazon EventBridge.

See Also:

AWS API Reference

Definition at line 33 of file Rule.h.

Constructor & Destructor Documentation

◆ Rule() [1/2]

Aws::EventBridge::Model::Rule::Rule ( )

◆ Rule() [2/2]

Aws::EventBridge::Model::Rule::Rule ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ArnHasBeenSet()

bool Aws::EventBridge::Model::Rule::ArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the rule.

Definition at line 91 of file Rule.h.

◆ DescriptionHasBeenSet()

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

The description of the rule.

Definition at line 220 of file Rule.h.

◆ EventBusNameHasBeenSet()

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

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

Definition at line 410 of file Rule.h.

◆ EventPatternHasBeenSet()

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

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

Definition at line 136 of file Rule.h.

◆ GetArn()

const Aws::String& Aws::EventBridge::Model::Rule::GetArn ( ) const
inline

The Amazon Resource Name (ARN) of the rule.

Definition at line 86 of file Rule.h.

◆ GetDescription()

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

The description of the rule.

Definition at line 215 of file Rule.h.

◆ GetEventBusName()

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

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

Definition at line 404 of file Rule.h.

◆ GetEventPattern()

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

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

Definition at line 129 of file Rule.h.

◆ GetManagedBy()

const Aws::String& Aws::EventBridge::Model::Rule::GetManagedBy ( ) const
inline

If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.

Definition at line 355 of file Rule.h.

◆ GetName()

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

The name of the rule.

Definition at line 45 of file Rule.h.

◆ GetRoleArn()

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

The Amazon Resource Name (ARN) of the role that is used for target invocation.

Definition at line 306 of file Rule.h.

◆ GetScheduleExpression()

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

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

Definition at line 257 of file Rule.h.

◆ GetState()

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

The state of the rule.

Definition at line 184 of file Rule.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EventBridge::Model::Rule::Jsonize ( ) const

◆ ManagedByHasBeenSet()

bool Aws::EventBridge::Model::Rule::ManagedByHasBeenSet ( ) const
inline

If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.

Definition at line 361 of file Rule.h.

◆ NameHasBeenSet()

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

The name of the rule.

Definition at line 50 of file Rule.h.

◆ operator=()

Rule& Aws::EventBridge::Model::Rule::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the role that is used for target invocation.

Definition at line 312 of file Rule.h.

◆ ScheduleExpressionHasBeenSet()

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

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

Definition at line 263 of file Rule.h.

◆ SetArn() [1/3]

void Aws::EventBridge::Model::Rule::SetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the rule.

Definition at line 96 of file Rule.h.

◆ SetArn() [2/3]

void Aws::EventBridge::Model::Rule::SetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the rule.

Definition at line 101 of file Rule.h.

◆ SetArn() [3/3]

void Aws::EventBridge::Model::Rule::SetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the rule.

Definition at line 106 of file Rule.h.

◆ SetDescription() [1/3]

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

The description of the rule.

Definition at line 225 of file Rule.h.

◆ SetDescription() [2/3]

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

The description of the rule.

Definition at line 230 of file Rule.h.

◆ SetDescription() [3/3]

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

The description of the rule.

Definition at line 235 of file Rule.h.

◆ SetEventBusName() [1/3]

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

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

Definition at line 416 of file Rule.h.

◆ SetEventBusName() [2/3]

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

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

Definition at line 422 of file Rule.h.

◆ SetEventBusName() [3/3]

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

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

Definition at line 428 of file Rule.h.

◆ SetEventPattern() [1/3]

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

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

Definition at line 143 of file Rule.h.

◆ SetEventPattern() [2/3]

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

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

Definition at line 150 of file Rule.h.

◆ SetEventPattern() [3/3]

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

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

Definition at line 157 of file Rule.h.

◆ SetManagedBy() [1/3]

void Aws::EventBridge::Model::Rule::SetManagedBy ( const Aws::String value)
inline

If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.

Definition at line 367 of file Rule.h.

◆ SetManagedBy() [2/3]

void Aws::EventBridge::Model::Rule::SetManagedBy ( Aws::String &&  value)
inline

If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.

Definition at line 373 of file Rule.h.

◆ SetManagedBy() [3/3]

void Aws::EventBridge::Model::Rule::SetManagedBy ( const char *  value)
inline

If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.

Definition at line 379 of file Rule.h.

◆ SetName() [1/3]

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

The name of the rule.

Definition at line 55 of file Rule.h.

◆ SetName() [2/3]

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

The name of the rule.

Definition at line 60 of file Rule.h.

◆ SetName() [3/3]

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

The name of the rule.

Definition at line 65 of file Rule.h.

◆ SetRoleArn() [1/3]

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

The Amazon Resource Name (ARN) of the role that is used for target invocation.

Definition at line 318 of file Rule.h.

◆ SetRoleArn() [2/3]

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

The Amazon Resource Name (ARN) of the role that is used for target invocation.

Definition at line 324 of file Rule.h.

◆ SetRoleArn() [3/3]

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

The Amazon Resource Name (ARN) of the role that is used for target invocation.

Definition at line 330 of file Rule.h.

◆ SetScheduleExpression() [1/3]

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

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

Definition at line 269 of file Rule.h.

◆ SetScheduleExpression() [2/3]

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

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

Definition at line 275 of file Rule.h.

◆ SetScheduleExpression() [3/3]

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

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

Definition at line 281 of file Rule.h.

◆ SetState() [1/2]

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

The state of the rule.

Definition at line 194 of file Rule.h.

◆ SetState() [2/2]

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

The state of the rule.

Definition at line 199 of file Rule.h.

◆ StateHasBeenSet()

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

The state of the rule.

Definition at line 189 of file Rule.h.

◆ WithArn() [1/3]

Rule& Aws::EventBridge::Model::Rule::WithArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the rule.

Definition at line 111 of file Rule.h.

◆ WithArn() [2/3]

Rule& Aws::EventBridge::Model::Rule::WithArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the rule.

Definition at line 116 of file Rule.h.

◆ WithArn() [3/3]

Rule& Aws::EventBridge::Model::Rule::WithArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the rule.

Definition at line 121 of file Rule.h.

◆ WithDescription() [1/3]

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

The description of the rule.

Definition at line 240 of file Rule.h.

◆ WithDescription() [2/3]

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

The description of the rule.

Definition at line 245 of file Rule.h.

◆ WithDescription() [3/3]

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

The description of the rule.

Definition at line 250 of file Rule.h.

◆ WithEventBusName() [1/3]

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

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

Definition at line 434 of file Rule.h.

◆ WithEventBusName() [2/3]

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

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

Definition at line 440 of file Rule.h.

◆ WithEventBusName() [3/3]

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

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

Definition at line 446 of file Rule.h.

◆ WithEventPattern() [1/3]

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

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

Definition at line 164 of file Rule.h.

◆ WithEventPattern() [2/3]

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

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

Definition at line 171 of file Rule.h.

◆ WithEventPattern() [3/3]

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

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

Definition at line 178 of file Rule.h.

◆ WithManagedBy() [1/3]

Rule& Aws::EventBridge::Model::Rule::WithManagedBy ( const Aws::String value)
inline

If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.

Definition at line 385 of file Rule.h.

◆ WithManagedBy() [2/3]

Rule& Aws::EventBridge::Model::Rule::WithManagedBy ( Aws::String &&  value)
inline

If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.

Definition at line 391 of file Rule.h.

◆ WithManagedBy() [3/3]

Rule& Aws::EventBridge::Model::Rule::WithManagedBy ( const char *  value)
inline

If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.

Definition at line 397 of file Rule.h.

◆ WithName() [1/3]

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

The name of the rule.

Definition at line 70 of file Rule.h.

◆ WithName() [2/3]

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

The name of the rule.

Definition at line 75 of file Rule.h.

◆ WithName() [3/3]

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

The name of the rule.

Definition at line 80 of file Rule.h.

◆ WithRoleArn() [1/3]

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

The Amazon Resource Name (ARN) of the role that is used for target invocation.

Definition at line 336 of file Rule.h.

◆ WithRoleArn() [2/3]

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

The Amazon Resource Name (ARN) of the role that is used for target invocation.

Definition at line 342 of file Rule.h.

◆ WithRoleArn() [3/3]

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

The Amazon Resource Name (ARN) of the role that is used for target invocation.

Definition at line 348 of file Rule.h.

◆ WithScheduleExpression() [1/3]

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

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

Definition at line 287 of file Rule.h.

◆ WithScheduleExpression() [2/3]

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

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

Definition at line 293 of file Rule.h.

◆ WithScheduleExpression() [3/3]

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

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

Definition at line 299 of file Rule.h.

◆ WithState() [1/2]

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

The state of the rule.

Definition at line 204 of file Rule.h.

◆ WithState() [2/2]

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

The state of the rule.

Definition at line 209 of file Rule.h.


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