Interface SlackNotificationProps

interface SlackNotificationProps {
    accountFriendlyName?: string;
    artifactsBucket: IBucket;
    notificationLevel?: "WARN" | "INFO" | "DEBUG";
    pipeline: IPipeline;
    slackWebhookUrlSecret: ISecret;
    triggerObjectKey?: string;
}

Properties

accountFriendlyName? artifactsBucket notificationLevel? pipeline slackWebhookUrlSecret triggerObjectKey?

Properties

OptionalaccountFriendlyName

accountFriendlyName?: string

An optional friendly name that will be used in the Slack notifications instead of the AWS account ID

artifactsBucket

artifactsBucket: IBucket

Artifacts bucket used by pipeline

OptionalnotificationLevel

notificationLevel?: "WARN" | "INFO" | "DEBUG"

Control the amount and types of notifications being sent to Slack. "WARN" is the least verbose, while "DEBUG" is the most verbose.

"WARN" - Includes notifications related to the failure of a pipeline execution. "INFO" - Adds notifications for the success of a pipeline execution. "DEBUG" - Adds notifications for the start and superseding of a pipeline execution.

Default

"WARN"

pipeline

pipeline: IPipeline

CodePipeline to monitor.

slackWebhookUrlSecret

slackWebhookUrlSecret: ISecret

A plaintext secret containing the URL of a Slack incoming webhook. The webhook should be created through a Slack app, and only allows posting to one specific Slack channel. See Slack's official documentation (e.g., https://api.slack.com/messaging/webhooks) for more details.

NOTE: Incoming webhooks created through legacy custom integrations in Slack are not supported.

OptionaltriggerObjectKey

triggerObjectKey?: string

The key of the object (e.g., my-prefix/my-file.json) that triggers the S3 Source Action associated with the pipeline. By configuring this parameter you can specify which objects the Lambda function that sends messages to Slack can access in the artifacts bucket.

Default

- the Lambda function can read all objects in the artifacts bucket.

Settings

Member Visibility

On This Page

Properties