MDAA TS Docs
    Preparing search index...

    Interface CreateCloudTrailAlertRulesProps

    Properties for createCloudTrailAlertRules.

    interface CreateCloudTrailAlertRulesProps {
        alertSubject: string;
        createOutputs?: boolean;
        createParams?: boolean;
        eventSources: string[];
        naming: IMdaaResourceNaming;
        notificationTopic: ITopic;
        resourceArns?: string[];
        resourceName: string;
        resourceRequestParameters?: { [parameterName: string]: string };
        rules: { [name: string]: CloudTrailAlertRuleProps };
        rulesConfigPath?: string;
        sources: string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    alertSubject createOutputs? createParams? eventSources naming notificationTopic resourceArns? resourceName resourceRequestParameters? rules rulesConfigPath? sources

    Properties

    alertSubject: string

    Leading text of the notification message and each rule's default description, e.g. AgentCore security event. Identifies which subsystem an alert came from.

    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

    eventSources: string[]

    CloudTrail eventSource values, e.g. bedrock-agentcore.amazonaws.com, matched as detail.eventSource. Non-empty for the same reason as sources. The list is an OR, so a value that never appears is harmless.

    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    notificationTopic: ITopic

    SNS topic notified when any rule matches - the default target for every rule.

    For an imported topic CDK cannot attach a resource policy, so its owner must independently allow events.amazonaws.com to sns:Publish (and to use the key, if CMK-encrypted). Callers should warn about this.

    resourceArns?: string[]

    ARNs identifying this resource in the CloudTrail resources array. Pass every form the service may record (e.g. a resource ARN and its child endpoint ARN).

    At least one of this and resourceRequestParameters must be non-empty, or the rules would match every resource of that service in the account.

    resourceName: string

    Logical name of the resource the rules monitor (used in rule naming and in the notification).

    resourceRequestParameters?: { [parameterName: string]: string }

    Map of CloudTrail requestParameters field name to the value identifying this resource, $or-combined with each other and with resourceArns.

    A set rather than one field because the field carrying the identity differs per API, and naming an absent field matches nothing. Not sufficient alone - see CLOUDTRAIL_RESOURCES_ARN_FIELD.

    rules: { [name: string]: CloudTrailAlertRuleProps }

    The rules to create, keyed by a short name. The key is part of the rule's resource name, so it should be stable across deployments.

    rulesConfigPath?: string

    Config path this feature is exposed under (e.g. eventBridgeAlerts.rules), used in validation messages so they name the key the user actually set.

    'rules'
    sources: string[]

    Top-level EventBridge source values, e.g. aws.bedrock-agentcore. Must be non-empty, or the rules would match every service in the account.

    Settings

    Member Visibility

    On This Page

    Properties