Skip to content

Commit 24df81b

Browse files
authored
docs: updating EventBridgeRule documentation (#2236)
* adding missing properties of EventBridgeRule * adding DeadLetterConfig Object and RetryPolicy Object to Data Types section * improving EventBridgeRule example
1 parent 6c5981b commit 24df81b

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

versions/2016-10-31.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -775,10 +775,13 @@ The object describing an event source with type `EventBridgeRule`.
775775

776776
Property Name | Type | Description
777777
---|:---:|---
778+
DeadLetterConfig | [DeadLetterConfig Object](#deadletterconfig-object) | Configure the Amazon Simple Queue Service (Amazon SQS) queue where EventBridge sends events after a failed target invocation.
778779
Pattern | [Event Pattern Object](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) | **Required.** Pattern describing which EventBridge events trigger the function. Only matching events trigger the function.
779780
EventBusName | `string` | The event bus to associate with this rule. If you omit this, the default event bus is used.
780781
Input | `string` | JSON-formatted string to pass to the function as the event body. This value overrides the matched event.
781782
InputPath | `string` | JSONPath describing the part of the event to pass to the function.
783+
RetryPolicy | [RetryPolicy Object](#retrypolicy-object) | A RetryPolicy object that includes information about the retry policy settings.
784+
Target | [Target Object](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-target.html) | Configures the AWS resource that EventBridge invokes when a rule is triggered.
782785

783786
##### Example: EventBridge event source object
784787

@@ -789,6 +792,14 @@ Properties:
789792
detail:
790793
state:
791794
- terminated
795+
RetryPolicy:
796+
MaximumRetryAttempts: 5
797+
MaximumEventAgeInSeconds: 900
798+
DeadLetterConfig:
799+
Type: SQS
800+
QueueLogicalId: EBRuleDLQ
801+
Target:
802+
Id: MyTarget
792803
```
793804

794805
#### CloudWatchLogs
@@ -992,6 +1003,8 @@ Properties:
9921003
- [S3 Location Object](#s3-location-object)
9931004
- [Application Location Object](#application-id-object)
9941005
- [DeadLetterQueue Object](#deadletterqueue-object)
1006+
- [DeadLetterConfig Object](#deadletterconfig-object)
1007+
- [RetryPolicy Object](#retrypolicy-object)
9951008
- [Cors Configuration](#cors-configuration)
9961009
- [API EndpointConfiguration Object](#api-endpointconfiguration-object)
9971010
- [API Auth Object](#api-auth-object)
@@ -1037,6 +1050,30 @@ DeadLetterQueue:
10371050
TargetArn: ARN of the SQS queue or SNS topic to use as DLQ.
10381051
```
10391052
1053+
#### DeadLetterConfig Object
1054+
The object used to specify the Amazon Simple Queue Service (Amazon SQS) queue where EventBridge sends events after a failed target invocation. Invocation can fail, for example, when sending an event to a Lambda function that doesn’t exist, or insufficient permissions to invoke the Lambda function. For more information, see [Event retry policy and using dead-letter queues](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) in the *Amazon EventBridge User Guide*.
1055+
1056+
**Note:** The [AWS::Serverless::Function](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-function.html) resource type has a similar data type, `DeadLetterQueue` which handles failures that occur after successful invocation of the target Lambda function. Examples of this type of failure include Lambda throttling, or errors returned by the Lambda target function. For more information about the function `DeadLetterQueue` property, see [AWS Lambda function dead letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq) in the AWS Lambda Developer Guide.
1057+
1058+
Syntax:
1059+
1060+
```yaml
1061+
DeadLetterConfig:
1062+
Arn: The Amazon Resource Name (ARN) of the Amazon SQS queue specified as the target for the dead-letter queue.
1063+
QueueLogicalId: The custom name of the dead letter queue that AWS SAM creates if `Type` is specified.
1064+
Type: `SQS`
1065+
```
1066+
1067+
#### RetryPolicy Object
1068+
A RetryPolicy object that includes information about the retry policy settings.
1069+
1070+
Syntax:
1071+
1072+
```yaml
1073+
MaximumEventAgeInSeconds: The maximum amount of time, in seconds, to continue to make retry attempts.
1074+
MaximumRetryAttempts: The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is met.
1075+
```
1076+
10401077
#### DeploymentPreference Object
10411078
Specifies the configurations to enable Safe Lambda Deployments. Read the [usage guide](../docs/safe_lambda_deployments.rst) for detailed information. The following shows all available properties of this object.
10421079
TriggerConfigurations takes a list of [TriggerConfig](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_TriggerConfig.html) objects.

0 commit comments

Comments
 (0)