interface PipelineNotifyOnOptions

Language	Type name
.NET	`Amazon.CDK.AWS.CodePipeline.PipelineNotifyOnOptions`
Java	`software.amazon.awscdk.services.codepipeline.PipelineNotifyOnOptions`
Python	`aws_cdk.aws_codepipeline.PipelineNotifyOnOptions`
TypeScript (source)	`@aws-cdk/aws-codepipeline` » `PipelineNotifyOnOptions`

Additional options to pass to the notification rule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codepipeline from '@aws-cdk/aws-codepipeline';
import * as codestarnotifications from '@aws-cdk/aws-codestarnotifications';
const pipelineNotifyOnOptions: codepipeline.PipelineNotifyOnOptions = {
  events: [codepipeline.PipelineNotificationEvents.PIPELINE_EXECUTION_FAILED],

  // the properties below are optional
  detailType: codestarnotifications.DetailType.BASIC,
  enabled: false,
  notificationRuleName: 'notificationRuleName',
};

Properties

Name	Type	Description
events	`PipelineNotificationEvents[]`	A list of event types associated with this notification rule for CodePipeline Pipeline.
detailType?	`DetailType`	The level of detail to include in the notifications for this resource.
enabled?	`boolean`	The status of the notification rule.
notificationRuleName?	`string`	The name for the notification rule.

events

Type: PipelineNotificationEvents[]

A list of event types associated with this notification rule for CodePipeline Pipeline.

For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.

detailType?

Type: DetailType (optional, default: DetailType.FULL)

The level of detail to include in the notifications for this resource.

BASIC will include only the contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

enabled?

Type: boolean (optional, default: true)

The status of the notification rule.

If the enabled is set to DISABLED, notifications aren't sent for the notification rule.

notificationRuleName?

Type: string (optional, default: generated from the id)

The name for the notification rule.

Notification rule names must be unique in your AWS account.