AWS::Notifications::EventRule - AWS CloudFormation (original) (raw)

SyntaxPropertiesReturn values

Creates an EventRule that is associated with a specified NotificationConfiguration.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Notifications::EventRule",
  "Properties" : {
      "EventPattern" : String,
      "EventType" : String,
      "NotificationConfigurationArn" : String,
      "Regions" : [ String, ... ],
      "Source" : String
    }
}

YAML

Type: AWS::Notifications::EventRule
Properties:
  EventPattern: String
  EventType: String
  NotificationConfigurationArn: String
  Regions: 
    - String
  Source: String

Properties

EventPattern

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.

Required: No

Type: String

Minimum: 0

Maximum: 4096

Update requires: No interruption

EventType

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 AWS services in the Amazon EventBridge User Guide.

Required: Yes

Type: String

Pattern: ^([a-zA-Z0-9 \-\(\)])+$

Minimum: 1

Maximum: 128

Update requires: Replacement

NotificationConfigurationArn

The ARN for the NotificationConfiguration associated with this EventRule.

Required: Yes

Type: String

Pattern: ^arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}$

Update requires: Replacement

Regions

A list of AWS Regions that send events to this EventRule.

Required: Yes

Type: Array of String

Maximum: 25

Minimum: 2 | 1

Update requires: No interruption

Source

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 AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.

Required: Yes

Type: String

Pattern: ^aws.([a-z0-9\-])+$

Minimum: 1

Maximum: 36

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the configuration created.

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the EventRule. AWS CloudFormation stack generates this ARN and then uses this ARN associated with the NotificationConfiguration.

CreationTime

The creation time of the EventRule.

ManagedRules

A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.

Note

These are created by AWS User Notifications within your account so your EventRules can function.

AWS::Notifications::ChannelAssociation

EventRuleStatusSummary

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.