翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
AWS CodePipeline のアクション、リソース、および条件キー
AWS CodePipeline (サービスプレフィックス: codepipeline) では、IAM アクセス許可ポリシーで使用できるように、以下のサービス固有のリソースやアクション、条件コンテキストキーが用意されています。
リファレンス:
-
このサービスを設定する方法について説明します。
-
このサービスで使用可能な API オペレーションのリストを表示します。
-
IAM アクセス許可ポリシーを使用して、このサービスとそのリソースを保護する方法を学びます。
AWS CodePipeline で定義されるアクション
IAM ポリシーステートメントの Action エレメントでは、以下のアクションを指定できます。ポリシーを使用して、 AWSでオペレーションを実行するアクセス許可を付与します。ポリシーでアクションを使用する場合は、通常、同じ名前の API オペレーションまたは CLI コマンドへのアクセスを許可または拒否します。ただし、場合によっては、1 つのアクションによって複数のオペレーションへのアクセスが制御されます。あるいは、いくつかのオペレーションはいくつかの異なるアクションを必要とします。
Actions テーブルのアクセスレベル列は、アクションの分類方法 (List、Read、Permissions Management、Tagging) を示しています。このように分類することで、ポリシーで使用する際にアクションで付与するアクセスレベルを理解しやすくなります。アクセスレベルの詳細については、ポリシー概要の「アクセスレベル」を参照してください。
[アクション] テーブルの [リソースタイプ] 列は、各アクションがリソースレベルの許可をサポートしているかどうかを示します。この列に値がない場合は、ポリシーステートメントの Resource 要素で、ポリシーが適用されるすべてのリソース (「*」) を指定する必要があります。列にリソースタイプが含まれる場合、そのアクションを含むステートメントでそのタイプの ARN を指定できます。アクションで 1 つ以上のリソースが必須となっている場合、呼び出し元には、それらのリソースを伴うアクションを使用するための許可が付与されている必要があります。必須リソースは、アスタリスク (*) でテーブルに示されています。IAM ポリシーの Resource 要素でリソースアクセスを制限する場合は、必要なリソースタイプごとに ARN またはパターンを含める必要があります。一部のアクションでは、複数のリソースタイプがサポートされています。リソースタイプがオプション (必須として示されていない) の場合、オプションのリソースタイプのいずれかを使用することを選択できます。
[アクション] テーブルの [条件キー] 列には、ポリシーステートメントの Condition 要素で指定できるキーが含まれます。サービスのリソースに関連付けられている条件キーの詳細については、[リソースタイプ] テーブルの [条件キー] 列を参照してください。
Actions テーブルの Dependent actions 列には、アクションを正常に呼び出すために必要な追加のアクセス許可が表示されます。これらのアクセス許可は、アクション自体のアクセス許可に加えて必要になる場合があります。アクションが依存アクションを指定すると、それらの依存関係は、テーブルにリストされている最初のリソースだけでなく、そのアクションに定義された追加のリソースに適用される場合があります。
注記
リソース条件キーは、リソースタイプテーブルに一覧表示されています。アクションに適用されるリソースタイプへのリンクは、[アクション] テーブルの [リソースタイプ (* 必須)] 列にあります。[リソースタイプ] テーブルのリソースタイプには、[アクション] テーブルのアクションに適用されるリソース条件キーである、[条件キー] 列が含まれています。
以下の表の列の詳細については、「アクションテーブル」を参照してください。
| アクション | 説明 | アクセスレベル | リソースタイプ (* 必須) | 条件キー | 依存アクション |
|---|---|---|---|---|---|
| AcknowledgeJob | 指定されたジョブに関する情報や、そのジョブがジョブワーカーによって受け取られたかどうかについて表示する許可を付与 | 書き込み | |||
| AcknowledgeThirdPartyJob | ジョブワーカーが指定されたジョブを受け取ったことを確認する許可を付与 (パートナーアクションのみ) | 書き込み | |||
| CreateCustomActionType | に関連付けられたパイプラインで使用できるカスタムアクションを作成するアクセス許可を付与します AWS アカウント | 書き込み | |||
| CreatePipeline | 一意の名前が付けられたパイプラインを作成する許可を付与 | 書き込み | |||
| DeleteCustomActionType | カスタムアクションを削除する許可を付与 | 書き込み | |||
| DeletePipeline | 指定されたパイプラインを削除する許可を付与 | 書き込み | |||
| DeleteWebhook | 指定されたウェブフックを削除する許可を付与 | 書き込み | |||
| DeregisterWebhookWithThirdParty | 設定で指定されたサードパーティーからウェブフックの登録を削除する許可を付与 | 書き込み | |||
| DisableStageTransition | リビジョンがパイプラインの次のステージに移行することを禁止する許可を付与 | 書き込み | |||
| EnableStageTransition | リビジョンをパイプラインの次のステージに移行することを許可する許可を付与 | 書き込み | |||
| GetActionType | アクションタイプに関する情報を表示する許可を付与 | 読み込み | |||
| GetJobDetails | ジョブに関する情報を表示する許可を付与 (カスタムアクションのみ) | 読み込み | |||
| GetPipeline | パイプライン構造に関する情報を取得する許可を付与 | 読み込み | |||
| GetPipelineExecution | パイプラインの実行に関する情報 (アーティファクト、パイプラインの実行 ID、パイプラインの名前、バージョン、ステータスなど) を表示する許可を付与 | 読み込み | |||
| GetPipelineState | パイプラインのステージとアクションの現在の状態に関する情報を表示する許可を付与 | 読み込み | |||
| GetThirdPartyJobDetails | サードパーティーアクションのジョブの詳細を表示する許可を付与 (パートナーアクションのみ) | 読み込み | |||
| ListActionExecutions | パイプラインで発生したアクション実行を一覧表示する許可を付与 | 読み込み | |||
| ListActionTypes | アカウントのパイプラインで使用可能なすべてのアクションタイプの概要を一覧表示する許可を付与 | 読み取り | |||
| ListDeployActionExecutionTargets | パイプラインで発生したデプロイアクション実行のデプロイの詳細を一覧表示するアクセス許可を付与します | 読み取り | |||
| ListPipelineExecutions | パイプラインの最新の実行の概要を一覧表示する許可を付与 | リスト | |||
| ListPipelines | に関連付けられているすべてのパイプラインの概要を一覧表示するアクセス許可を付与します AWS アカウント | リスト | |||
| ListRuleExecutions | パイプラインで発生したルール実行を一覧表示する許可を付与する | 読み取り | |||
| ListRuleTypes | アカウントのパイプラインで使用可能なすべてのルールタイプの概要を一覧表示する許可を付与する | 読み取り | |||
| ListTagsForResource | CodePipeline リソースのタグを一覧表示する許可を付与 | 読み取り | |||
| ListWebhooks | に関連付けられているすべてのウェブフックを一覧表示するアクセス許可を付与します AWS アカウント | リスト | |||
| OverrideStageCondition | ステージの条件を上書きしてパイプラインの実行を再開する許可を付与する | 書き込み | |||
| PollForJobs | CodePipeline が影響するジョブに関する情報を表示する許可を付与 | 書き込み | |||
| PollForThirdPartyJobs | ジョブワーカーが処理するサードパーティージョブがあるかどうかを決定する許可を付与 (パートナーアクションのみ) | 書き込み | |||
| PutActionRevision | パイプラインのアクションを編集する許可を付与 | 書き込み | |||
| PutApprovalResult | CodePipeline の手動承認リクエストへのレスポンス (承認済みまたは拒否済み) を提供する許可を付与 | 書き込み | |||
| PutJobFailureResult | ジョブワーカーによってパイプラインに返されるジョブの失敗を表すアクセス許可を付与します (カスタムアクションのみ) | 書き込み | |||
| PutJobSuccessResult | ジョブワーカーによってパイプラインに返されるジョブの成功を表すアクセス許可を付与します (カスタムアクションのみ) | 書き込み | |||
| PutThirdPartyJobFailureResult | ジョブワーカーによってパイプラインに返されたサードパーティージョブの失敗を表すアクセス許可を付与します (パートナーアクションのみ) | 書き込み | |||
| PutThirdPartyJobSuccessResult | ジョブワーカーによってパイプラインに返されたサードパーティージョブの成功を表すアクセス許可を付与します (パートナーアクションのみ) | 書き込み | |||
| PutWebhook | ウェブフックを作成または更新する許可を付与 | 書き込み | |||
| RegisterWebhookWithThirdParty | 設定で指定したサードパーティーにウェブフックを登録する許可を付与 | 書き込み | |||
| RetryStageExecution | ステージで最後に失敗したアクションを再試行することでパイプラインの実行を再開する許可を付与 | 書き込み | |||
| RollbackStage | ステージを以前の成功した実行にロールバックする許可を付与する | 書き込み | |||
| StartPipelineExecution | パイプラインを通じて最新のリビジョンを実行する許可を付与 | 書き込み | |||
| StopPipelineExecution | 進行中のパイプラインの実行を停止する許可を付与 | 書き込み | |||
| TagResource | CodePipeline リソースにタグを付けるアクセス許可を付与します | タグ付け | |||
| UntagResource | CodePipeline リソースからタグを削除する許可を付与 | Tagging | |||
| UpdateActionType | アクションタイプを更新する許可を付与 | 書き込み | |||
| UpdatePipeline | パイプラインの構造に対する変更を適用してパイプラインを更新する許可を付与 | 書き込み |
AWS CodePipeline で定義されるリソースタイプ
以下のリソースタイプは、このサービスによって定義され、IAM アクセス許可ポリシーステートメントの Resource エレメントで使用できます。アクションテーブルの各アクションは、そのアクションで指定できるリソースタイプを示しています。リソースタイプは、ポリシーに含めることができる条件キーを定義することもできます。これらのキーは、[リソースタイプ] テーブルの最後の列に表示されます。以下の表の列の詳細については、「リソースタイプテーブル」を参照してください。
| リソースタイプ | ARN | 条件キー |
|---|---|---|
| action |
arn:${Partition}:codepipeline:${Region}:${Account}:${PipelineName}/${StageName}/${ActionName}
|
|
| actiontype |
arn:${Partition}:codepipeline:${Region}:${Account}:actiontype:${Owner}/${Category}/${Provider}/${Version}
|
|
| pipeline |
arn:${Partition}:codepipeline:${Region}:${Account}:${PipelineName}
|
|
| stage |
arn:${Partition}:codepipeline:${Region}:${Account}:${PipelineName}/${StageName}
|
|
| webhook |
arn:${Partition}:codepipeline:${Region}:${Account}:webhook:${WebhookName}
|
AWS CodePipeline の条件キー
AWS CodePipeline では、IAM ポリシーの Condition要素で使用できる以下の条件キーを定義します。これらのキーを使用して、ポリシーステートメントが適用される条件をさらに絞り込むことができます。以下の表の列の詳細については、「条件キーテーブル」を参照してください。
すべてのサービスで使用できるグローバル条件キーを表示するには、AWS 「グローバル条件コンテキストキー」を参照してください。
| 条件キー | 説明 | タイプ |
|---|---|---|
| aws:RequestTag/${TagKey} | リクエスト内のタグキーと値のペアのプレゼンスに基づいてアクションをフィルタリングします | 文字列 |
| aws:ResourceTag/${TagKey} | リソースにアタッチされているタグキーと値のペアに基づいてアクションをフィルタリングします | 文字列 |
| aws:TagKeys | リクエスト内のタグキーのプレゼンスに基づいてアクションをフィルタリングします | ArrayOfString |