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

Inherits:

Struct

• Object
• Struct
• Aws::CodeStarNotifications::Types::DescribeNotificationRuleResult

Defined in:

gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name]

Instance Attribute Summary

• #arn ⇒ String

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

• #created_by ⇒ String

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

• #created_timestamp ⇒ Time

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

• #detail_type ⇒ String

  The level of detail included in the notifications for this resource.

• #event_types ⇒ Array<Types::EventTypeSummary>

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

• #last_modified_timestamp ⇒ Time

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

• #name ⇒ String

  The name of the notification rule.

• #resource ⇒ String

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

• #status ⇒ String

  The status of the notification rule.

• #tags ⇒ Hash<String,String>

  The tags associated with the notification rule.

• #targets ⇒ Array<Types::TargetSummary>

  A list of the Chatbot topics and Chatbot clients associated with the notification rule.

Instance Attribute Details

#arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 260

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_by ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 260

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_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 260

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_type ⇒ String

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 Amazon 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)

# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 260

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_types ⇒ Array<Types::EventTypeSummary>

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

Returns:

• (Array<Types::EventTypeSummary>)

# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 260

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_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 260

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

#name ⇒ String

The name of the notification rule.

Returns:

• (String)

# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 260

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

#resource ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 260

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

#status ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 260

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

#tags ⇒ Hash<String,String>

The tags associated with the notification rule.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 260

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

#targets ⇒ Array<Types::TargetSummary>

A list of the Chatbot topics and Chatbot clients associated with the notification rule.

Returns:

• (Array<Types::TargetSummary>)

# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 260

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