aws-cdk-lib.aws_rds.BackupProps

interface BackupProps

LanguageType name
.NETAmazon.CDK.AWS.RDS.BackupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#BackupProps
Javasoftware.amazon.awscdk.services.rds.BackupProps
Pythonaws_cdk.aws_rds.BackupProps
TypeScript (source)aws-cdk-lib » aws_rds » BackupProps

Backup configuration for RDS databases.

See also: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow

Example

// 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_rds as rds } from 'aws-cdk-lib';
const backupProps: rds.BackupProps = {
  retention: cdk.Duration.minutes(30),

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

Properties

NameTypeDescription
retentionDurationHow many days to retain the backup.
preferredWindow?stringA daily time range in 24-hours UTC format in which backups preferably execute.

retention

Type: Duration

How many days to retain the backup.


preferredWindow?

Type: string (optional, 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/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)

A daily time range in 24-hours UTC format in which backups preferably execute.

Must be at least 30 minutes long.

Example: '01:00-02:00'