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

Class: Aws::CloudWatchEvents::Types::Rule

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

Overview

Contains information about a rule in Amazon EventBridge.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the rule.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the rule.

#description ⇒ String

The description of the rule.

Returns:

  • (String) —

    The description of the rule.

#event_bus_name ⇒ String

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

Returns:

  • (String) —

    The name or ARN of the event bus associated with the rule.

#event_pattern ⇒ String

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

Returns:

  • (String) —

    The event pattern of the rule.

#managed_by ⇒ String

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.

Returns:

  • (String) —

    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.

#name ⇒ String

The name of the rule.

Returns:

  • (String) —

    The name of the rule.

#role_arn ⇒ String

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_expression ⇒ String

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

Returns:

  • (String) —

    The scheduling expression.

#state ⇒ String

The state of the rule.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String) —

    The state of the rule.