Skip to content

Latest commit

 

History

History
125 lines (99 loc) · 7.75 KB

sam-property-function-dynamodb.md

File metadata and controls

125 lines (99 loc) · 7.75 KB
Raw

DynamoDB

DynamoDB streaming event source type.

SAM generates AWS::Lambda::EventSourceMapping resource when this event type is set

Syntax

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

YAML

  [BatchSize](#sam-function-dynamodb-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-dynamodb-bisectbatchonfunctionerror): Boolean
  [DestinationConfig](#sam-function-dynamodb-destinationconfig): [DestinationConfig](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)
  [Enabled](#sam-function-dynamodb-enabled): Boolean
  [MaximumBatchingWindowInSeconds](#sam-function-dynamodb-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-dynamodb-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-dynamodb-maximumretryattempts): Integer
  [ParallelizationFactor](#sam-function-dynamodb-parallelizationfactor): Integer
  [StartingPosition](#sam-function-dynamodb-startingposition): String
  [Stream](#sam-function-dynamodb-stream): String

Properties

BatchSize The maximum number of items to retrieve in a single batch.
Type: Integer
Required: No
Default: 100
AWS CloudFormation Compatibility: This property is passed directly to the [BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize) property of an AWS::Lambda::EventSourceMapping.
Minimum: 1
Maximum: 1000

BisectBatchOnFunctionError If the function returns an error, split the batch in two and retry.
Type: Boolean
Required: No
AWS CloudFormation Compatibility: This property is passed directly to the [BisectBatchOnFunctionError](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror) property of an AWS::Lambda::EventSourceMapping.

DestinationConfig An Amazon SQS queue or Amazon SNS topic destination for discarded records.
Type: DestinationConfig
Required: No
AWS CloudFormation Compatibility: This property is passed directly to the [DestinationConfig](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig) property of an AWS::Lambda::EventSourceMapping.

Enabled Disables the event source mapping to pause polling and invocation.
Type: Boolean
Required: No
AWS CloudFormation Compatibility: This property is passed directly to the [Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled) property of an AWS::Lambda::EventSourceMapping.

MaximumBatchingWindowInSeconds The maximum amount of time to gather records before invoking the function, in seconds.
Type: Integer
Required: No
AWS CloudFormation Compatibility: This property is passed directly to the [MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds) property of an AWS::Lambda::EventSourceMapping.

MaximumRecordAgeInSeconds The maximum age of a record that Lambda sends to a function for processing.
Type: Integer
Required: No
AWS CloudFormation Compatibility: This property is passed directly to the [MaximumRecordAgeInSeconds](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds) property of an AWS::Lambda::EventSourceMapping.

MaximumRetryAttempts The maximum number of times to retry when the function returns an error.
Type: Integer
Required: No
AWS CloudFormation Compatibility: This property is passed directly to the [MaximumRetryAttempts](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts) property of an AWS::Lambda::EventSourceMapping.

ParallelizationFactor The number of batches to process from each shard concurrently.
Type: Integer
Required: No
AWS CloudFormation Compatibility: This property is passed directly to the [ParallelizationFactor](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor) property of an AWS::Lambda::EventSourceMapping.

StartingPosition The position in a stream from which to start reading.
Supported values: TRIM_HORIZON, LATEST.
Type: String
Required: Yes
AWS CloudFormation Compatibility: This property is passed directly to the [StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition) property of an AWS::Lambda::EventSourceMapping.

Stream ARN of the DynamoDB stream.
Type: String
Required: Yes
AWS CloudFormation Compatibility: This property is passed directly to the [EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn) property of an AWS::Lambda::EventSourceMapping.

Examples

DynamoDB Event for Existing DynamoDB Table

DynamoDB Event for a DynamoDB table that already exists in an AWS account.

YAML

Events:
  DDBEvent:
    Properties:
      Stream: arn:aws:dynamodb:us-east-1:123456789012:table/TestTable/stream/2016-08-11T21:21:33.291
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false

DynamoDB Event for DynamoDB Table Declared in Template

DynamoDB Event for a DynamoDB table that is declared in the same template file.

YAML

Events:
  DDBEvent:
    Properties:
      Stream: 
        !GetAtt MyDynamoDBTable.StreamArn   # This must be the name of a DynamoDB table declared in the same template file
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false