# RepositoryNotifyOnOptions

Additional options to pass to the notification rule.

Extends: RepositoryNotifyOnOptions
Extends: NotificationRuleOptions

- Source: [`aws-codecommit/lib/repository.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-codecommit/lib/repository.ts#L22)

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codecommit as codecommit } from 'aws-cdk-lib';
import { aws_codestarnotifications as codestarnotifications } from 'aws-cdk-lib';
const repositoryNotifyOnOptions: codecommit.RepositoryNotifyOnOptions = {
  events: [codecommit.RepositoryNotificationEvents.COMMIT_COMMENT],

  // the properties below are optional
  createdBy: 'createdBy',
  detailType: codestarnotifications.DetailType.BASIC,
  enabled: false,
  notificationRuleName: 'notificationRuleName',
};
```

## Properties

- `createdBy`: string — The name or email alias of the person who created the notification rule.

  **Default:** No alias provided

  If not specified, it means that the creator's alias is not provided.

- `detailType`: [DetailType](/cdk/api/v2/docs/aws-cdk-lib.aws_codestarnotifications.DetailType.html) = DetailType.FULL — 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.

- `enabled`: boolean = true — The status of the notification rule.

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

- `events`: [RepositoryNotificationEvents](/cdk/api/v2/docs/aws-cdk-lib.aws_codecommit.RepositoryNotificationEvents.html)[] (required) — A list of event types associated with this notification rule for CodeCommit repositories.

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

- `notificationRuleName`: string — The name for the notification rule.

  **Default:** generated from the `id`

  Notification rule names must be unique in your AWS account.