Class: Aws::EventBridge::Types::DescribeRuleResponse

Inherits:

Struct

• Object
• Struct
• Aws::EventBridge::Types::DescribeRuleResponse

Defined in:

(unknown)

Overview

Returned by:

• Client#describe_rule

See Also:

• AWS API Documentation

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the rule.

• #created_by ⇒ String

  The account ID of the user that created the rule.

• #description ⇒ String

  The description of the rule.

• #event_bus_name ⇒ String

  The name of the event bus associated with the rule.

• #event_pattern ⇒ String

  The event pattern.

• #managed_by ⇒ String

  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.

• #name ⇒ String

  The name of the rule.

• #role_arn ⇒ String

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

• #schedule_expression ⇒ String

  The scheduling expression.

• #state ⇒ String

  Specifies whether the rule is enabled or disabled.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the rule.

Returns:

• (String) —

  The Amazon Resource Name (ARN) of the rule.

#created_by ⇒ String

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.

Returns:

• (String) —

  The account ID of the user that created the rule.

#description ⇒ String

The description of the rule.

Returns:

• (String) —

  The description of the rule.

#event_bus_name ⇒ String

The name of the event bus associated with the rule.

Returns:

• (String) —

  The name of the event bus associated with the rule.

#event_pattern ⇒ String

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

Returns:

• (String) —

  The event pattern.

#managed_by ⇒ String

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.

Returns:

• (String) —

  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.

#name ⇒ String

The name of the rule.

Returns:

• (String) —

  The name of the rule.

#role_arn ⇒ String

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

Returns:

• (String) —

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

#schedule_expression ⇒ String

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

Returns:

• (String) —

  The scheduling expression.

#state ⇒ String

Specifies whether the rule is enabled or disabled.

Possible values:

• ENABLED
• DISABLED

Returns:

• (String) —

  Specifies whether the rule is enabled or disabled.