You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* adding missing properties of EventBridgeRule
* adding DeadLetterConfig Object and RetryPolicy Object to Data Types section
* improving EventBridgeRule example
Copy file name to clipboardExpand all lines: versions/2016-10-31.md
+37Lines changed: 37 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -775,10 +775,13 @@ The object describing an event source with type `EventBridgeRule`.
775
775
776
776
Property Name | Type | Description
777
777
---|:---:|---
778
+
DeadLetterConfig | [DeadLetterConfig Object](#deadletterconfig-object) | Configure the Amazon Simple Queue Service (Amazon SQS) queue where EventBridge sends events after a failed target invocation.
778
779
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.
779
780
EventBusName | `string` | The event bus to associate with this rule. If you omit this, the default event bus is used.
780
781
Input | `string` | JSON-formatted string to pass to the function as the event body. This value overrides the matched event.
781
782
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.
TargetArn: ARN of the SQS queue or SNS topic to use as DLQ.
1038
1051
```
1039
1052
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
+
1040
1077
#### DeploymentPreference Object
1041
1078
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.
1042
1079
TriggerConfigurations takes a list of [TriggerConfig](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_TriggerConfig.html) objects.
0 commit comments