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

Class: Aws::EventBridge::Types::Rule

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

Overview

Contains information about a rule in Amazon EventBridge.

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.

#descriptionString

The description of the rule.

Returns:

  • (String)

    The description of the rule.

#event_bus_nameString

The event bus associated with the rule.

Returns:

  • (String)

    The event bus associated with the rule.

#event_patternString

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

Returns:

  • (String)

    The event pattern of the rule.

#managed_byString

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

Returns:

  • (String)

    If an AWS service created the rule on behalf of your account, this field displays the principal name of the 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 role that is used for target invocation.

Returns:

  • (String)

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

#schedule_expressionString

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

Returns:

  • (String)

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

#stateString

The state of the rule.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String)

    The state of the rule.