Rule

class Rule

Contains information about a rule in Amazon EventBridge.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String?

The Amazon Resource Name (ARN) of the rule.

Link copied to clipboard

The description of the rule.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.

Link copied to clipboard
val name: String?

The name of the rule.

Link copied to clipboard

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

Link copied to clipboard

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

Link copied to clipboard

The state of the rule.

Functions

Link copied to clipboard
inline fun copy(block: Rule.Builder.() -> Unit = {}): Rule
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String