software.amazon.awscdk.services.codestarnotifications

Class NotificationRule

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.codestarnotifications.NotificationRule

All Implemented Interfaces:

IConstruct, IDependable, IResource, INotificationRule

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.594Z")
public class NotificationRule
extends Resource
implements INotificationRule

A new notification rule.

Example:

 import software.amazon.awscdk.services.codestarnotifications.*;
 import software.amazon.awscdk.services.codebuild.*;
 import software.amazon.awscdk.services.sns.*;
 import software.amazon.awscdk.services.chatbot.*;
 PipelineProject project = new PipelineProject(this, "MyProject");
 Topic topic = new Topic(this, "MyTopic1");
 SlackChannelConfiguration slack = SlackChannelConfiguration.Builder.create(this, "MySlackChannel")
         .slackChannelConfigurationName("YOUR_CHANNEL_NAME")
         .slackWorkspaceId("YOUR_SLACK_WORKSPACE_ID")
         .slackChannelId("YOUR_SLACK_CHANNEL_ID")
         .build();
 NotificationRule rule = NotificationRule.Builder.create(this, "NotificationRule")
         .source(project)
         .events(List.of("codebuild-project-build-state-succeeded", "codebuild-project-build-state-failed"))
         .targets(List.of(topic))
         .build();
 rule.addTarget(slack);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotificationRule.Builder A fluent builder for NotificationRule.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codestarnotifications.INotificationRule

INotificationRule.Jsii$Default, INotificationRule.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NotificationRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NotificationRule(software.amazon.jsii.JsiiObjectRef objRef)
	NotificationRule(software.constructs.Construct scope, java.lang.String id, NotificationRuleProps props)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	addTarget(INotificationRuleTarget target) Adds target to notification rule.
static INotificationRule	fromNotificationRuleArn(software.constructs.Construct scope, java.lang.String id, java.lang.String notificationRuleArn) Import an existing notification rule provided an ARN.
java.lang.String	getNotificationRuleArn() The ARN of the notification rule (i.e.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

NotificationRule

protected NotificationRule(software.amazon.jsii.JsiiObjectRef objRef)

NotificationRule

protected NotificationRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

NotificationRule

public NotificationRule(software.constructs.Construct scope,
                        java.lang.String id,
                        NotificationRuleProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromNotificationRuleArn

public static INotificationRule fromNotificationRuleArn(software.constructs.Construct scope,
                                                        java.lang.String id,
                                                        java.lang.String notificationRuleArn)

Import an existing notification rule provided an ARN.

Parameters:

scope - The parent creating construct. This parameter is required.

id - The construct's name. This parameter is required.

notificationRuleArn - Notification rule ARN (i.e. arn:aws:codestar-notifications:::notificationrule/01234abcde). This parameter is required.

addTarget

public java.lang.Boolean addTarget(INotificationRuleTarget target)

Adds target to notification rule.

Specified by:

addTarget in interface INotificationRule

Parameters:

target - The SNS topic or AWS Chatbot Slack target. This parameter is required.

Returns:

boolean - return true if it had any effect

getNotificationRuleArn

public java.lang.String getNotificationRuleArn()

The ARN of the notification rule (i.e. arn:aws:codestar-notifications:::notificationrule/01234abcde).

Specified by:

getNotificationRuleArn in interface INotificationRule