Class: Aws::Notifications::Types::EventRuleStructure

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-notifications/types.rb

Overview

Contains a complete list of fields related to an ‘EventRule`.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the ‘EventRule`. CloudFormation stack generates this ARN and then uses this ARN to associate with the `NotificationConfiguration`.

Returns:

  • (String) 


682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-notifications/types.rb', line 682

class EventRuleStructure < 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 creation time of the ‘EventRule`.

Returns:

  • (Time) 


682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-notifications/types.rb', line 682

class EventRuleStructure < 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) 


682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-notifications/types.rb', line 682

class EventRuleStructure < 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 this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch 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) 


682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-notifications/types.rb', line 682

class EventRuleStructure < 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 Amazon EventBridge Managed Rule ARNs associated with this ‘EventRule`.

<note markdown=“1”> These are created by User Notifications within your account so your ‘EventRules` can function.

</note>

Returns:

  • (Array<String>) 


682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-notifications/types.rb', line 682

class EventRuleStructure < 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 for the ‘NotificationConfiguration` associated with this `EventRule`.

Returns:

  • (String) 


682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-notifications/types.rb', line 682

class EventRuleStructure < 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>) 


682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-notifications/types.rb', line 682

class EventRuleStructure < 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 event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event 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) 


682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-notifications/types.rb', line 682

class EventRuleStructure < 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:



682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-notifications/types.rb', line 682

class EventRuleStructure < 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