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::UpdateNotificationRuleRequest

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

Overview

Note:

When passing UpdateNotificationRuleRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  arn: "NotificationRuleArn", # required
  name: "NotificationRuleName",
  status: "ENABLED", # accepts ENABLED, DISABLED
  event_type_ids: ["EventTypeId"],
  targets: [
    {
      target_type: "TargetType",
      target_address: "TargetAddress",
    },
  ],
  detail_type: "BASIC", # accepts BASIC, FULL
}

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the notification rule.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the notification rule.

#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.

Returns:

  • (Array<String>)

    A list of event types associated with this notification rule.

#nameString

The name of the notification rule.

Returns:

  • (String)

    The name of the notification rule.

#statusString

The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String)

    The status of the notification rule.

#targetsArray<Types::Target>

The address and type of the targets to receive notifications from this notification rule.

Returns:

  • (Array<Types::Target>)

    The address and type of the targets to receive notifications from this notification rule.