software.amazon.awscdk.services.codestarnotifications

Class NotificationRule.Builder

java.lang.Object

software.amazon.awscdk.services.codestarnotifications.NotificationRule.Builder

Enclosing class:

NotificationRule

public static final class NotificationRule.Builder
extends java.lang.Object

A fluent builder for NotificationRule.

Method Summary

Modifier and Type	Method and Description
NotificationRule	build()
static NotificationRule.Builder	create(software.constructs.Construct scope, java.lang.String id)
NotificationRule.Builder	detailType(DetailType detailType) The level of detail to include in the notifications for this resource.
NotificationRule.Builder	enabled(java.lang.Boolean enabled) The status of the notification rule.
NotificationRule.Builder	events(java.util.List<java.lang.String> events) A list of event types associated with this notification rule.
NotificationRule.Builder	notificationRuleName(java.lang.String notificationRuleName) The name for the notification rule.
NotificationRule.Builder	source(INotificationRuleSource source) The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
NotificationRule.Builder	targets(java.util.List<? extends INotificationRuleTarget> targets) The targets to register for the notification destination.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static NotificationRule.Builder create(software.constructs.Construct scope,
                                              java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of NotificationRule.Builder.

detailType

public NotificationRule.Builder detailType(DetailType detailType)

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.

Default: DetailType.FULL

Parameters:

detailType - The level of detail to include in the notifications for this resource. This parameter is required.

Returns:

this

enabled

public NotificationRule.Builder enabled(java.lang.Boolean enabled)

The status of the notification rule.

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

Default: true

Parameters:

enabled - The status of the notification rule. This parameter is required.

Returns:

this

notificationRuleName

public NotificationRule.Builder notificationRuleName(java.lang.String notificationRuleName)

The name for the notification rule.

Notification rule names must be unique in your AWS account.

Default: - generated from the `id`

Parameters:

notificationRuleName - The name for the notification rule. This parameter is required.

Returns:

this

events

public NotificationRule.Builder events(java.util.List<java.lang.String> events)

A list of event types associated with this notification rule.

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

Parameters:

events - A list of event types associated with this notification rule. This parameter is required.

Returns:

this

See Also:

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

source

public NotificationRule.Builder source(INotificationRuleSource source)

The Amazon Resource Name (ARN) of the resource to associate with the notification rule.

Currently, Supported sources include pipelines in AWS CodePipeline, build projects in AWS CodeBuild, and repositories in AWS CodeCommit in this L2 constructor.

Parameters:

source - The Amazon Resource Name (ARN) of the resource to associate with the notification rule. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-resource

targets

public NotificationRule.Builder targets(java.util.List<? extends INotificationRuleTarget> targets)

The targets to register for the notification destination.

Default: - No targets are added to the rule. Use `addTarget()` to add a target.

Parameters:

targets - The targets to register for the notification destination. This parameter is required.

Returns:

this

build

public NotificationRule build()