Package software.amazon.awscdk.services.events

Interface EventCommonOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

OnCloudTrailBucketEventOptions, OnCloudTrailImagePushedOptions, OnCommitOptions, OnEventOptions, OnImageScanCompletedOptions, RuleProps

All Known Implementing Classes:

EventCommonOptions.Jsii$Proxy, OnCloudTrailBucketEventOptions.Jsii$Proxy, OnCloudTrailImagePushedOptions.Jsii$Proxy, OnCommitOptions.Jsii$Proxy, OnEventOptions.Jsii$Proxy, OnImageScanCompletedOptions.Jsii$Proxy, RuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:16.230Z")
@Stability(Stable)
public interface EventCommonOptions
extends software.amazon.jsii.JsiiSerializable

Common options for Events.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 import software.constructs.*;
 Construct construct;
 Object detail;
 EventCommonOptions eventCommonOptions = EventCommonOptions.builder()
         .crossStackScope(construct)
         .description("description")
         .eventPattern(EventPattern.builder()
                 .account(List.of("account"))
                 .detail(Map.of(
                         "detailKey", detail))
                 .detailType(List.of("detailType"))
                 .id(List.of("id"))
                 .region(List.of("region"))
                 .resources(List.of("resources"))
                 .source(List.of("source"))
                 .time(List.of("time"))
                 .version(List.of("version"))
                 .build())
         .ruleName("ruleName")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EventCommonOptions.Builder	builder()
default software.constructs.Construct	getCrossStackScope()	The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).
default String	getDescription()	A description of the rule's purpose.
default EventPattern	getEventPattern()	Additional restrictions for the event to route to the specified target.
default String	getRuleName()	A name for the rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCrossStackScope

@Stability(Stable)
@Nullable
default software.constructs.Construct getCrossStackScope()

The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).

This helps dealing with cycles that often arise in these situations.

Default: - none (the main scope will be used, even for cross-stack Events)

getDescription

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

A description of the rule's purpose.

Default: - No description

getEventPattern

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

Additional restrictions for the event to route to the specified target.

The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.

Default: - No additional filtering based on an event pattern.

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html

getRuleName

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

A name for the rule.

Default: AWS CloudFormation generates a unique physical ID.

builder

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

Returns:

a EventCommonOptions.Builder of EventCommonOptions