最終更新日 2020年05月27日(水)

Amazon Simple Storage Service​ (S3) は、メディアファイル、静的アセット、ユーザーアップロードなどのアプリケーションコンテンツを格納するのに理想的な “耐久性と可用性に優れたストア” です。

S3 によって、静的ファイルのストレージをアプリからオフロードできます。アプリの dyno には一時的なファイルシステム​があるため、このことは Heroku で特に重要です。これは、(少なくとも 1 日に 1 回) dyno が再起動またはリプレースされるたびに、アプリケーションの slug に含まれないすべてのファイルが失われる​ことを意味します。

概要

S3 では、すべてのファイルはバケット​に保存されます。バケットは、ディレクトリのようにトップレベルのコンテナとして機能します。S3 に送信されるすべてのファイルはバケットに属し、バケットの名前はすべての S3 間で一意である必要があります。

S3 API へのアクセスは、アクセスキー ID​ とシークレットアクセスキー​によって管理されます。アクセスキーは S3 ユーザーアカウントを識別します。秘密鍵はパスワードのような資格情報であり、安全に保管する必要があります。

S3 の設定

アプリケーションで S3 を使用するためには、AWS の資格情報と、ファイルを格納するバケットの名前にアプリケーションがアクセスできる必要があります。

資格情報

S3 の資格情報は、AWS の My Account/Console メニュー​の [Security Credentials]​ (セキュリティ資格情報) セクションで確認できます。

S3 の資格情報は機密性が高いため、決してバージョン管理にコミットしないでください。​代わりに、資格情報を使用する Heroku アプリの環境設定​の値として資格情報を設定します。

heroku config:set​ を使用して両方のキーを設定します。

$ heroku config:set AWS_ACCESS_KEY_ID=xxx AWS_SECRET_ACCESS_KEY=yyy
Adding config vars and restarting app... done, v21
  AWS_ACCESS_KEY_ID     => xxx
  AWS_SECRET_ACCESS_KEY => yyy

バケット

通常、アプリケーションのファイル、アセット、アップロードが 1 つのバケットに格納されます。バケットを作成するには、AWS マネジメントコンソールの S3 セクション​にアクセスし、米国スタンダードリージョンに新しいバケットを作成します。

バケット名の選択はおおむね自由ですが、最大の相互運用性を確保できるよう、名前の選択には注意してください​。

バケット名を環境設定に保存して、アプリケーションがその値にアクセスできるようにします。

$ heroku config:set S3_BUCKET_NAME=appname-assets
Adding config vars and restarting app... done, v22
  S3_BUCKET_NAME     => appname-assets

バケットの命名

S3 バケットの名前により、暗号化などの基本的な機能を含め、使用できる AWS の機能が意図しない影響を受ける可能性があります。最大の互換性を確保するために、理想的なバケット名は次のとおりです。

• 32 文字以下
• 大文字 (A​ ～ Z​) を含まない
• ピリオド (.​) を含まない
• アンダースコア (_​) を含まない
• 先頭または末尾の文字​にハイフン (-​) を使用しない

これらの命名規則が重要である理由は次のとおりです。

• SSL または TLS の使用時に、ピリオド (.​) 文字が証明書エラーの原因になります。
• 大文字、アンダースコア (_​)、先頭/末尾のハイフン (-​) は、S3 で推奨される “仮想ホスト” API 形式の使用を無効にします。また、これらは一部の S3 リージョンと互換性がありません。
• バケット名の長さが 32 文字を超えると、 柔軟で一時的な資格情報を提供する AWS STS ポリシーが使用できなくなります。

静的アセット

ビデオ、PDF、JavaScript、CSS、画像ファイルなどの静的アセットは、コマンドライン​や Amazon S3 コンソール​などのグラフィカルブラウザを使用して手動で S3 アカウントにアップロードできます。

アセットがアップロードされた後、アプリケーションのコードでアセットの (http://s3.amazonaws.com/bucketname/filename​ のような) パブリック URL を参照できます。これらのファイルは S3 から直接供給されるようになり、アプリケーションは動的なリクエストの処理に専念できるようになります。

ファイルアップロード

Heroku アプリから S3 へのファイルアップロードを処理および保存する方法には、直接とパススルーの 2 つがあります。

直接アップロード

直接アップロードでは、アプリを最初に経由せずに​、ユーザーのブラウザから S3 バケットにファイルがアップロードされます。サイズが 4 MB を超える可能性があるユーザーアップロードには、この方法が推奨されます。

この方法では、アプリケーションで実行する必要がある処理の量は減りますが、実装が複雑になる可能性があります。また、S3 に保存する前に実行できるファイル変更 (変換、フィルター、サイズ変更など) も制限されます。

以下の記事​のほとんどでは、直接アップロードを実行する方法を示しています。

パススルーアップロード

パススルーアップロードでは、ファイルがアプリにアップロードされた後、アプリがファイルを S3 にアップロードします。この方法では、S3 にプッシュする前のユーザーアップロードに対して前処理を実行できます。ただし、選択した言語とフレームワークによっては、この方法を使用すると、アップロードの処理中に開始される他のリクエストでレイテンシーの問題が発生する可能性があります。

言語固有のガイド

S3 へのアップロードを処理するための言語固有のガイドは以下のとおりです。