AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the rule.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the rule.

#created_byString

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.

#descriptionString

The description of the rule.

Returns:

  • (String)

    The description of the rule.

#event_bus_nameString

The name of the event bus associated with the rule.

Returns:

  • (String)

    The name of the event bus associated with the rule.

#event_patternString

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

Returns:

  • (String)

    The event pattern.

#managed_byString

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.

#nameString

The name of the rule.

Returns:

  • (String)

    The name of the rule.

#role_arnString

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_expressionString

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

Returns:

  • (String)

    The scheduling expression.

#stateString

Specifies whether the rule is enabled or disabled.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String)

    Specifies whether the rule is enabled or disabled.