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

#include <DescribeRuleResult.h>

Public Member Functions

 DescribeRuleResult ()
 
 DescribeRuleResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeRuleResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
DescribeRuleResultWithName (const Aws::String &value)
 
DescribeRuleResultWithName (Aws::String &&value)
 
DescribeRuleResultWithName (const char *value)
 
const Aws::StringGetArn () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
DescribeRuleResultWithArn (const Aws::String &value)
 
DescribeRuleResultWithArn (Aws::String &&value)
 
DescribeRuleResultWithArn (const char *value)
 
const Aws::StringGetEventPattern () const
 
void SetEventPattern (const Aws::String &value)
 
void SetEventPattern (Aws::String &&value)
 
void SetEventPattern (const char *value)
 
DescribeRuleResultWithEventPattern (const Aws::String &value)
 
DescribeRuleResultWithEventPattern (Aws::String &&value)
 
DescribeRuleResultWithEventPattern (const char *value)
 
const Aws::StringGetScheduleExpression () const
 
void SetScheduleExpression (const Aws::String &value)
 
void SetScheduleExpression (Aws::String &&value)
 
void SetScheduleExpression (const char *value)
 
DescribeRuleResultWithScheduleExpression (const Aws::String &value)
 
DescribeRuleResultWithScheduleExpression (Aws::String &&value)
 
DescribeRuleResultWithScheduleExpression (const char *value)
 
const RuleStateGetState () const
 
void SetState (const RuleState &value)
 
void SetState (RuleState &&value)
 
DescribeRuleResultWithState (const RuleState &value)
 
DescribeRuleResultWithState (RuleState &&value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
DescribeRuleResultWithDescription (const Aws::String &value)
 
DescribeRuleResultWithDescription (Aws::String &&value)
 
DescribeRuleResultWithDescription (const char *value)
 
const Aws::StringGetRoleArn () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
DescribeRuleResultWithRoleArn (const Aws::String &value)
 
DescribeRuleResultWithRoleArn (Aws::String &&value)
 
DescribeRuleResultWithRoleArn (const char *value)
 
const Aws::StringGetManagedBy () const
 
void SetManagedBy (const Aws::String &value)
 
void SetManagedBy (Aws::String &&value)
 
void SetManagedBy (const char *value)
 
DescribeRuleResultWithManagedBy (const Aws::String &value)
 
DescribeRuleResultWithManagedBy (Aws::String &&value)
 
DescribeRuleResultWithManagedBy (const char *value)
 
const Aws::StringGetEventBusName () const
 
void SetEventBusName (const Aws::String &value)
 
void SetEventBusName (Aws::String &&value)
 
void SetEventBusName (const char *value)
 
DescribeRuleResultWithEventBusName (const Aws::String &value)
 
DescribeRuleResultWithEventBusName (Aws::String &&value)
 
DescribeRuleResultWithEventBusName (const char *value)
 
const Aws::StringGetCreatedBy () const
 
void SetCreatedBy (const Aws::String &value)
 
void SetCreatedBy (Aws::String &&value)
 
void SetCreatedBy (const char *value)
 
DescribeRuleResultWithCreatedBy (const Aws::String &value)
 
DescribeRuleResultWithCreatedBy (Aws::String &&value)
 
DescribeRuleResultWithCreatedBy (const char *value)
 

Detailed Description

Definition at line 28 of file DescribeRuleResult.h.

Constructor & Destructor Documentation

◆ DescribeRuleResult() [1/2]

Aws::EventBridge::Model::DescribeRuleResult::DescribeRuleResult ( )

◆ DescribeRuleResult() [2/2]

Aws::EventBridge::Model::DescribeRuleResult::DescribeRuleResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetArn()

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

The Amazon Resource Name (ARN) of the rule.

Definition at line 75 of file DescribeRuleResult.h.

◆ GetCreatedBy()

const Aws::String& Aws::EventBridge::Model::DescribeRuleResult::GetCreatedBy ( ) const
inline

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

Definition at line 385 of file DescribeRuleResult.h.

◆ GetDescription()

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

The description of the rule.

Definition at line 230 of file DescribeRuleResult.h.

◆ GetEventBusName()

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

The name of the event bus associated with the rule.

Definition at line 345 of file DescribeRuleResult.h.

◆ GetEventPattern()

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

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

Definition at line 113 of file DescribeRuleResult.h.

◆ GetManagedBy()

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

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

Definition at line 303 of file DescribeRuleResult.h.

◆ GetName()

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

The name of the rule.

Definition at line 39 of file DescribeRuleResult.h.

◆ GetRoleArn()

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

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

Definition at line 266 of file DescribeRuleResult.h.

◆ GetScheduleExpression()

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

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

Definition at line 162 of file DescribeRuleResult.h.

◆ GetState()

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

Specifies whether the rule is enabled or disabled.

Definition at line 204 of file DescribeRuleResult.h.

◆ operator=()

DescribeRuleResult& Aws::EventBridge::Model::DescribeRuleResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetArn() [1/3]

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

The Amazon Resource Name (ARN) of the rule.

Definition at line 80 of file DescribeRuleResult.h.

◆ SetArn() [2/3]

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

The Amazon Resource Name (ARN) of the rule.

Definition at line 85 of file DescribeRuleResult.h.

◆ SetArn() [3/3]

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

The Amazon Resource Name (ARN) of the rule.

Definition at line 90 of file DescribeRuleResult.h.

◆ SetCreatedBy() [1/3]

void Aws::EventBridge::Model::DescribeRuleResult::SetCreatedBy ( const Aws::String value)
inline

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

Definition at line 394 of file DescribeRuleResult.h.

◆ SetCreatedBy() [2/3]

void Aws::EventBridge::Model::DescribeRuleResult::SetCreatedBy ( Aws::String &&  value)
inline

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

Definition at line 403 of file DescribeRuleResult.h.

◆ SetCreatedBy() [3/3]

void Aws::EventBridge::Model::DescribeRuleResult::SetCreatedBy ( const char *  value)
inline

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

Definition at line 412 of file DescribeRuleResult.h.

◆ SetDescription() [1/3]

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

The description of the rule.

Definition at line 235 of file DescribeRuleResult.h.

◆ SetDescription() [2/3]

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

The description of the rule.

Definition at line 240 of file DescribeRuleResult.h.

◆ SetDescription() [3/3]

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

The description of the rule.

Definition at line 245 of file DescribeRuleResult.h.

◆ SetEventBusName() [1/3]

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

The name of the event bus associated with the rule.

Definition at line 350 of file DescribeRuleResult.h.

◆ SetEventBusName() [2/3]

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

The name of the event bus associated with the rule.

Definition at line 355 of file DescribeRuleResult.h.

◆ SetEventBusName() [3/3]

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

The name of the event bus associated with the rule.

Definition at line 360 of file DescribeRuleResult.h.

◆ SetEventPattern() [1/3]

void Aws::EventBridge::Model::DescribeRuleResult::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 120 of file DescribeRuleResult.h.

◆ SetEventPattern() [2/3]

void Aws::EventBridge::Model::DescribeRuleResult::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 127 of file DescribeRuleResult.h.

◆ SetEventPattern() [3/3]

void Aws::EventBridge::Model::DescribeRuleResult::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 134 of file DescribeRuleResult.h.

◆ SetManagedBy() [1/3]

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

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

Definition at line 309 of file DescribeRuleResult.h.

◆ SetManagedBy() [2/3]

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

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

Definition at line 315 of file DescribeRuleResult.h.

◆ SetManagedBy() [3/3]

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

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

Definition at line 321 of file DescribeRuleResult.h.

◆ SetName() [1/3]

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

The name of the rule.

Definition at line 44 of file DescribeRuleResult.h.

◆ SetName() [2/3]

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

The name of the rule.

Definition at line 49 of file DescribeRuleResult.h.

◆ SetName() [3/3]

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

The name of the rule.

Definition at line 54 of file DescribeRuleResult.h.

◆ SetRoleArn() [1/3]

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

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

Definition at line 271 of file DescribeRuleResult.h.

◆ SetRoleArn() [2/3]

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

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

Definition at line 276 of file DescribeRuleResult.h.

◆ SetRoleArn() [3/3]

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

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

Definition at line 281 of file DescribeRuleResult.h.

◆ SetScheduleExpression() [1/3]

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

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

Definition at line 168 of file DescribeRuleResult.h.

◆ SetScheduleExpression() [2/3]

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

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

Definition at line 174 of file DescribeRuleResult.h.

◆ SetScheduleExpression() [3/3]

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

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

Definition at line 180 of file DescribeRuleResult.h.

◆ SetState() [1/2]

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

Specifies whether the rule is enabled or disabled.

Definition at line 209 of file DescribeRuleResult.h.

◆ SetState() [2/2]

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

Specifies whether the rule is enabled or disabled.

Definition at line 214 of file DescribeRuleResult.h.

◆ WithArn() [1/3]

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

The Amazon Resource Name (ARN) of the rule.

Definition at line 95 of file DescribeRuleResult.h.

◆ WithArn() [2/3]

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

The Amazon Resource Name (ARN) of the rule.

Definition at line 100 of file DescribeRuleResult.h.

◆ WithArn() [3/3]

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

The Amazon Resource Name (ARN) of the rule.

Definition at line 105 of file DescribeRuleResult.h.

◆ WithCreatedBy() [1/3]

DescribeRuleResult& Aws::EventBridge::Model::DescribeRuleResult::WithCreatedBy ( const Aws::String value)
inline

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

Definition at line 421 of file DescribeRuleResult.h.

◆ WithCreatedBy() [2/3]

DescribeRuleResult& Aws::EventBridge::Model::DescribeRuleResult::WithCreatedBy ( Aws::String &&  value)
inline

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

Definition at line 430 of file DescribeRuleResult.h.

◆ WithCreatedBy() [3/3]

DescribeRuleResult& Aws::EventBridge::Model::DescribeRuleResult::WithCreatedBy ( const char *  value)
inline

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

Definition at line 439 of file DescribeRuleResult.h.

◆ WithDescription() [1/3]

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

The description of the rule.

Definition at line 250 of file DescribeRuleResult.h.

◆ WithDescription() [2/3]

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

The description of the rule.

Definition at line 255 of file DescribeRuleResult.h.

◆ WithDescription() [3/3]

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

The description of the rule.

Definition at line 260 of file DescribeRuleResult.h.

◆ WithEventBusName() [1/3]

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

The name of the event bus associated with the rule.

Definition at line 365 of file DescribeRuleResult.h.

◆ WithEventBusName() [2/3]

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

The name of the event bus associated with the rule.

Definition at line 370 of file DescribeRuleResult.h.

◆ WithEventBusName() [3/3]

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

The name of the event bus associated with the rule.

Definition at line 375 of file DescribeRuleResult.h.

◆ WithEventPattern() [1/3]

DescribeRuleResult& Aws::EventBridge::Model::DescribeRuleResult::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 141 of file DescribeRuleResult.h.

◆ WithEventPattern() [2/3]

DescribeRuleResult& Aws::EventBridge::Model::DescribeRuleResult::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 148 of file DescribeRuleResult.h.

◆ WithEventPattern() [3/3]

DescribeRuleResult& Aws::EventBridge::Model::DescribeRuleResult::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 155 of file DescribeRuleResult.h.

◆ WithManagedBy() [1/3]

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

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

Definition at line 327 of file DescribeRuleResult.h.

◆ WithManagedBy() [2/3]

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

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

Definition at line 333 of file DescribeRuleResult.h.

◆ WithManagedBy() [3/3]

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

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

Definition at line 339 of file DescribeRuleResult.h.

◆ WithName() [1/3]

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

The name of the rule.

Definition at line 59 of file DescribeRuleResult.h.

◆ WithName() [2/3]

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

The name of the rule.

Definition at line 64 of file DescribeRuleResult.h.

◆ WithName() [3/3]

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

The name of the rule.

Definition at line 69 of file DescribeRuleResult.h.

◆ WithRoleArn() [1/3]

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

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

Definition at line 286 of file DescribeRuleResult.h.

◆ WithRoleArn() [2/3]

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

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

Definition at line 291 of file DescribeRuleResult.h.

◆ WithRoleArn() [3/3]

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

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

Definition at line 296 of file DescribeRuleResult.h.

◆ WithScheduleExpression() [1/3]

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

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

Definition at line 186 of file DescribeRuleResult.h.

◆ WithScheduleExpression() [2/3]

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

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

Definition at line 192 of file DescribeRuleResult.h.

◆ WithScheduleExpression() [3/3]

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

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

Definition at line 198 of file DescribeRuleResult.h.

◆ WithState() [1/2]

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

Specifies whether the rule is enabled or disabled.

Definition at line 219 of file DescribeRuleResult.h.

◆ WithState() [2/2]

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

Specifies whether the rule is enabled or disabled.

Definition at line 224 of file DescribeRuleResult.h.


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