MDAA TS Docs
    Preparing search index...

    Interface ResolveAlarmNotificationTopicProps

    interface ResolveAlarmNotificationTopicProps {
        alarmNamePattern: string;
        configPath?: string;
        createNotificationTopic?: boolean;
        createOutputs?: boolean;
        createParams?: boolean;
        masterKey?: IKey;
        naming: IMdaaResourceNaming;
        notificationEmails?: string[];
        notificationTopicArn?: string;
        topicName: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    alarmNamePattern: string

    Name pattern of the alarms publishing to a created topic, scoping the CloudWatch grants on the topic and key. See GrantCloudWatchAlarmsTopicAccessProps.alarmNamePattern.

    configPath?: string

    Config path of the block holding the notification settings, used in error messages.

    'alarms'
    
    createNotificationTopic?: boolean

    When true, a CMK-encrypted SNS topic is created and notified on alarm. Mutually exclusive with notificationTopicArn.

    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

    masterKey?: IKey

    KMS key encrypting a created topic. Required when createNotificationTopic is true; unused for an existing topic, which is not MDAA's to encrypt.

    - none; a created topic then throws
    
    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    notificationEmails?: string[]

    Email addresses subscribed to a created topic. Only valid with createNotificationTopic: MDAA does not modify a topic it did not create.

    notificationTopicArn?: string

    ARN of an existing SNS topic to notify on alarm. Mutually exclusive with createNotificationTopic; one of the two must be supplied.

    topicName: string

    Name of a created topic, before the naming convention is applied.