Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions versions/2016-10-31.md
Original file line number Diff line number Diff line change
Expand Up @@ -772,10 +772,13 @@ The object describing an event source with type `EventBridgeRule`.

Property Name | Type | Description
---|:---:|---
DeadLetterConfig | [DeadLetterConfig Object](#deadletterconfig-object) | Configure the Amazon Simple Queue Service (Amazon SQS) queue where EventBridge sends events after a failed target invocation.
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.
EventBusName | `string` | The event bus to associate with this rule. If you omit this, the default event bus is used.
Input | `string` | JSON-formatted string to pass to the function as the event body. This value overrides the matched event.
InputPath | `string` | JSONPath describing the part of the event to pass to the function.
RetryPolicy | [RetryPolicy Object](#retrypolicy-object) | A RetryPolicy object that includes information about the retry policy settings.
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.

##### Example: EventBridge event source object

Expand All @@ -786,6 +789,14 @@ Properties:
detail:
state:
- terminated
RetryPolicy:
MaximumRetryAttempts: 5
MaximumEventAgeInSeconds: 900
DeadLetterConfig:
Type: SQS
QueueLogicalId: EBRuleDLQ
Target:
Id: MyTarget
```

#### CloudWatchLogs
Expand Down Expand Up @@ -989,6 +1000,8 @@ Properties:
- [S3 Location Object](#s3-location-object)
- [Application Location Object](#application-id-object)
- [DeadLetterQueue Object](#deadletterqueue-object)
- [DeadLetterConfig Object](#deadletterconfig-object)
- [RetryPolicy Object](#retrypolicy-object)
- [Cors Configuration](#cors-configuration)
- [API EndpointConfiguration Object](#api-endpointconfiguration-object)
- [API Auth Object](#api-auth-object)
Expand Down Expand Up @@ -1034,6 +1047,30 @@ DeadLetterQueue:
TargetArn: ARN of the SQS queue or SNS topic to use as DLQ.
```

#### DeadLetterConfig Object
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*.

**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.

Syntax:

```yaml
DeadLetterConfig:
Arn: The Amazon Resource Name (ARN) of the Amazon SQS queue specified as the target for the dead-letter queue.
QueueLogicalId: The custom name of the dead letter queue that AWS SAM creates if `Type` is specified.
Type: `SQS`
```

#### RetryPolicy Object
A RetryPolicy object that includes information about the retry policy settings.

Syntax:

```yaml
MaximumEventAgeInSeconds: The maximum amount of time, in seconds, to continue to make retry attempts.
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.
```

#### DeploymentPreference Object
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.
TriggerConfigurations takes a list of [TriggerConfig](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_TriggerConfig.html) objects.
Expand Down