CloudFront オブジェクト構造

cloudfront オブジェクトは、S3 に保存されたファイルの CloudFront 配信を設定します。fileStrategy または fileStrategies のいずれかのエントリで "cloudfront" を使用する場合に必須となります。

例

fileStrategies:
  avatar: 'cloudfront'
  image: 'cloudfront'
  document: 's3'
 
cloudfront:
  domain: 'https://cdn.example.com'
  distributionId: 'E1234ABCD'
  invalidateOnDelete: false
  imageSigning: 'cookies'
  cookieDomain: '.example.com'
  cookieExpiry: 1800
  urlExpiry: 3600
  storageRegion: 'us-east-2'
  includeRegionInPath: false
  requireSignedAccess: true

フィールド

Key	Type	Description	Example
domain	String	CloudFrontディストリビューションドメインまたはCNAME。必須。	domain: "https://cdn.example.com"
distributionId	String	CloudFrontディストリビューションID。`invalidateOnDelete` が true の場合に必須です。	distributionId: "E1234ABCD"
invalidateOnDelete	Boolean	S3オブジェクトの削除後にCloudFrontの無効化を作成します。デフォルト: false。	invalidateOnDelete: false
imageSigning	String	インラインメディア署名モード。オプション: `"none"`, `"cookies"`, `"url"`。`"url"` は予約済みであり、画像には実装されていません。	imageSigning: "cookies"
urlExpiry	Number	署名付きCloudFrontダウンロードURLの有効期間（秒）。デフォルト: 3600。	urlExpiry: 3600
cookieExpiry	Number	署名付きクッキーの有効期間（秒単位）。デフォルト: 1800。最大値: 604800。	cookieExpiry: 1800
cookieDomain	String	署名付きCookieの共有親ドメイン。`imageSigning` が `"cookies"` の場合に必須です。ドットで始める必要があります。	cookieDomain: ".example.com"
storageRegion	String	`includeRegionInPath` が true の場合に生成されるオブジェクトキーで使用されるオプションのリージョンラベル。	storageRegion: "us-east-2"
includeRegionInPath	Boolean	新しく生成されるオブジェクトキーにストレージリージョンを含めます。デフォルト: false。	includeRegionInPath: false
requireSignedAccess	Boolean	起動時に正常に初期化するには、署名付きCookieによるCloudFrontアクセスが必要です。デフォルト: false。	requireSignedAccess: true

検証ルール

invalidateOnDelete が true の場合、distributionId が必須です。
imageSigning が "cookies" の場合、cookieDomain が必須です。
cookieDomain はドットで始める必要があります。例: .example.com
requireSignedAccess: true には imageSigning: "cookies" が必要です。

Key	Type	Description	Example
CLOUDFRONT_KEY_PAIR_ID	String	CloudFront公開鍵ペアID。署名付きCookieおよび署名付きダウンロードに必要です。	# CLOUDFRONT_KEY_PAIR_ID=K1234567890ABC
CLOUDFRONT_PRIVATE_KEY	String	CloudFrontプライベートキーPEM。署名付きCookieおよび署名付きダウンロードに必要です。	# CLOUDFRONT_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"

デプロイに関するガイダンスについては、CloudFront with S3 を参照してください。

CloudFront オブジェクト構造

例

フィールド

検証ルール

関連する環境変数