class DynamoDBSource 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Pipes.Sources.Alpha.DynamoDBSource
Go	github.com/aws/aws-cdk-go/awscdkpipessourcesalpha/v2#DynamoDBSource
Java	software.amazon.awscdk.services.pipes.sources.alpha.DynamoDBSource
Python	aws_cdk.aws_pipes_sources_alpha.DynamoDBSource
TypeScript (source)	@aws-cdk/aws-pipes-sources-alpha » DynamoDBSource

Implements ISource

Extends StreamSource

A source that reads from an DynamoDB stream.

Example

const table = new ddb.TableV2(this, 'MyTable', {
  partitionKey: {
    name: 'id',
    type: ddb.AttributeType.STRING,
  },
  dynamoStream: ddb.StreamViewType.NEW_IMAGE,
});
declare const targetQueue: sqs.Queue;

const pipeSource = new sources.DynamoDBSource(table, {
  startingPosition: sources.DynamoDBStartingPosition.LATEST,
});

const pipe = new pipes.Pipe(this, 'Pipe', {
  source: pipeSource,
  target: new SqsTarget(targetQueue)
});

Initializer

new DynamoDBSource(table: ITableV2, parameters: DynamoDBSourceParameters)

Parameters

• table ITableV2
• parameters DynamoDBSourceParameters

Properties

Name	Type	Description
sourceArn🔹	string	The ARN of the source resource.
sourceParameters🔹	StreamSourceParameters	Base parameters for streaming sources.
deadLetterTarget?🔹	IQueue | ITopic	The dead-letter SQS queue or SNS topic.

---

sourceArn🔹

Type: string

The ARN of the source resource.

---

sourceParameters🔹

Type: StreamSourceParameters

Base parameters for streaming sources.

---

deadLetterTarget?🔹

Type: IQueue | ITopic (optional)

The dead-letter SQS queue or SNS topic.

Methods

Name	Description
bind(_pipe)🔹	Bind the source to a pipe.
grantPush(grantee, deadLetterTarget?)🔹	Grants the pipe role permission to publish to the dead-letter target.
grantRead(grantee)🔹	Grant the pipe role read access to the source.

---

bind(_pipe)🔹

public bind(_pipe: IPipe): SourceConfig

Parameters

• _pipe IPipe

Returns

• SourceConfig

Bind the source to a pipe.

---

grantPush(grantee, deadLetterTarget?)🔹

public grantPush(grantee: IRole, deadLetterTarget?: IQueue | ITopic): void

Parameters

• grantee IRole
• deadLetterTarget IQueue | ITopic

Grants the pipe role permission to publish to the dead-letter target.

---

grantRead(grantee)🔹

public grantRead(grantee: IRole): void

Parameters

• grantee IRole

Grant the pipe role read access to the source.