Class: Aws::CodeStarNotifications::Types::UpdateNotificationRuleRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb

Overview

Note:

When making an API call, you may pass UpdateNotificationRuleRequest data as a 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
}

Constant Summary collapse

SENSITIVE =
[:name]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 994

class UpdateNotificationRuleRequest < Struct.new(
  :arn,
  :name,
  :status,
  :event_type_ids,
  :targets,
  :detail_type)
  SENSITIVE = [:name]
  include Aws::Structure
end

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

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 994

class UpdateNotificationRuleRequest < Struct.new(
  :arn,
  :name,
  :status,
  :event_type_ids,
  :targets,
  :detail_type)
  SENSITIVE = [:name]
  include Aws::Structure
end

#event_type_idsArray<String>

A list of event types associated with this notification rule.

Returns:

  • (Array<String>)


994
995
996
997
998
999
1000
1001
1002
1003
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 994

class UpdateNotificationRuleRequest < Struct.new(
  :arn,
  :name,
  :status,
  :event_type_ids,
  :targets,
  :detail_type)
  SENSITIVE = [:name]
  include Aws::Structure
end

#nameString

The name of the notification rule.

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 994

class UpdateNotificationRuleRequest < Struct.new(
  :arn,
  :name,
  :status,
  :event_type_ids,
  :targets,
  :detail_type)
  SENSITIVE = [:name]
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 994

class UpdateNotificationRuleRequest < Struct.new(
  :arn,
  :name,
  :status,
  :event_type_ids,
  :targets,
  :detail_type)
  SENSITIVE = [:name]
  include Aws::Structure
end

#targetsArray<Types::Target>

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

Returns:



994
995
996
997
998
999
1000
1001
1002
1003
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 994

class UpdateNotificationRuleRequest < Struct.new(
  :arn,
  :name,
  :status,
  :event_type_ids,
  :targets,
  :detail_type)
  SENSITIVE = [:name]
  include Aws::Structure
end