Amazon S3 ソースアクション

新しいオブジェクトが、設定されたバケットとオブジェクトキーにアップロードされたときに、パイプラインをトリガーします。

注記

このリファレンスのトピックでは、の Amazon S3 ソースアクションについて説明します。 CodePipeline ソースの場所は、バージョニング用に設定された Amazon S3 バケットです。CodePipeline での Amazon S3 デプロイアクションの詳細については、「」を参照してください。Amazon S3 デプロイアクション。

Amazon S3 バケットを作成して、アプリケーションファイルのソースの場所として使用できます。

注記

ソースバケットを作成するときは、バケットでバージョニングを有効にしてください。既存の Amazon S3 バケットを使用する場合は、「バージョニングの使用」を参照して、既存のバケットでバージョニングを有効にします。

コンソールを使用してパイプラインを作成または編集する場合は、 CodePipeline を作成します。 CloudWatch S3 ソースバケットで変更が発生したときにパイプラインを開始するイベントルール。

Amazon S3 アクションを使用してパイプラインを接続する前に、Amazon S3 ソースバケットを作成し、ソースファイルを 1 つの ZIP ファイルとしてアップロードしておく必要があります。

注記

Amazon S3 がパイプラインのソースプロバイダーである場合、ソースファイルを 1 つの .zip に圧縮し、その .zip をソースバケットにアップロードできます。解凍されたファイルを 1 つアップロードすることもできます。ただし、.zip ファイルを想定するダウンストリームアクションは失敗します。

アクションタイプ

• カテゴリ:Source

• 所有者: AWS

• プロバイダー: S3

• バージョン: 1

設定パラメータ

S3 バケット

: 必須 はい

ソースの変更が検出される Amazon S3 バケットの名前。

S3ObjectKey

: 必須 はい

ソースの変更が検出される Amazon S3 オブジェクトキーの名前。

PollForSourceChanges

: 必須 いいえ

PollForSourceChanges制御するかどうか CodePipeline Amazon S3 ソースバケットでソースの変更についてポーリングします。を使用することをお勧めします。 CloudWatch 代わりにイベントと CloudTrail を使用してソースの変更を検出します。の設定の詳細については CloudWatch イベント、「」を参照プッシュイベント用にパイプラインを更新する (Amazon S3 ソース) (CLI)またはプッシュイベント用にパイプラインを更新する ( Amazon S3 ソース) (AWS CloudFormation テンプレート)。

重要

設定する予定の場合 CloudWatch イベント、設定する必要がありますPollForSourceChangesにfalseパイプラインが重複して実行されないようにする。

このパラメータの有効な値:

• true: 設定されている場合、 CodePipeline は、ソースの変更についてソースの場所をポーリングします。

  注記

  省略するとPollForSourceChanges, CodePipeline は、ソースの変更についてデフォルトでソースの場所をポーリングします。この動作は、PollForSourceChanges が含まれており、true に設定されている場合と同じです。

• false: 設定されている場合、 CodePipeline は、ソースの変更についてソースの場所をポーリングしません。を設定する場合は、この設定を使用します。 CloudWatch イベントルールは、ソースの変更を検出します。

入力アーティファクト

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

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

出力アーティファクト

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

• 説明: パイプラインに接続するように設定されたソースバケットで使用可能なアーティファクトを提供します。バケットから生成されたアーティファクトは、Amazon S3 アクションの出力アーティファクトです。Amazon S3 オブジェクトメタデータ (ETag とバージョン ID) が、 CodePipeline トリガーされたパイプライン実行のソースリビジョンとして。

出力変数

このアクションを設定すると、パイプライン内のダウンストリームアクションのアクション設定によって参照できる変数が生成されます。このアクションは、アクションに名前空間がない場合でも、出力変数として表示できる変数を生成します。名前空間を使用してアクションを設定し、これらの変数をダウンストリームアクションの設定で使用できるようにします。

CodePipeline における変数の詳細については、変数 を参照してください。

ETag

パイプラインをトリガーしたソース変更に関連するオブジェクトのエンティティタグ。ETag は、オブジェクトの MD5 ハッシュです。ETag は、オブジェクトのコンテンツに加えた変更のみを反映し、メタデータに加えた変更は反映しません。

VersionId

パイプラインをトリガーしたソース変更に関連するオブジェクトのバージョンのバージョン ID。

アクションの宣言

YAML

Name: Source
Actions:
  - RunOrder: 1
    OutputArtifacts:
      - Name: SourceArtifact
    ActionTypeId:
      Provider: S3
      Owner: AWS
      Version: '1'
      Category: Source
    Region: us-west-2
    Name: Source
    Configuration:
      S3Bucket: my-bucket-oregon
      S3ObjectKey: my-application.zip
      PollForSourceChanges: 'false'
    InputArtifacts: []

JSON

{
    "Name": "Source",
    "Actions": [
        {
            "RunOrder": 1,
            "OutputArtifacts": [
                {
                    "Name": "SourceArtifact"
                }
            ],
            "ActionTypeId": {
                "Provider": "S3",
                "Owner": "AWS",
                "Version": "1",
                "Category": "Source"
            },
            "Region": "us-west-2",
            "Name": "Source",
            "Configuration": {
                "S3Bucket": "my-bucket-oregon",
                "S3ObjectKey": "my-application.zip",
                "PollForSourceChanges": "false"
            },
            "InputArtifacts": []
        }
    ]
},

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

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

• チュートリアル: シンプルなパイプラインを作成する (S3 バケット) – このチュートリアルでは、サンプルアプリケーション仕様ファイル、サンプル CodeDeploy アプリケーションおよびデプロイグループを提供します。このチュートリアルを参照して、Amazon EC 2 インスタンスにデプロイする Amazon S3 ソースを持つパイプラインを作成します。