Amazon S3 デプロイアクションリファレンス

Amazon S3 デプロイアクションを使用して、静的ウェブサイトのホスティングやアーカイブ用に Amazon S3 バケットにファイルをデプロイします。バケットにアップロードする前にデプロイファイルを抽出するかどうかを指定できます。

注記

このリファレンストピックでは、デプロイプラットフォーム CodePipeline がホスト用に設定された Amazon S3 バケットである の Amazon S3 デプロイアクションについて説明します。での Amazon S3 ソースアクションのリファレンス情報については CodePipeline、「」を参照してくださいAmazon S3 ソースアクションリファレンス。

アクションタイプ

• カテゴリ:Deploy

• 所有者: AWS

• プロバイダー: S3

• バージョン: 1

設定パラメータ

BucketName

必須：はい

ファイルがデプロイされる Amazon S3 バケットの名前。

Extract

必須：はい

true を指定すると、アップロード前にファイルが抽出されるようになります。指定しないと、ホストされている静的ウェブサイトの場合など、アプリケーションファイルはアップロード時に圧縮されたままになります。false を指定した場合は、ObjectKey が必要になります。

ObjectKey

条件付き。Extract = false の場合は必須

S3 バケット内のオブジェクトを一意に識別する Amazon S3 オブジェクトキーの名前。

KMSEncryptionKeyARN

必須：いいえ

ホストバケットの AWS KMS 暗号化キーARNの 。KMSEncryptionKeyARN パラメータは、提供された AWS KMS keyを使用してアップロードされたアーティファクトを暗号化します。KMS キーには、キー ID、キー ARN、またはエイリアス を使用できますARN。

注記

エイリアスは、KMSキーを作成したアカウントでのみ認識されます。クロスアカウントアクションでは、キー ID またはキーのみを使用してキーARNを識別できます。クロスアカウントアクションには他のアカウント (AccountB) のロールを使用するため、キー ID を指定すると他のアカウント (AccountB) のキーが使用されます。

重要

CodePipeline は対称KMSキーのみをサポートします。非対称KMSキーを使用して S3 バケット内のデータを暗号化しないでください。

固定ACL

必須：いいえ

CannedACL パラメータは、Amazon S3 にデプロイされたオブジェクトに指定された固定ACLを適用します。これにより、オブジェクトに適用ACLされた既存のすべてが上書きされます。

CacheControl

必須：いいえ

CacheControl パラメータは、バケットのオブジェクトのリクエストやレスポンスのキャッシュ動作を制御します。有効な値のリストについては、 HTTPオペレーションのCache-Controlヘッダーフィールドを参照してください。CacheControl に複数の値を入力するには、各値の間にカンマを使用します。次の例に示すように、各カンマ (オプション) の後にスペースを追加できますCLI。

"CacheControl": "public, max-age=0, no-transform"

入力アーティファクト

• アーティファクトの数: 1

• 説明： デプロイまたはアーカイブ用のファイルは、ソースリポジトリから取得され、圧縮され、 によってアップロードされます CodePipeline。

出力アーティファクト

• アーティファクトの数: 0

• 説明: 出力アーティファクトは、このアクションタイプには適用されません。

アクション設定の例

次に、アクションの設定例を示します。

Extract を false に設定する場合のアクションの設定例

以下の例で示しているのは、Extract フィールドを false に設定してアクションを作成した場合のアクションのデフォルト設定です。

YAML

Name: Deploy
Actions:
  - Name: Deploy
    ActionTypeId:
      Category: Deploy
      Owner: AWS
      Provider: S3
      Version: '1'
    RunOrder: 1
    Configuration:
      BucketName: website-bucket
      Extract: 'false'
    OutputArtifacts: []
    InputArtifacts:
      - Name: SourceArtifact
    Region: us-west-2
    Namespace: DeployVariables

JSON

{
    "Name": "Deploy",
    "Actions": [
        {
            "Name": "Deploy",
            "ActionTypeId": {
                "Category": "Deploy",
                "Owner": "AWS",
                "Provider": "S3",
                "Version": "1"
            },
            "RunOrder": 1,
            "Configuration": {
                "BucketName": "website-bucket",
                "Extract": "false"
                },
            "OutputArtifacts": [],
            "InputArtifacts": [
                {
                    "Name": "SourceArtifact"
                }
            ],
            "Region": "us-west-2",
            "Namespace": "DeployVariables"
        }
    ]
},

Extract を true に設定する場合のアクションの設定例

以下の例で示しているのは、Extract フィールドを true に設定してアクションを作成した場合のアクションのデフォルト設定です。

YAML

Name: Deploy
Actions:
  - Name: Deploy
    ActionTypeId:
      Category: Deploy
      Owner: AWS
      Provider: S3
      Version: '1'
    RunOrder: 1
    Configuration:
      BucketName: website-bucket
      Extract: 'true'
      ObjectKey: MyWebsite
    OutputArtifacts: []
    InputArtifacts:
      - Name: SourceArtifact
    Region: us-west-2
    Namespace: DeployVariables

JSON

{
    "Name": "Deploy",
    "Actions": [
        {
            "Name": "Deploy",
            "ActionTypeId": {
                "Category": "Deploy",
                "Owner": "AWS",
                "Provider": "S3",
                "Version": "1"
            },
            "RunOrder": 1,
            "Configuration": {
                "BucketName": "website-bucket",
                "Extract": "true",
                "ObjectKey": "MyWebsite"
                },
            "OutputArtifacts": [],
            "InputArtifacts": [
                {
                    "Name": "SourceArtifact"
                }
            ],
            "Region": "us-west-2",
            "Namespace": "DeployVariables"
        }
    ]
},

以下も参照してください。

このアクションを利用する際に役立つ関連リソースは以下の通りです。

• チュートリアル: Amazon S3 をデプロイプロバイダとして使用するパイプラインを作成する - このチュートリアルでは、S3 デプロイアクションを使用してパイプラインを作成する 2 つの例を紹介します。サンプルファイルのダウンロード、 CodeCommit リポジトリへのファイルのアップロード、S3 バケットの作成、バケットのホスティングの設定を行います。次に、 CodePipeline コンソールを使用してパイプラインを作成し、Amazon S3 デプロイ設定を指定します。

• Amazon S3 ソースアクションリファレンス – このアクションリファレンスは、 の Amazon S3 ソースアクションのリファレンス情報と例を提供します CodePipeline。