EventRuleProps (software.amazon.awscdk:events 0.9.2 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: EventRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/0.7.6 (build 04cb6bb)",
           date="2018-09-20T13:04:04.142Z")
public interface EventRuleProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`EventRuleProps.Builder` A builder for `EventRuleProps`
`static class`	`EventRuleProps.Jsii$Proxy` A proxy class which represents a concrete javascript instance of this type.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static EventRuleProps.Builder`	`builder()`
`String`	`getDescription()` A description of the rule's purpose.
`Boolean`	`getEnabled()` Indicates whether the rule is enabled.
`EventPattern`	`getEventPattern()` Describes which events CloudWatch Events routes to the specified target.
`String`	`getRuleName()` A name for the rule.
`String`	`getScheduleExpression()` The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.
`List<IEventRuleTarget>`	`getTargets()` Targets to invoke when this rule matches an event.
`void`	`setDescription(String value)` A description of the rule's purpose.
`void`	`setEnabled(Boolean value)` Indicates whether the rule is enabled.
`void`	`setEventPattern(EventPattern value)` Describes which events CloudWatch Events routes to the specified target.
`void`	`setRuleName(String value)` A name for the rule.
`void`	`setScheduleExpression(String value)` The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.
`void`	`setTargets(List<IEventRuleTarget> value)` Targets to invoke when this rule matches an event.

- Method Detail
  - getDescription
```
String getDescription()
```
    A description of the rule's purpose.
  - setDescription
```
void setDescription(String value)
```
    A description of the rule's purpose.
  - getEnabled
```
Boolean getEnabled()
```
    Indicates whether the rule is enabled.
  - setEnabled
```
void setEnabled(Boolean value)
```
    Indicates whether the rule is enabled.
  - getEventPattern
```
EventPattern getEventPattern()
```
    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.
    
    See Also:
    
    You must specify this property (either via props or via `addEventPattern`), the `scheduleExpression` property, or both. The method `addEventPattern` can be used to add filter values to the event pattern.
  - setEventPattern
```
void setEventPattern(EventPattern value)
```
    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.
    
    See Also:
    
    You must specify this property (either via props or via `addEventPattern`), the `scheduleExpression` property, or both. The method `addEventPattern` can be used to add filter values to the event pattern.
  - getRuleName
```
String getRuleName()
```
    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. For more information, see Name Type.
  - setRuleName
```
void setRuleName(String value)
```
    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. For more information, see Name Type.
  - getScheduleExpression
```
String getScheduleExpression()
```
    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.
    
    See Also:
    
    You must specify this property, the `eventPattern` property, or both.
  - setScheduleExpression
```
void setScheduleExpression(String value)
```
    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.
    
    See Also:
    
    You must specify this property, the `eventPattern` property, or both.
  - getTargets
```
List<IEventRuleTarget> getTargets()
```
    Targets to invoke when this rule matches an event. Input will be the full matched event. If you wish to specify custom target input, use `addTarget(target[, inputOptions])`.
  - setTargets
```
void setTargets(List<IEventRuleTarget> value)
```
    Targets to invoke when this rule matches an event. Input will be the full matched event. If you wish to specify custom target input, use `addTarget(target[, inputOptions])`.
  - builder
```
static EventRuleProps.Builder builder()
```
    Returns:
    
    a EventRuleProps.Builder of EventRuleProps

Interface EventRuleProps

Nested Class Summary

Method Summary

Method Detail

getDescription

setDescription

getEnabled

setEnabled

getEventPattern

setEventPattern

getRuleName

setRuleName

getScheduleExpression

setScheduleExpression

getTargets

setTargets

builder