MDAA TS Docs
    Preparing search index...

    Interface MdaaRuleProps

    interface MdaaRuleProps {
        createOutputs?: boolean;
        createParams?: boolean;
        description?: string;
        enabled?: boolean;
        eventBus?: IEventBusRef;
        eventPattern?: EventPattern;
        naming: IMdaaResourceNaming;
        ruleName: string;
        schedule?: Schedule;
        targets?: IRuleTarget[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    createOutputs? createParams? description? enabled? eventBus? eventPattern? naming ruleName schedule? targets?

    Properties

    createOutputs?: boolean

    Flag controlling CloudFormation output and stack export creation for construct resources

    createParams?: boolean

    Flag controlling SSM parameter creation for construct resource references enabling

    description?: string

    Human-readable description of what the rule matches.

    enabled?: boolean

    Whether the rule is enabled.

    true
    eventBus?: IEventBusRef

    The event bus to associate the rule with.

    the account's default bus
    eventPattern?: EventPattern

    The event pattern the rule matches. Required unless schedule is supplied.

    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    ruleName: string

    Short, stable name for the rule. The MDAA naming convention prefixes this with <org>-<env>-<domain>-<module>- and truncates to the 64-character rule-name limit, so pass the unprefixed name only.

    Note that with a typical prefix the entire suffix may be replaced by the uniqueness hash, in which case this name does not appear in the deployed name at all. Names stay unique and stable either way (the hash covers the full pre-truncation name), but operators should identify a rule by its description rather than by its name.

    schedule?: Schedule

    Schedule expression, for a scheduled rather than event-pattern-driven rule.

    targets?: IRuleTarget[]

    Targets invoked when the rule matches. Targets may also be added after construction via addTarget.

    Settings

    Member Visibility

    On This Page

    Properties