Skip to content

Hdworld/storage with existing s3 #7602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 17, 2024
Merged
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/directory/directory.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,9 @@ export const directory = {
{
path: 'src/pages/[platform]/build-a-backend/storage/use-aws-sdk/index.mdx'
},
{
path: 'src/pages/[platform]/build-a-backend/storage/use-with-custom-s3/index.mdx'
},
{
path: 'src/pages/[platform]/build-a-backend/storage/data-usage/index.mdx'
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
import { getCustomStaticPath } from '@/utils/getCustomStaticPath';

export const meta = {
title: 'Use Amplify Storage with any S3 bucket',
description: 'You can use the Amplify Storage APIs against your own S3 bucket in your account.',
platforms: [
'javascript',
'react',
'react-native',
'angular',
'vue',
'nextjs',
'swift',
'android',
'flutter'
]
};

export const getStaticPaths = async () => {
return getCustomStaticPath(meta.platforms);
};

export function getStaticProps(context) {
return {
props: {
platform: context.params.platform,
meta
}
};
}

With Amplify Storage APIs, you can use your own S3 buckets instead of the Amplify-created ones.

<Callout>

**Important:** To utilize the storage APIs with an S3 bucket outside of Amplify, you must have Amplify Auth configured in your project.

</Callout>

## Step 1 - Add necessary permissions to the S3 bucket

For the specific Amazon S3 bucket that you want to use with these APIs, you need to make sure that the associated IAM role has the necessary permissions to read and write data to that bucket.

To do this, go to **Amazon S3 console** > **Select the S3 bucket** > **Permissions** > **Edit** Bucket Policy.

![Showing Amplify console showing Storage tab selected](/images/gen2/storage/s3-console-permissions.png)

The policy will look something like this

```json
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "Statement1",
"Principal": { "AWS": "arn:aws:iam::<AWS-account-ID>:role/<role-name>" },
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:GetObject",
"s3:DeleteObject",
"s3:ListBucket"
],
"Resource": [
"arn:aws:s3:::<bucket-name>/*"
]
}
]
}
```
Replace `<AWS-account-ID>` with your AWS account ID and `<role-name>` with the IAM role associated with your Amplify Auth setup. Replace `<bucket-name>` with the S3 bucket name.

You can refer to [Amazon S3's Policies and Permissions documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html) for more ways to customize access to the bucket.

## Step 2 - Specify S3 bucket in Amplify's backend config

Next, use the `addOutput` method from the backend definition object to define a custom s3 bucket by specifying the name and region of the bucket in your **amplify/backend.ts** file.

<Callout>

**Important**

You cannot use both a storage backend configured through Amplify and a custom S3 bucket at the same time.

If you specify a custom S3 bucket, no sandbox storage resource will be created. The provided custom S3 bucket will be used, even in the sandbox environment.

</Callout>

```javascript

import { defineBackend } from '@aws-amplify/backend';
import { auth } from './auth/resource';
import { data } from './data/resource';

const backend = defineBackend({
auth,
data,
});

//highlight-start
backend.addOutput({
storage: {
aws_region: "<region>",
bucket_name: "<bucket-name>"
},
});
//highlight-end

```

<InlineFilter filters={["javascript", "nextjs", "react", "angular", "vue", "react-native", "android", "swift"]}>

## Step 3 - Import latest amplify_outputs.json file

To ensure the local **amplify_outputs.json** file is up-to-date, you can run [the npx ampx generate outputs command](/[platform]/reference/cli-commands/#npx-ampx-generate-outputs) or download the latest **amplify_outputs.json** from the Amplify console as shown below.

![outputs](/images/gen2/getting-started/react/amplify-outputs-download.png)

</InlineFilter>

<InlineFilter filters={["flutter"]}>

## Step 3 - Import latest amplifyconfiguration.dart file

To ensure the local **amplifyconfiguration.dart** file is up-to-date, you can run [the npx ampx generate outputs command](/[platform]/reference/cli-commands/#npx-ampx-generate-outputs).

</InlineFilter>

Now that you've configured the necessary permissions, you can start using the storage APIs with your chosen S3 bucket.
Loading