Registry / storage / amplify-category-storage

amplify-category-storage

library2.13.0jsnpmunverified

Amplify CLI plugin for adding cloud storage (S3, DynamoDB) and managing access policies. Current stable version is 2.13.0. Released as part of the Amplify CLI ecosystem. Key differentiator: integrates with Amplify's auth and API categories for seamless full-stack development. Does not support non-AWS storage backends. Maintenance status is legacy; newer projects should use the modular `aws-amplify` and `@aws-amplify/storage` packages.

storage devops

npm install amplify-category-storage

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AMPLIFY-CATEGORY-S

amplify-category-storage

storagejavascriptv2.13.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

amplify push storage

✓ amplify push storage

✗ amplify storage push

CLI command is 'amplify push storage', not 'amplify storage push'.

add storage

✓ amplify add storage

✗ amplify storage add

Use 'amplify add storage' to create storage resources.

update storage

✓ amplify update storage

✗ amplify storage update

Command order: 'amplify update storage'.

Add and deploy S3 storage with authentication using Amplify CLI.

amplify init # Select or create an AWS profile amplify add storage ? Please select from one of the below mentioned services: Content (Images, audio, video, etc.) ? You need to add auth (Amazon Cognito) to use this feature. Do you want to add auth now? Yes ? Do you want to use the default authentication and security configuration? Default configuration ? How do you want users to be able to sign in? Username ? Do you want to configure advanced settings? No, I am done. ? Please provide a friendly name for your resource that will be used to label this category in the project: myStorage ? Please provide bucket name: mybucket123 ? Who should have access: Auth users only ? What kind of access do you want for Authenticated users? create/update, read, delete ? Do you want to add a Lambda Trigger for your S3 Bucket? No amplify push storage

Debug

Known issues

deprecatedThis package is deprecated. Use @aws-amplify/storage with AWS Amplify Gen 2 or higher.

fix

Migrate to AWS Amplify Gen 2: remove this plugin and add @aws-amplify/storage via npm.

affects: >=2.0.0

gotchaStorage resources cannot be renamed after creation. Deleting and recreating will lose data.

fix

Plan bucket names carefully before deployment.

affects: all

breakingIn Amplify CLI 5.0+, the storage category requires explicit auth category to be configured.

fix

Run 'amplify add auth' before 'amplify add storage'.

affects: >=5.0.0

gotchaS3 bucket names must be globally unique across all AWS accounts.

fix

Use a name that includes a project-specific prefix or use the auto-generated name.

affects: all

breakingThe storage category plugin is not compatible with Yarn 2+ (PnP).

fix

Use npm or Yarn Classic (v1).

affects: >=2.0.0

Errors

Common errors & fixes

Resource is not in the state file

Amplify CLI state file is missing or corrupt.

fix

Run 'amplify init' again or manually restore the amplify/team-provider-info.json and amplify/backend/amplify-meta.json files.

Bucket already exists

S3 bucket name already taken globally.

fix

Use a different bucket name.

Cannot use storage without auth

Auth category not added before storage.

fix

Run 'amplify add auth' first, then 'amplify add storage'.

amplify push storage fails with 'AccessDenied'

Insufficient AWS IAM permissions for CloudFormation.

fix

Ensure your AWS profile has CloudFormation, S3, and Cognito permissions.

Upgrade

Version history

2.13.0latest on npm

Audit

Dependencies

amplify-clirequiredRuntime dependency: plugin for the Amplify CLI framework.

Agent activity

35 hits · last 30 days

node

Resources

githubhttps://github.com/aws-amplify/amplify-cli ↗

packageamplify-category-storage ↗

homepagehttps://github.com/aws-amplify/amplify-cli#readme ↗