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

Class: Aws::CloudWatchEvents::Types::PutRuleRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb

Overview

Note:

When making an API call, you may pass PutRuleRequest data as a hash:

{
  name: "RuleName", # required
  schedule_expression: "ScheduleExpression",
  event_pattern: "EventPattern",
  state: "ENABLED", # accepts ENABLED, DISABLED
  description: "RuleDescription",
  role_arn: "RoleArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  event_bus_name: "EventBusName",
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the rule.

Returns:

  • (String)


1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1793

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

#event_bus_nameString

The event bus to associate with this rule. If you omit this, the default event bus is used.

Returns:

  • (String)


1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1793

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

#event_patternString

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

Returns:

  • (String)


1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1793

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

#nameString

The name of the rule that you're creating or updating.

Returns:

  • (String)


1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1793

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

#role_arnString

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Returns:

  • (String)


1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1793

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

#schedule_expressionString

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

Returns:

  • (String)


1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1793

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

#stateString

Indicates whether the rule is enabled or disabled.

Returns:

  • (String)


1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1793

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

#tagsArray<Types::Tag>

The list of key-value pairs to associate with the rule.

Returns:



1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1793

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