NotificationRuleOptions

class aws_cdk.aws_codestarnotifications.NotificationRuleOptions(*, detail_type=None, enabled=None, notification_rule_name=None)

Bases: object

Standard set of options for notifyOnXxx codestar notification handler on construct.

Parameters
  • detail_type (Optional[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

  • enabled (Optional[bool]) – The status of the notification rule. If the enabled is set to DISABLED, notifications aren’t sent for the notification rule. Default: true

  • notification_rule_name (Optional[str]) – The name for the notification rule. Notification rule names must be unique in your AWS account. Default: - generated from the id

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codestarnotifications as codestarnotifications

notification_rule_options = codestarnotifications.NotificationRuleOptions(
    detail_type=codestarnotifications.DetailType.BASIC,
    enabled=False,
    notification_rule_name="notificationRuleName"
)

Attributes

detail_type

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

Return type

Optional[DetailType]

enabled

The status of the notification rule.

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

Default

true

Return type

Optional[bool]

notification_rule_name

The name for the notification rule.

Notification rule names must be unique in your AWS account.

Default
  • generated from the id

Return type

Optional[str]