copySnapshot method

Future<CopySnapshotResult> copySnapshot({ required String sourceSnapshotName, required String targetSnapshotName, String? kmsKeyId, String? targetBucket, })

Makes a copy of an existing snapshot. You could receive the following error messages.

Error Messages

• Error Message: The S3 bucket %s is outside of the region.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: The S3 bucket %s does not exist.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: The S3 bucket %s is not owned by the authenticated user.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

  Solution: Contact your system administrator to get the needed permissions.

• Error Message: The S3 bucket %s already contains an object with key %s.

  Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

  Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

  Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

  Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

May throw SnapshotAlreadyExistsFault. May throw SnapshotNotFoundFault. May throw SnapshotQuotaExceededFault. May throw InvalidSnapshotStateFault. May throw InvalidParameterValueException. May throw InvalidParameterCombinationException.

Parameter sourceSnapshotName : The name of an existing snapshot from which to make a copy.

Parameter targetSnapshotName : A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Parameter kmsKeyId : The ID of the KMS key used to encrypt the target snapshot.

Parameter targetBucket : The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Implementation

Future<CopySnapshotResult> copySnapshot({
  required String sourceSnapshotName,
  required String targetSnapshotName,
  String? kmsKeyId,
  String? targetBucket,
}) async {
  ArgumentError.checkNotNull(sourceSnapshotName, 'sourceSnapshotName');
  ArgumentError.checkNotNull(targetSnapshotName, 'targetSnapshotName');
  final $request = <String, dynamic>{};
  $request['SourceSnapshotName'] = sourceSnapshotName;
  $request['TargetSnapshotName'] = targetSnapshotName;
  kmsKeyId?.also((arg) => $request['KmsKeyId'] = arg);
  targetBucket?.also((arg) => $request['TargetBucket'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'CopySnapshot',
    version: '2015-02-02',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CopySnapshotMessage'],
    shapes: shapes,
    resultWrapper: 'CopySnapshotResult',
  );
  return CopySnapshotResult.fromXml($result);
}