createBackup method

Future<CreateBackupOutput> createBackup({
  1. required String backupName,
  2. required String tableName,
})

Creates a backup for an existing table.

Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

You can call CreateBackup at a maximum rate of 50 times per second.

All backups in DynamoDB work without consuming any provisioned throughput on the table.

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

Along with data, the following are also included on the backups:

  • Global secondary indexes (GSIs)
  • Local secondary indexes (LSIs)
  • Streams
  • Provisioned read and write capacity

May throw TableNotFoundException. May throw TableInUseException. May throw ContinuousBackupsUnavailableException. May throw BackupInUseException. May throw LimitExceededException. May throw InternalServerError.

Parameter backupName : Specified name for the backup.

Parameter tableName : The name of the table.

Implementation

Future<CreateBackupOutput> createBackup({
  required String backupName,
  required String tableName,
}) async {
  ArgumentError.checkNotNull(backupName, 'backupName');
  _s.validateStringLength(
    'backupName',
    backupName,
    3,
    255,
    isRequired: true,
  );
  ArgumentError.checkNotNull(tableName, 'tableName');
  _s.validateStringLength(
    'tableName',
    tableName,
    3,
    255,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'DynamoDB_20120810.CreateBackup'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'BackupName': backupName,
      'TableName': tableName,
    },
  );

  return CreateBackupOutput.fromJson(jsonResponse.body);
}