AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeStarNotifications::Types::CreateNotificationRuleRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateNotificationRuleRequest as input to an Aws::Client method, you can use a vanilla 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
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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 AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.

Returns:

  • (String)

    A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter.

#detail_typeString

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.

Possible values:

  • BASIC
  • FULL

Returns:

  • (String)

    The level of detail to include in the notifications for this resource.

#event_type_idsArray<String>

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

Returns:

  • (Array<String>)

    A list of event types associated with this notification rule.

#nameString

The name for the notification rule. Notifictaion rule names must be unique in your AWS account.

Returns:

  • (String)

    The name for the notification rule.

#resourceString

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.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the resource to associate with the notification rule.

#statusString

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.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String)

    The status of the notification rule.

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)

    A list of tags to apply to this notification rule.

#targetsArray<Types::Target>

A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule.

Returns:

  • (Array<Types::Target>)

    A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule.