Packages

case class AWS::Events::Rule(name: String, Name: Option[Token[String]] = None, Description: Option[String] = None, EventPattern: Option[JsValue] = None, ScheduleExpression: Option[ScheduleExpression] = None, State: Option[RuleState] = None, Targets: Option[Seq[RuleTarget]] = None, DependsOn: Option[Seq[String]] = None, Condition: Option[ConditionRef] = None) extends Resource[AWS::Events::Rule] with HasArn with Product with Serializable

The AWS::Events::Rule resource creates a rule that matches incoming Amazon CloudWatch Events (CloudWatch Events) events and routes them to one or more targets for processing. For more information, see Using CloudWatch Events in the Amazon CloudWatch User Guide.

name

CloudFormation logical name

Name

A name for the rule. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. IMPORTANT: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Description

A description of the rule's purpose.

EventPattern

Describes which events CloudWatch Events routes to the specified target. These routed events are matched events. For more information, see Events and Event Patterns in the Amazon CloudWatch User Guide.

ScheduleExpression

The schedule or rate (frequency) that determines when CloudWatch Events runs the rule. For more information, see Schedule Expression Syntax for Rules in the Amazon CloudWatch User Guide.

State

Indicates whether the rule is enabled. For valid values, see the State parameter for the PutRule action in the Amazon CloudWatch Events API Reference.

Targets

The resources, such as Lambda functions or Kinesis streams, that CloudWatch Events routes events to and invokes when the rule is triggered. For information about valid targets, see the PutTargets action in the Amazon CloudWatch Events API Reference.

DependsOn

Declare dependencies for resources that must be created or deleted in a specific order.

Condition

Define conditions by using the intrinsic condition functions. These conditions determine when AWS CloudFormation creates the associated resources.

Linear Supertypes
Serializable, Serializable, Product, Equals, HasArn, Resource[AWS::Events::Rule], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AWS::Events::Rule
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HasArn
  7. Resource
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AWS::Events::Rule(name: String, Name: Option[Token[String]] = None, Description: Option[String] = None, EventPattern: Option[JsValue] = None, ScheduleExpression: Option[ScheduleExpression] = None, State: Option[RuleState] = None, Targets: Option[Seq[RuleTarget]] = None, DependsOn: Option[Seq[String]] = None, Condition: Option[ConditionRef] = None)

    name

    CloudFormation logical name

    Name

    A name for the rule. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. IMPORTANT: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

    Description

    A description of the rule's purpose.

    EventPattern

    Describes which events CloudWatch Events routes to the specified target. These routed events are matched events. For more information, see Events and Event Patterns in the Amazon CloudWatch User Guide.

    ScheduleExpression

    The schedule or rate (frequency) that determines when CloudWatch Events runs the rule. For more information, see Schedule Expression Syntax for Rules in the Amazon CloudWatch User Guide.

    State

    Indicates whether the rule is enabled. For valid values, see the State parameter for the PutRule action in the Amazon CloudWatch Events API Reference.

    Targets

    The resources, such as Lambda functions or Kinesis streams, that CloudWatch Events routes events to and invokes when the rule is triggered. For information about valid targets, see the PutTargets action in the Amazon CloudWatch Events API Reference.

    DependsOn

    Declare dependencies for resources that must be created or deleted in a specific order.

    Condition

    Define conditions by using the intrinsic condition functions. These conditions determine when AWS CloudFormation creates the associated resources.

Type Members

  1. type RR = Resource[AWS::Events::Rule]
    Definition Classes
    Resource

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val Condition: Option[ConditionRef]
    Definition Classes
    AWS::Events::RuleResource
  5. val DeletionPolicy: Option[DeletionPolicy]
    Definition Classes
    Resource
  6. val DependsOn: Option[Seq[String]]
    Definition Classes
    AWS::Events::RuleResource
  7. val Description: Option[String]
  8. val EventPattern: Option[JsValue]
  9. val Name: Option[Token[String]]
  10. val ResourceType: String
    Definition Classes
    Resource
  11. val ScheduleExpression: Option[ScheduleExpression]
  12. val State: Option[RuleState]
  13. val Targets: Option[Seq[RuleTarget]]
  14. def arn: Token[String]
    Definition Classes
    AWS::Events::RuleHasArn
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val name: String
    Definition Classes
    AWS::Events::RuleHasArnResource
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  29. def when(newCondition: Option[ConditionRef] = Condition): AWS::Events::Rule
    Definition Classes
    AWS::Events::RuleResource

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HasArn

Inherited from Resource[AWS::Events::Rule]

Inherited from AnyRef

Inherited from Any

Ungrouped