class Aws::CodeStarNotifications::Types::CreateNotificationRuleRequest
@note When making an API call, you may pass CreateNotificationRuleRequest
data as a hash: { name: "NotificationRuleName", # required event_type_ids: ["EventTypeId"], # required resource: "NotificationRuleResource", # required targets: [ # required { target_type: "TargetType", target_address: "TargetAddress", }, ], detail_type: "BASIC", # required, accepts BASIC, FULL client_request_token: "ClientRequestToken", tags: { "TagKey" => "TagValue", }, status: "ENABLED", # accepts ENABLED, DISABLED }
@!attribute [rw] name
The name for the notification rule. Notifictaion rule names must be unique in your AWS account. @return [String]
@!attribute [rw] event_type_ids
A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary. @return [Array<String>]
@!attribute [rw] 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. @return [String]
@!attribute [rw] targets
A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule. @return [Array<Types::Target>]
@!attribute [rw] 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. @return [String]
@!attribute [rw] client_request_token
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. <note markdown="1"> The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you. </note> **A suitable default value is auto-generated.** You should normally not need to pass this option. @return [String]
@!attribute [rw] tags
A list of tags to apply to this notification rule. Key names cannot start with "aws". @return [Hash<String,String>]
@!attribute [rw] 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. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/CreateNotificationRuleRequest AWS API Documentation
Constants
- SENSITIVE