Skip to content

Create Notification Rule

codestarnotifications_create_notification_rule R Documentation

Creates a notification rule for a resource

Description

Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as Chatbot topics or Chatbot clients configured for Slack) where you want to receive them.

Usage

codestarnotifications_create_notification_rule(Name, EventTypeIds,
  Resource, Targets, DetailType, ClientRequestToken, Tags, Status)

Arguments

Name

[required] The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.

EventTypeIds

[required] A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.

Resource

[required] The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in CodePipeline, repositories in CodeCommit, and build projects in CodeBuild.

Targets

[required] A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.

DetailType

[required] 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.

ClientRequestToken

A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.

The Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an idempotency token is created for you.

Tags

A list of tags to apply to this notification rule. Key names cannot start with "aws".

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.

Value

A list with the following syntax: 

list(
  Arn = "string"
)

Request syntax

svc$create_notification_rule(
  Name = "string",
  EventTypeIds = list(
    "string"
  ),
  Resource = "string",
  Targets = list(
    list(
      TargetType = "string",
      TargetAddress = "string"
    )
  ),
  DetailType = "BASIC"|"FULL",
  ClientRequestToken = "string",
  Tags = list(
    "string"
  ),
  Status = "ENABLED"|"DISABLED"
)