PipelineNotifyOnOptions

class aws_cdk.aws_codepipeline.PipelineNotifyOnOptions(*, detail_type=None, enabled=None, notification_rule_name=None, events)

Bases: aws_cdk.aws_codestarnotifications.NotificationRuleOptions

Additional options to pass to the notification rule.

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

  • events (Sequence[PipelineNotificationEvents]) – A list of event types associated with this notification rule for CodePipeline Pipeline. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.

Example:

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

pipeline_notify_on_options = codepipeline.PipelineNotifyOnOptions(
    events=[codepipeline.PipelineNotificationEvents.PIPELINE_EXECUTION_FAILED],

    # the properties below are optional
    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]

events

A list of event types associated with this notification rule for CodePipeline Pipeline.

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

See

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

Return type

List[PipelineNotificationEvents]

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]