Class: Aws::Notifications::Types::GetEventRuleResponse

Inherits:

Struct

• Object
• Struct
• Aws::Notifications::Types::GetEventRuleResponse

Includes:

Structure

Defined in:

lib/aws-sdk-notifications/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The ARN of the resource.

• #creation_time ⇒ Time

  The date when the EventRule was created.

• #event_pattern ⇒ String

  An additional event pattern used to further filter the events this EventRule receives.

• #event_type ⇒ String

  The event type to match.

• #managed_rules ⇒ Array<String>

  A list of managed rules from EventBridge that are associated with this EventRule.

• #notification_configuration_arn ⇒ String

  The ARN of a NotificationConfiguration.

• #regions ⇒ Array<String>

  A list of Amazon Web Services Regions that send events to this EventRule.

• #source ⇒ String

  The matched event source.

• #status_summary_by_region ⇒ Hash<String,Types::EventRuleStatusSummary>

  A list of an EventRule‘s status by Region.

Instance Attribute Details

#arn ⇒ String

The ARN of the resource.

Returns:

• (String)

# File 'lib/aws-sdk-notifications/types.rb', line 782

class GetEventRuleResponse < Struct.new(
  :arn,
  :notification_configuration_arn,
  :creation_time,
  :source,
  :event_type,
  :event_pattern,
  :regions,
  :managed_rules,
  :status_summary_by_region)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The date when the EventRule was created.

Returns:

• (Time)

# File 'lib/aws-sdk-notifications/types.rb', line 782

class GetEventRuleResponse < Struct.new(
  :arn,
  :notification_configuration_arn,
  :creation_time,
  :source,
  :event_type,
  :event_pattern,
  :regions,
  :managed_rules,
  :status_summary_by_region)
  SENSITIVE = []
  include Aws::Structure
end

#event_pattern ⇒ String

An additional event pattern used to further filter the events this EventRule receives.

For more information, see [Amazon EventBridge event patterns] in the *Amazon EventBridge User Guide.*

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html

Returns:

• (String)

# File 'lib/aws-sdk-notifications/types.rb', line 782

class GetEventRuleResponse < Struct.new(
  :arn,
  :notification_configuration_arn,
  :creation_time,
  :source,
  :event_type,
  :event_pattern,
  :regions,
  :managed_rules,
  :status_summary_by_region)
  SENSITIVE = []
  include Aws::Structure
end

#event_type ⇒ String

The event type to match.

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see [Event delivery from Amazon Web Services services] in the *Amazon EventBridge User Guide*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level

Returns:

• (String)

# File 'lib/aws-sdk-notifications/types.rb', line 782

class GetEventRuleResponse < Struct.new(
  :arn,
  :notification_configuration_arn,
  :creation_time,
  :source,
  :event_type,
  :event_pattern,
  :regions,
  :managed_rules,
  :status_summary_by_region)
  SENSITIVE = []
  include Aws::Structure
end

#managed_rules ⇒ Array<String>

A list of managed rules from EventBridge that are associated with this EventRule.

<note markdown=“1”> These are created by User Notifications within your account so this EventRule functions.

</note>

Returns:

• (Array<String>)

# File 'lib/aws-sdk-notifications/types.rb', line 782

class GetEventRuleResponse < Struct.new(
  :arn,
  :notification_configuration_arn,
  :creation_time,
  :source,
  :event_type,
  :event_pattern,
  :regions,
  :managed_rules,
  :status_summary_by_region)
  SENSITIVE = []
  include Aws::Structure
end

#notification_configuration_arn ⇒ String

The ARN of a NotificationConfiguration.

Returns:

• (String)

# File 'lib/aws-sdk-notifications/types.rb', line 782

class GetEventRuleResponse < Struct.new(
  :arn,
  :notification_configuration_arn,
  :creation_time,
  :source,
  :event_type,
  :event_pattern,
  :regions,
  :managed_rules,
  :status_summary_by_region)
  SENSITIVE = []
  include Aws::Structure
end

#regions ⇒ Array<String>

A list of Amazon Web Services Regions that send events to this EventRule.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-notifications/types.rb', line 782

class GetEventRuleResponse < Struct.new(
  :arn,
  :notification_configuration_arn,
  :creation_time,
  :source,
  :event_type,
  :event_pattern,
  :regions,
  :managed_rules,
  :status_summary_by_region)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ String

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see [Event delivery from Amazon Web Services services] in the *Amazon EventBridge User Guide*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level

Returns:

• (String)

# File 'lib/aws-sdk-notifications/types.rb', line 782

class GetEventRuleResponse < Struct.new(
  :arn,
  :notification_configuration_arn,
  :creation_time,
  :source,
  :event_type,
  :event_pattern,
  :regions,
  :managed_rules,
  :status_summary_by_region)
  SENSITIVE = []
  include Aws::Structure
end

#status_summary_by_region ⇒ Hash<String,Types::EventRuleStatusSummary>

A list of an EventRule‘s status by Region. Regions are mapped to EventRuleStatusSummary.

Returns:

• (Hash<String,Types::EventRuleStatusSummary>)

# File 'lib/aws-sdk-notifications/types.rb', line 782

class GetEventRuleResponse < Struct.new(
  :arn,
  :notification_configuration_arn,
  :creation_time,
  :source,
  :event_type,
  :event_pattern,
  :regions,
  :managed_rules,
  :status_summary_by_region)
  SENSITIVE = []
  include Aws::Structure
end