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
show all
Defined in:
gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb

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)


2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# 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

#descriptionString

The description of the rule.

Returns:

  • (String)


2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# 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_nameString

The event bus associated with the rule.

Returns:

  • (String)


2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# 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_patternString

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

Returns:

  • (String)


2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# 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_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)


2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# 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

#nameString

The name of the rule.

Returns:

  • (String)


2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# 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_arnString

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

Returns:

  • (String)


2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# 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_expressionString

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

Returns:

  • (String)


2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# 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

#stateString

The state of the rule.

Returns:

  • (String)


2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
# 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