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

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

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchEvents::Types::Rule

Defined in:

gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb

Overview

Contains information about a rule in Amazon EventBridge.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the rule.

• #description ⇒ String

  The description of the rule.

• #event_bus_name ⇒ String

  The event bus associated with the rule.

• #event_pattern ⇒ String

  The event pattern of the rule.

• #managed_by ⇒ 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.

• #name ⇒ String

  The name of the rule.

• #role_arn ⇒ 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 * * ? *)" or "rate(5 minutes)".

• #state ⇒ String

  The state of the rule.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the rule.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2096

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn,
  :managed_by,
  :event_bus_name)
  include Aws::Structure
end

#description ⇒ String

The description of the rule.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2096

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn,
  :managed_by,
  :event_bus_name)
  include Aws::Structure
end

#event_bus_name ⇒ String

The event bus associated with the rule.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2096

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn,
  :managed_by,
  :event_bus_name)
  include Aws::Structure
end

#event_pattern ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2096

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn,
  :managed_by,
  :event_bus_name)
  include Aws::Structure
end

#managed_by ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2096

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn,
  :managed_by,
  :event_bus_name)
  include Aws::Structure
end

#name ⇒ String

The name of the rule.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2096

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn,
  :managed_by,
  :event_bus_name)
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2096

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn,
  :managed_by,
  :event_bus_name)
  include Aws::Structure
end

#schedule_expression ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2096

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn,
  :managed_by,
  :event_bus_name)
  include Aws::Structure
end

#state ⇒ String

The state of the rule.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 2096

class Rule < Struct.new(
  :name,
  :arn,
  :event_pattern,
  :state,
  :description,
  :schedule_expression,
  :role_arn,
  :managed_by,
  :event_bus_name)
  include Aws::Structure
end