Package software.amazon.awscdk.services.codestarnotifications

Class CfnNotificationRule.Builder

java.lang.Object
software.amazon.awscdk.services.codestarnotifications.CfnNotificationRule.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnNotificationRule>
Enclosing class:
CfnNotificationRule
@Stability(Stable) public static final class CfnNotificationRule.Builder extends Object implements software.amazon.jsii.Builder<CfnNotificationRule>
A fluent builder for CfnNotificationRule.

  • Method Details

    • create

      @Stability(Stable) public static CfnNotificationRule.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnNotificationRule.Builder.

    • detailType

      @Stability(Stable) public CfnNotificationRule.Builder detailType(String 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 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.

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

    • eventTypeIds

      @Stability(Stable) public CfnNotificationRule.Builder eventTypeIds(List<String> eventTypeIds)
      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:
      eventTypeIds - A list of event types associated with this notification rule. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnNotificationRule.Builder name(String name)
      The name for the notification rule.

      Notification rule names must be unique in your AWS account .

      Parameters:
      name - The name for the notification rule. This parameter is required.
      Returns:
      this

    • resource

      @Stability(Stable) public CfnNotificationRule.Builder resource(String resource)
      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 .

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

    • targets

      @Stability(Stable) public CfnNotificationRule.Builder targets(IResolvable targets)
      A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and AWS Chatbot clients to associate with the notification rule.

      Parameters:
      targets - A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and AWS Chatbot clients to associate with the notification rule. This parameter is required.
      Returns:
      this

    • targets

      @Stability(Stable) public CfnNotificationRule.Builder targets(List<? extends Object> targets)
      A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and AWS Chatbot clients to associate with the notification rule.

      Parameters:
      targets - A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and AWS Chatbot clients to associate with the notification rule. This parameter is required.
      Returns:
      this

    • createdBy

      @Stability(Stable) public CfnNotificationRule.Builder createdBy(String createdBy)
      AWS::CodeStarNotifications::NotificationRule.CreatedBy.

      Parameters:
      createdBy - AWS::CodeStarNotifications::NotificationRule.CreatedBy. This parameter is required.
      Returns:
      this

    • eventTypeId

      @Stability(Stable) public CfnNotificationRule.Builder eventTypeId(String eventTypeId)
      AWS::CodeStarNotifications::NotificationRule.EventTypeId.

      Parameters:
      eventTypeId - AWS::CodeStarNotifications::NotificationRule.EventTypeId. This parameter is required.
      Returns:
      this

    • status

      @Stability(Stable) public CfnNotificationRule.Builder status(String status)
      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.

      Parameters:
      status - The status of the notification rule. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnNotificationRule.Builder tags(Map<String,String> tags)
      A list of tags to apply to this notification rule.

      Key names cannot start with " aws ".

      Parameters:
      tags - A list of tags to apply to this notification rule. This parameter is required.
      Returns:
      this

    • targetAddress

      @Stability(Stable) public CfnNotificationRule.Builder targetAddress(String targetAddress)
      AWS::CodeStarNotifications::NotificationRule.TargetAddress.

      Parameters:
      targetAddress - AWS::CodeStarNotifications::NotificationRule.TargetAddress. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnNotificationRule build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnNotificationRule>
      Returns:
      a newly built instance of CfnNotificationRule.