[](https://github.com/pepperize/cdk-dynamodb-backup/blob/main/LICENSE)
[](https://www.npmjs.com/package/@pepperize/cdk-dynamodb-backup)
[](https://pypi.org/project/pepperize.cdk-dynamodb-backup/)
[](https://www.nuget.org/packages/Pepperize.CDK.DynamodbBackup/)
[](https://s01.oss.sonatype.org/content/repositories/releases/com/pepperize/cdk-dynamodb-backup/)
[](https://github.com/pepperize/cdk-dynamodb-backup/actions/workflows/release.yml)
[](https://github.com/pepperize/cdk-dynamodb-backup/releases)
[](https://gitpod.io/#https://github.com/pepperize/cdk-dynamodb-backup)
# CDK DynamoDB Backup & Restore
Backup and restore AWS DynamoDB Table with AWS Data Pipeline.
## Install
### TypeScript
```shell
npm install @pepperize/cdk-dynamodb-backup
```
or
```shell
yarn add @pepperize/cdk-dynamodb-backup
```
### Python
```shell
pip install pepperize.cdk-dynamodb-backup
```
### C\# / .Net
```
dotnet add package Pepperize.CDK.DynamodbBackup
```
### Java
```xml
com.pepperize
cdk-dynamodb-backup
${cdkDynamodbBackup.version}
```
## Usage
See [API.md](https://github.com/pepperize/cdk-dynamodb-backup/blob/main/API.md).
### Backup
Export data from AWS DynamoDB to AWS S3
```typescript
const table = new aws_dynamodb.Table(stack, "Table", {
partitionKey: { name: "id", type: dynamodb.AttributeType.STRING },
});
const bucket = new aws_s3.Bucket(stack, "Bucket", {});
// When
new DataPipelineBackup(stack, "Account", {
table: table,
backupBucket: bucket,
});
```
See [Exporting Data From DynamoDB to Amazon S3](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBPipeline.html#DataPipelineExportImport.Exporting)
### Restore
Import data from AWS S3 into AWS DynamoDB
```typescript
const table = new aws_dynamodb.Table(stack, "Table", {
partitionKey: { name: "id", type: dynamodb.AttributeType.STRING },
});
const bucket = new aws_s3.Bucket(stack, "Bucket", {});
// When
new DataPipelineRestore(stack, "Restore", {
table: table,
restoreBucket: bucket,
restoreFolder: "/prefix/to/folder/with/manifest",
});
```
See [Importing Data From Amazon S3 to DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBPipeline.html#DataPipelineExportImport.Importing)
# API Reference
## Constructs
### DataPipelineBackup
- *Implements:* aws-cdk-lib.ITaggable
#### Initializers
```typescript
import { DataPipelineBackup } from '@pepperize/cdk-dynamodb-backup'
new DataPipelineBackup(scope: Construct, id: string, props: DataPipelineBackupProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | DataPipelineBackupProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* DataPipelineBackupProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { DataPipelineBackup } from '@pepperize/cdk-dynamodb-backup'
DataPipelineBackup.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| instanceProfile | aws-cdk-lib.aws_iam.CfnInstanceProfile | The instance profile of the emr cluster resources. |
| resourceRole | aws-cdk-lib.aws_iam.IRole | The role used by the emr cluster resources. |
| role | aws-cdk-lib.aws_iam.IRole | The role used by datapipelines service. |
| tags | aws-cdk-lib.TagManager | TagManager to set, remove and format tags. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `instanceProfile`Required
```typescript
public readonly instanceProfile: CfnInstanceProfile;
```
- *Type:* aws-cdk-lib.aws_iam.CfnInstanceProfile
The instance profile of the emr cluster resources.
---
##### `resourceRole`Required
```typescript
public readonly resourceRole: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
The role used by the emr cluster resources.
---
##### `role`Required
```typescript
public readonly role: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
The role used by datapipelines service.
---
##### `tags`Required
```typescript
public readonly tags: TagManager;
```
- *Type:* aws-cdk-lib.TagManager
TagManager to set, remove and format tags.
---
### DataPipelineRestore
- *Implements:* aws-cdk-lib.ITaggable
#### Initializers
```typescript
import { DataPipelineRestore } from '@pepperize/cdk-dynamodb-backup'
new DataPipelineRestore(scope: Construct, id: string, props: DataPipelineRestoreProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | DataPipelineRestoreProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* DataPipelineRestoreProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { DataPipelineRestore } from '@pepperize/cdk-dynamodb-backup'
DataPipelineRestore.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| instanceProfile | aws-cdk-lib.aws_iam.CfnInstanceProfile | The instance profile of the emr cluster resources. |
| resourceRole | aws-cdk-lib.aws_iam.IRole | The role used by the emr cluster resources. |
| role | aws-cdk-lib.aws_iam.IRole | The role used by datapipelines service. |
| tags | aws-cdk-lib.TagManager | TagManager to set, remove and format tags. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `instanceProfile`Required
```typescript
public readonly instanceProfile: CfnInstanceProfile;
```
- *Type:* aws-cdk-lib.aws_iam.CfnInstanceProfile
The instance profile of the emr cluster resources.
---
##### `resourceRole`Required
```typescript
public readonly resourceRole: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
The role used by the emr cluster resources.
---
##### `role`Required
```typescript
public readonly role: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
The role used by datapipelines service.
---
##### `tags`Required
```typescript
public readonly tags: TagManager;
```
- *Type:* aws-cdk-lib.TagManager
TagManager to set, remove and format tags.
---
## Structs
### DataPipelineBackupOptions
#### Initializer
```typescript
import { DataPipelineBackupOptions } from '@pepperize/cdk-dynamodb-backup'
const dataPipelineBackupOptions: DataPipelineBackupOptions = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| dynamoDbThroughputRatio | number | *No description.* |
| logsBucket | aws-cdk-lib.aws_s3.IBucket | *No description.* |
| pipelineName | string | *No description.* |
| schedule | aws-cdk-lib.Duration | *No description.* |
---
##### `dynamoDbThroughputRatio`Optional
```typescript
public readonly dynamoDbThroughputRatio: number;
```
- *Type:* number
---
##### `logsBucket`Optional
```typescript
public readonly logsBucket: IBucket;
```
- *Type:* aws-cdk-lib.aws_s3.IBucket
---
##### `pipelineName`Optional
```typescript
public readonly pipelineName: string;
```
- *Type:* string
---
##### `schedule`Optional
```typescript
public readonly schedule: Duration;
```
- *Type:* aws-cdk-lib.Duration
---
### DataPipelineBackupProps
#### Initializer
```typescript
import { DataPipelineBackupProps } from '@pepperize/cdk-dynamodb-backup'
const dataPipelineBackupProps: DataPipelineBackupProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| dynamoDbThroughputRatio | number | *No description.* |
| logsBucket | aws-cdk-lib.aws_s3.IBucket | *No description.* |
| pipelineName | string | *No description.* |
| schedule | aws-cdk-lib.Duration | *No description.* |
| backupBucket | aws-cdk-lib.aws_s3.IBucket | *No description.* |
| table | aws-cdk-lib.aws_dynamodb.ITable | *No description.* |
---
##### `dynamoDbThroughputRatio`Optional
```typescript
public readonly dynamoDbThroughputRatio: number;
```
- *Type:* number
---
##### `logsBucket`Optional
```typescript
public readonly logsBucket: IBucket;
```
- *Type:* aws-cdk-lib.aws_s3.IBucket
---
##### `pipelineName`Optional
```typescript
public readonly pipelineName: string;
```
- *Type:* string
---
##### `schedule`Optional
```typescript
public readonly schedule: Duration;
```
- *Type:* aws-cdk-lib.Duration
---
##### `backupBucket`Required
```typescript
public readonly backupBucket: IBucket;
```
- *Type:* aws-cdk-lib.aws_s3.IBucket
---
##### `table`Required
```typescript
public readonly table: ITable;
```
- *Type:* aws-cdk-lib.aws_dynamodb.ITable
---
### DataPipelineRestoreOptions
#### Initializer
```typescript
import { DataPipelineRestoreOptions } from '@pepperize/cdk-dynamodb-backup'
const dataPipelineRestoreOptions: DataPipelineRestoreOptions = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| dynamoDbThroughputRatio | number | *No description.* |
| logsBucket | aws-cdk-lib.aws_s3.IBucket | *No description.* |
| pipelineName | string | *No description.* |
---
##### `dynamoDbThroughputRatio`Optional
```typescript
public readonly dynamoDbThroughputRatio: number;
```
- *Type:* number
---
##### `logsBucket`Optional
```typescript
public readonly logsBucket: IBucket;
```
- *Type:* aws-cdk-lib.aws_s3.IBucket
---
##### `pipelineName`Optional
```typescript
public readonly pipelineName: string;
```
- *Type:* string
---
### DataPipelineRestoreProps
#### Initializer
```typescript
import { DataPipelineRestoreProps } from '@pepperize/cdk-dynamodb-backup'
const dataPipelineRestoreProps: DataPipelineRestoreProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| dynamoDbThroughputRatio | number | *No description.* |
| logsBucket | aws-cdk-lib.aws_s3.IBucket | *No description.* |
| pipelineName | string | *No description.* |
| restoreBucket | aws-cdk-lib.aws_s3.IBucket | *No description.* |
| restoreFolder | string | *No description.* |
| table | aws-cdk-lib.aws_dynamodb.ITable | *No description.* |
---
##### `dynamoDbThroughputRatio`Optional
```typescript
public readonly dynamoDbThroughputRatio: number;
```
- *Type:* number
---
##### `logsBucket`Optional
```typescript
public readonly logsBucket: IBucket;
```
- *Type:* aws-cdk-lib.aws_s3.IBucket
---
##### `pipelineName`Optional
```typescript
public readonly pipelineName: string;
```
- *Type:* string
---
##### `restoreBucket`Required
```typescript
public readonly restoreBucket: IBucket;
```
- *Type:* aws-cdk-lib.aws_s3.IBucket
---
##### `restoreFolder`Required
```typescript
public readonly restoreFolder: string;
```
- *Type:* string
---
##### `table`Required
```typescript
public readonly table: ITable;
```
- *Type:* aws-cdk-lib.aws_dynamodb.ITable
---