Use transfer acceleration
You can enable Transfer Acceleration for fast and secure transfer of files over long distances between your end user device and the S3 bucket. You can override the storage resource for this configuration and then leverage the useAccelerateEndpoint
parameter to use the accelerated S3 endpoint.
Override storage resource
Start by overriding your storage resources to enable Transfer Acceleration on your S3 bucket.
$ amplify override storage✅ Successfully generated "override.ts" folder at <project>/amplify/backend/storage/accelerated-bucket✔ Do you want to edit override.ts file now? (Y/n) · yesEdit the file in your editor: <project>/amplify/backend/storage/accelerated-bucket/override.ts
In the generated override.ts
file use the following CDK snippet to enable transfer acceleration.
// amplify/backend/storage/accelerated-bucket/override.tsimport { AmplifyS3ResourceTemplate } from '@aws-amplify/cli-extensibility-helper';
export function override(resources: AmplifyS3ResourceTemplate) { resources.s3Bucket.accelerateConfiguration = { accelerationStatus: 'Enabled' }}
Next, deploy this storage resource:
amplify push
Upload files using the accelerated S3 endpoint
We switch to the accelerated S3 endpoint by using the useAccelerateEndpoint
parameter set to true
. For example the getUrl
method
const getUrlResult = await getUrl({ path: "album/2024/1.jpg", options: { useAccelerateEndpoint: true; // Whether to use accelerate endpoint. },});
The following Storage APIs support accelerated endpoint
- getUrl
- getProperties
- list
- remove
- downloadData
- uploadData