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

Class: Aws::EventBridge::Types::PutRuleRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/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",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description of the rule.

Returns:

  • (String) 


1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1800

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

#event_bus_name ⇒ String

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

Returns:

  • (String) 


1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1800

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

#event_pattern ⇒ String

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

Returns:

  • (String) 


1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1800

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

#name ⇒ String

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

A rule can't have the same name as another rule in the same Region or on the same event bus.

Returns:

  • (String) 


1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1800

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

#role_arn ⇒ String

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

Returns:

  • (String) 


1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1800

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

#schedule_expression ⇒ String

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

Returns:

  • (String) 


1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1800

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

#state ⇒ String

Indicates whether the rule is enabled or disabled.

Returns:

  • (String) 


1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1800

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

#tags ⇒ Array<Types::Tag>

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

Returns:



1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1800

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