Class: Aws::CodeStarNotifications::Types::DescribeNotificationRuleResult

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

Overview

Constant Summary collapse

SENSITIVE =
[:name]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 298

class DescribeNotificationRuleResult < Struct.new(
  :arn,
  :name,
  :event_types,
  :resource,
  :targets,
  :detail_type,
  :created_by,
  :status,
  :created_timestamp,
  :last_modified_timestamp,
  :tags)
  SENSITIVE = [:name]
  include Aws::Structure
end

#created_byString

The name or email alias of the person who created the notification rule.

Returns:

  • (String)


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 298

class DescribeNotificationRuleResult < Struct.new(
  :arn,
  :name,
  :event_types,
  :resource,
  :targets,
  :detail_type,
  :created_by,
  :status,
  :created_timestamp,
  :last_modified_timestamp,
  :tags)
  SENSITIVE = [:name]
  include Aws::Structure
end

#created_timestampTime

The date and time the notification rule was created, in timestamp format.

Returns:

  • (Time)


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 298

class DescribeNotificationRuleResult < Struct.new(
  :arn,
  :name,
  :event_types,
  :resource,
  :targets,
  :detail_type,
  :created_by,
  :status,
  :created_timestamp,
  :last_modified_timestamp,
  :tags)
  SENSITIVE = [:name]
  include Aws::Structure
end

#detail_typeString

The level of detail included 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)


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 298

class DescribeNotificationRuleResult < Struct.new(
  :arn,
  :name,
  :event_types,
  :resource,
  :targets,
  :detail_type,
  :created_by,
  :status,
  :created_timestamp,
  :last_modified_timestamp,
  :tags)
  SENSITIVE = [:name]
  include Aws::Structure
end

#event_typesArray<Types::EventTypeSummary>

A list of the event types associated with the notification rule.

Returns:



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 298

class DescribeNotificationRuleResult < Struct.new(
  :arn,
  :name,
  :event_types,
  :resource,
  :targets,
  :detail_type,
  :created_by,
  :status,
  :created_timestamp,
  :last_modified_timestamp,
  :tags)
  SENSITIVE = [:name]
  include Aws::Structure
end

#last_modified_timestampTime

The date and time the notification rule was most recently updated, in timestamp format.

Returns:

  • (Time)


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 298

class DescribeNotificationRuleResult < Struct.new(
  :arn,
  :name,
  :event_types,
  :resource,
  :targets,
  :detail_type,
  :created_by,
  :status,
  :created_timestamp,
  :last_modified_timestamp,
  :tags)
  SENSITIVE = [:name]
  include Aws::Structure
end

#nameString

The name of the notification rule.

Returns:

  • (String)


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 298

class DescribeNotificationRuleResult < Struct.new(
  :arn,
  :name,
  :event_types,
  :resource,
  :targets,
  :detail_type,
  :created_by,
  :status,
  :created_timestamp,
  :last_modified_timestamp,
  :tags)
  SENSITIVE = [:name]
  include Aws::Structure
end

#resourceString

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

Returns:

  • (String)


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 298

class DescribeNotificationRuleResult < Struct.new(
  :arn,
  :name,
  :event_types,
  :resource,
  :targets,
  :detail_type,
  :created_by,
  :status,
  :created_timestamp,
  :last_modified_timestamp,
  :tags)
  SENSITIVE = [:name]
  include Aws::Structure
end

#statusString

The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).

Returns:

  • (String)


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 298

class DescribeNotificationRuleResult < Struct.new(
  :arn,
  :name,
  :event_types,
  :resource,
  :targets,
  :detail_type,
  :created_by,
  :status,
  :created_timestamp,
  :last_modified_timestamp,
  :tags)
  SENSITIVE = [:name]
  include Aws::Structure
end

#tagsHash<String,String>

The tags associated with the notification rule.

Returns:

  • (Hash<String,String>)


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 298

class DescribeNotificationRuleResult < Struct.new(
  :arn,
  :name,
  :event_types,
  :resource,
  :targets,
  :detail_type,
  :created_by,
  :status,
  :created_timestamp,
  :last_modified_timestamp,
  :tags)
  SENSITIVE = [:name]
  include Aws::Structure
end

#targetsArray<Types::TargetSummary>

A list of the SNS topics associated with the notification rule.

Returns:



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 298

class DescribeNotificationRuleResult < Struct.new(
  :arn,
  :name,
  :event_types,
  :resource,
  :targets,
  :detail_type,
  :created_by,
  :status,
  :created_timestamp,
  :last_modified_timestamp,
  :tags)
  SENSITIVE = [:name]
  include Aws::Structure
end