# BackupProps

Backup configuration for DocumentDB databases.

- Source: [`aws-docdb/lib/props.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-docdb/lib/props.ts#L13)

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_docdb as docdb } from 'aws-cdk-lib';
const backupProps: docdb.BackupProps = {
  retention: cdk.Duration.minutes(30),

  // the properties below are optional
  preferredWindow: 'preferredWindow',
};
```

## Properties

- `preferredWindow`: string — A daily time range in 24-hours UTC format in which backups preferably execute.

  **Default:** a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshots.html#backup-restore.backup-window

  Must be at least 30 minutes long.

  Example: '01:00-02:00'

- `retention`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) (required) — How many days to retain the backup.