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

Inherits:

Struct

• Object
• Struct
• Aws::EventBridge::Types::PutRuleRequest

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: "EventBusNameOrArn",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  A description of the rule.

• #event_bus_name ⇒ String

  The name or ARN of the event bus to associate with this rule.

• #event_pattern ⇒ String

  The event pattern.

• #name ⇒ String

  The name of the rule that you are creating or updating.

• #role_arn ⇒ String

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

• #schedule_expression ⇒ String

  The scheduling expression.

• #state ⇒ String

  Indicates whether the rule is enabled or disabled.

• #tags ⇒ Array<Types::Tag>

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

Instance Attribute Details

#description ⇒ String

A description of the rule.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4504

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

#event_bus_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4504

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

#event_pattern ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4504

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

#name ⇒ String

The name of the rule that you are creating or updating.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4504

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

#role_arn ⇒ String

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

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4504

class PutRuleRequest < Struct.new(
  :name,
  :schedule_expression,
  :event_pattern,
  :state,
  :description,
  :role_arn,
  :tags,
  :event_bus_name)
  SENSITIVE = []
  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-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4504

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

#state ⇒ String

Indicates whether the rule is enabled or disabled.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4504

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

#tags ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4504

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