Package 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.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.919Z") @Stability(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.*;
 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(Map.of(
                 "tagsKey", "tags"))
         .targetAddress("targetAddress")
         .build();

  • Method Details

    • getDetailType

      @Stability(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(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(Stable) @NotNull String getName()
      The name for the notification rule.

      Notification rule names must be unique in your AWS account .

    • getResource

      @Stability(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(Stable) @NotNull Object getTargets()
      A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and AWS Chatbot clients to associate with the notification rule.

    • getCreatedBy

      @Stability(Stable) @Nullable default String getCreatedBy()
      AWS::CodeStarNotifications::NotificationRule.CreatedBy.

    • getEventTypeId

      @Stability(Stable) @Nullable default String getEventTypeId()
      AWS::CodeStarNotifications::NotificationRule.EventTypeId.

    • getStatus

      @Stability(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(Stable) @Nullable default Map<String,String> getTags()
      A list of tags to apply to this notification rule.

      Key names cannot start with " aws ".

    • getTargetAddress

      @Stability(Stable) @Nullable default String getTargetAddress()
      AWS::CodeStarNotifications::NotificationRule.TargetAddress.

    • builder

      @Stability(Stable) static CfnNotificationRuleProps.Builder builder()
      Returns:
      a CfnNotificationRuleProps.Builder of CfnNotificationRuleProps