software.amazon.awscdk.services.codestarnotifications

Interface CfnNotificationRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnNotificationRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.577Z")
 @Stability(value=Stable)
public interface CfnNotificationRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnNotificationRule`.

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.codestarnotifications.*;
 Object tags;
 CfnNotificationRuleProps cfnNotificationRuleProps = CfnNotificationRuleProps.builder()
         .detailType("detailType")
         .eventTypeIds(List.of("eventTypeIds"))
         .name("name")
         .resource("resource")
         .targets(List.of(TargetProperty.builder()
                 .targetAddress("targetAddress")
                 .targetType("targetType")
                 .build()))
         // the properties below are optional
         .createdBy("createdBy")
         .eventTypeId("eventTypeId")
         .status("status")
         .tags(tags)
         .targetAddress("targetAddress")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnNotificationRuleProps.Builder	builder()
default String	getCreatedBy() `AWS::CodeStarNotifications::NotificationRule.CreatedBy`.
String	getDetailType() The level of detail to include in the notifications for this resource.
default String	getEventTypeId() `AWS::CodeStarNotifications::NotificationRule.EventTypeId`.
List<String>	getEventTypeIds() A list of event types associated with this notification rule.
String	getName() The name for the notification rule.
String	getResource() The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
default String	getStatus() The status of the notification rule.
default Object	getTags() A list of tags to apply to this notification rule.
default String	getTargetAddress() `AWS::CodeStarNotifications::NotificationRule.TargetAddress`.
Object	getTargets() A list of Amazon Resource Names (ARNs) of AWS Chatbot topics and AWS Chatbot clients to associate with the notification rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDetailType

@Stability(value=Stable)
 @NotNull
String getDetailType()

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 Amazon 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.

getEventTypeIds

@Stability(value=Stable)
 @NotNull
List<String> getEventTypeIds()

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 .

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name for the notification rule.

Notification rule names must be unique in your AWS account .

getResource

@Stability(value=Stable)
 @NotNull
String getResource()

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

Supported resources include pipelines in AWS CodePipeline , repositories in AWS CodeCommit , and build projects in AWS CodeBuild .

getTargets

@Stability(value=Stable)
 @NotNull
Object getTargets()

A list of Amazon Resource Names (ARNs) of AWS Chatbot topics and AWS Chatbot clients to associate with the notification rule.

getCreatedBy

@Stability(value=Stable)
 @Nullable
default String getCreatedBy()

`AWS::CodeStarNotifications::NotificationRule.CreatedBy`.

getEventTypeId

@Stability(value=Stable)
 @Nullable
default String getEventTypeId()

`AWS::CodeStarNotifications::NotificationRule.EventTypeId`.

getStatus

@Stability(value=Stable)
 @Nullable
default String getStatus()

The status of the notification rule.

The default value is ENABLED . If the status is set to DISABLED , notifications aren't sent for the notification rule.

getTags

@Stability(value=Stable)
 @Nullable
default Object getTags()

A list of tags to apply to this notification rule.

Key names cannot start with " aws ".

getTargetAddress

@Stability(value=Stable)
 @Nullable
default String getTargetAddress()

`AWS::CodeStarNotifications::NotificationRule.TargetAddress`.

builder

@Stability(value=Stable)
static CfnNotificationRuleProps.Builder builder()

Returns:

a CfnNotificationRuleProps.Builder of CfnNotificationRuleProps