Package software.amazon.awscdk.services.events

Class RuleProps.Builder

java.lang.Object
software.amazon.awscdk.services.events.RuleProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<RuleProps>
Enclosing interface:
RuleProps
@Stability(Stable) public static final class RuleProps.Builder extends Object implements software.amazon.jsii.Builder<RuleProps>
A builder for RuleProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • description

      @Stability(Stable) public RuleProps.Builder description(String description)
      Sets the value of RuleProps.getDescription()
      Parameters:
      description - A description of the rule's purpose.
      Returns:
      this

    • enabled

      @Stability(Stable) public RuleProps.Builder enabled(Boolean enabled)
      Sets the value of RuleProps.getEnabled()
      Parameters:
      enabled - Indicates whether the rule is enabled.
      Returns:
      this

    • eventBus

      @Stability(Stable) public RuleProps.Builder eventBus(IEventBus eventBus)
      Sets the value of RuleProps.getEventBus()
      Parameters:
      eventBus - The event bus to associate with this rule.
      Returns:
      this

    • eventPattern

      @Stability(Stable) public RuleProps.Builder eventPattern(EventPattern eventPattern)
      Sets the value of RuleProps.getEventPattern()
      Parameters:
      eventPattern - Describes which events EventBridge routes to the specified target. These routed events are matched events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
      Returns:
      this

    • ruleName

      @Stability(Stable) public RuleProps.Builder ruleName(String ruleName)
      Sets the value of RuleProps.getRuleName()
      Parameters:
      ruleName - A name for the rule.
      Returns:
      this

    • schedule

      @Stability(Stable) public RuleProps.Builder schedule(Schedule schedule)
      Sets the value of RuleProps.getSchedule()
      Parameters:
      schedule - The schedule or rate (frequency) that determines when EventBridge runs the rule. For more information, see Schedule Expression Syntax for Rules in the Amazon EventBridge User Guide.
      Returns:
      this

    • targets

      @Stability(Stable) public RuleProps.Builder targets(List<? extends IRuleTarget> targets)
      Sets the value of RuleProps.getTargets()
      Parameters:
      targets - 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]).
      Returns:
      this

    • build

      @Stability(Stable) public RuleProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<RuleProps>
      Returns:
      a new instance of RuleProps
      Throws:
      NullPointerException - if any required attribute was not provided