AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutRuleRequest as input to an Aws::Client method, you can use a vanilla 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)

    A description of the rule.

#event_bus_nameString

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

Returns:

  • (String)

    The event bus to associate with this rule.

#event_patternString

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

Returns:

  • (String)

    The event pattern.

#nameString

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

Returns:

  • (String)

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

#role_arnString

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

Returns:

  • (String)

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

#schedule_expressionString

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

Returns:

  • (String)

    The scheduling expression.

#stateString

Indicates whether the rule is enabled or disabled.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String)

    Indicates whether the rule is enabled or disabled.

#tagsArray<Types::Tag>

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

Returns:

  • (Array<Types::Tag>)

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