Package software.amazon.awscdk.services.codepipeline

Interface PipelineNotifyOnOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, NotificationRuleOptions

All Known Implementing Classes:

PipelineNotifyOnOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:37.961Z")
@Stability(Stable)
public interface PipelineNotifyOnOptions
extends software.amazon.jsii.JsiiSerializable, NotificationRuleOptions

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 software.amazon.awscdk.services.codepipeline.*;
 import software.amazon.awscdk.services.codestarnotifications.*;
 PipelineNotifyOnOptions pipelineNotifyOnOptions = PipelineNotifyOnOptions.builder()
         .events(List.of(PipelineNotificationEvents.PIPELINE_EXECUTION_FAILED))
         // the properties below are optional
         .detailType(DetailType.BASIC)
         .enabled(false)
         .notificationRuleName("notificationRuleName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PipelineNotifyOnOptions.Builder	A builder for PipelineNotifyOnOptions
static final class	PipelineNotifyOnOptions.Jsii$Proxy	An implementation for PipelineNotifyOnOptions

Method Summary

Modifier and Type	Method	Description
static PipelineNotifyOnOptions.Builder	builder()
List<PipelineNotificationEvents>	getEvents()	A list of event types associated with this notification rule for CodePipeline Pipeline.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.codestarnotifications.NotificationRuleOptions

getDetailType, getEnabled, getNotificationRuleName

Method Details

getEvents

@Stability(Stable)
@NotNull
List<PipelineNotificationEvents> getEvents()

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.

See Also:

• https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api

builder

@Stability(Stable)
static PipelineNotifyOnOptions.Builder builder()

Returns:

a PipelineNotifyOnOptions.Builder of PipelineNotifyOnOptions