Amazon S3 ソースアクション - AWS CodePipeline

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon S3 ソースアクション

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

注記

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

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

注記

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

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

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

注記

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

アクションタイプ

  • カテゴリ:Source

  • 所有者: AWS

  • プロバイダー: S3

  • バージョン: 1

設定パラメータ

S3 バケット

必須: はい

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

S3ObjectKey

必須: はい

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

AllowOverrideForS3ObjectKey

必須: いいえ

AllowOverrideForS3ObjectKey は、 からのソースオーバーライドが、ソースアクションS3ObjectKeyで既に設定されている をオーバーライドStartPipelineExecutionできるかどうかを制御します。S3 オブジェクトキーによるソースオーバーライドの詳細については、「」を参照してくださいソースリビジョンオーバーライドでパイプラインを開始する

重要

を省略するとAllowOverrideForS3ObjectKey、 は、このパラメータを に設定して、ソースアクションの S3 ObjectKey を上書きする機能を CodePipeline デフォルトにしますfalse

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

  • true: 設定されている場合、パイプラインの実行中に、事前設定された S3 オブジェクトキーをソースリビジョンの上書きで上書きできます。

    注記

    新しいパイプラインの実行を開始するときに、すべての CodePipeline ユーザーが事前設定された S3 オブジェクトキーを上書きできるようにする場合は、 AllowOverrideForS3ObjectKeyを に設定する必要がありますtrue

  • false:

    設定されている場合、ソースリビジョンオーバーライドを使用して S3 オブジェクトキーを上書き CodePipeline することはできません。これは、このパラメータのデフォルト値でもあります。

PollForSourceChanges

必須: いいえ

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

重要

Events を設定する場合は CloudWatch 、パイプラインの実行が重複しないように false PollForSourceChangesを に設定する必要があります。

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

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

    注記

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

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

入力アーティファクト

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

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

出力アーティファクト

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

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

出力変数

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

の変数の詳細については、 CodePipeline「」を参照してください変数

BucketName

パイプラインをトリガーしたソース変更に関連する Amazon S3 バケットの名前。

ETag

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

ObjectKey

パイプラインをトリガーしたソース変更に関連する Amazon S3 オブジェクトキーの名前。

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 ソースを持つパイプラインを作成します。