Package software.amazon.awscdk.services.events

Interface RuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:37.054Z")
@Stability(Stable)
public interface RuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining an EventBridge Rule.

Example:

 Connection connection = Connection.Builder.create(this, "Connection")
         .authorization(Authorization.apiKey("x-api-key", SecretValue.secretsManager("ApiSecretName")))
         .description("Connection with API Key x-api-key")
         .build();
 ApiDestination destination = ApiDestination.Builder.create(this, "Destination")
         .connection(connection)
         .endpoint("https://example.com")
         .description("Calling example.com with API key x-api-key")
         .build();
 Rule rule = Rule.Builder.create(this, "Rule")
         .schedule(Schedule.rate(Duration.minutes(1)))
         .targets(List.of(new ApiDestination(destination)))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RuleProps.Builder	A builder for RuleProps
static final class	RuleProps.Jsii$Proxy	An implementation for RuleProps

Method Summary

Modifier and Type	Method	Description
static RuleProps.Builder	builder()
default String	getDescription()	A description of the rule's purpose.
default Boolean	getEnabled()	Indicates whether the rule is enabled.
default IEventBus	getEventBus()	The event bus to associate with this rule.
default EventPattern	getEventPattern()	Describes which events EventBridge routes to the specified target.
default String	getRuleName()	A name for the rule.
default Schedule	getSchedule()	The schedule or rate (frequency) that determines when EventBridge runs the rule.
default List<IRuleTarget>	getTargets()	Targets to invoke when this rule matches an event.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the rule's purpose.

Default: - No description.

getEnabled

@Stability(Stable)
@Nullable
default Boolean getEnabled()

Indicates whether the rule is enabled.

Default: true

getEventBus

@Stability(Stable)
@Nullable
default IEventBus getEventBus()

The event bus to associate with this rule.

Default: - The default event bus.

getEventPattern

@Stability(Stable)
@Nullable
default EventPattern getEventPattern()

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.

Default: - None.

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html 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

@Stability(Stable)
@Nullable
default String getRuleName()

A name for the rule.

Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

getSchedule

@Stability(Stable)
@Nullable
default Schedule getSchedule()

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.

Default: - None.

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html You must specify this property, the `eventPattern` property, or both.

getTargets

@Stability(Stable)
@Nullable
default List<IRuleTarget> 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]).

Default: - No targets.

builder

@Stability(Stable)
static RuleProps.Builder builder()

Returns:

a RuleProps.Builder of RuleProps