com.monsanto.arch.cloudformation.model.resource
AWS::Events::Rule
Companion object AWS::Events::Rule
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.
- Alphabetic
- By Inheritance
- AWS::Events::Rule
- Serializable
- Serializable
- Product
- Equals
- HasArn
- Resource
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
-
type
RR = Resource[AWS::Events::Rule]
- Definition Classes
- Resource
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
Condition: Option[ConditionRef]
- Definition Classes
- AWS::Events::Rule → Resource
-
val
DeletionPolicy: Option[DeletionPolicy]
- Definition Classes
- Resource
-
val
DependsOn: Option[Seq[String]]
- Definition Classes
- AWS::Events::Rule → Resource
- val Description: Option[String]
- val EventPattern: Option[JsValue]
- val Name: Option[Token[String]]
-
val
ResourceType: String
- Definition Classes
- Resource
- val ScheduleExpression: Option[ScheduleExpression]
- val State: Option[RuleState]
- val Targets: Option[Seq[RuleTarget]]
-
def
arn: Token[String]
- Definition Classes
- AWS::Events::Rule → HasArn
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
name: String
- Definition Classes
- AWS::Events::Rule → HasArn → Resource
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
when(newCondition: Option[ConditionRef] = Condition): AWS::Events::Rule
- Definition Classes
- AWS::Events::Rule → Resource