Interface IEventCommonOptions

Common options for Events.

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IEventCommonOptions

Syntax (vb)

Public Interface IEventCommonOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.Events;
            using Constructs;

            Construct construct;
            var detail;
            var eventCommonOptions = new EventCommonOptions {
                CrossStackScope = construct,
                Description = "description",
                EventPattern = new EventPattern {
                    Account = new [] { "account" },
                    Detail = new Dictionary<string, object> {
                        { "detailKey", detail }
                    },
                    DetailType = new [] { "detailType" },
                    Id = new [] { "id" },
                    Region = new [] { "region" },
                    Resources = new [] { "resources" },
                    Source = new [] { "source" },
                    Time = new [] { "time" },
                    Version = new [] { "version" }
                },
                RuleName = "ruleName"
            };

Synopsis

Properties

CrossStackScope	The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).
Description	A description of the rule's purpose.
EventPattern	Additional restrictions for the event to route to the specified target.
RuleName	A name for the rule.

Properties

CrossStackScope

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

Construct? CrossStackScope { get; }

Property Value

Construct

Remarks

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

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

Description

A description of the rule's purpose.

string? Description { get; }

Property Value

string

Remarks

Default: - No description

EventPattern

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

IEventPattern? EventPattern { get; }

Property Value

IEventPattern

Remarks

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

RuleName

A name for the rule.

string? RuleName { get; }

Property Value

string

Remarks

Default: AWS CloudFormation generates a unique physical ID.