Amazon CodeCatalyst は新規のお客様には提供されなくなりました。既存のお客様は、通常どおりサービスを引き続き使用できます。詳細については、「[CodeCatalyst から移行する方法](migration.md)」を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# ワークフローを使用して Amazon S3 にファイルを発行する
このセクションでは、CodeCatalyst ワークフローを使用してファイルを Amazon S3 に発行する方法について説明します。これを行うには、**Amazon S3 発行**アクションをワークフローに追加する必要があります。**Amazon S3 発行**アクションは、ソースディレクトリから Amazon S3 バケットにファイルをコピーします。ソースディレクトリとしては、次の場所を利用できます。
+ [ソースリポジトリ](source.md)、または
+ 別のワークフローアクションによって生成された[出力アーティファクト](workflows-working-artifacts.md)
**Topics**
+ [「Amazon S3 発行」アクションを使用すべき場合](#s3-pub-action-when-to-use)
+ [「Amazon S3 発行」アクションで使用されるランタイムイメージ](#s3-pub-action-runtime)
+ [例: Amazon S3 にファイルを発行する](s3-pub-action-example-workflow.md)
+ [「Amazon S3 発行」アクションの追加](s3-pub-action-add.md)
+ [「Amazon S3 発行」アクションの YAML](s3-pub-action-ref.md)
## 「Amazon S3 発行」アクションを使用すべき場合
次の場合は、このアクションを使用します。
+ ワークフローで生成されたファイルを Amazon S3 に保存する必要があります。
例えば、ワークフローで静的ウェブサイトをビルドして、それを Amazon S3 でホストする場合です。この場合、ワークフローには、[ビルド](build-add-action.md)アクション (サイトの HTML とサポートファイルをビルドする) と **Amazon S3 発行**アクション (ファイルを Amazon S3 にコピーする) が含まれます。
+ ソースリポジトリに含まれるファイルを Amazon S3 に保存する必要があります。
例えば、ソースリポジトリに含まれるアプリケーションソースファイルを毎晩 Amazon S3 にアーカイブする場合です。
## 「Amazon S3 発行」アクションで使用されるランタイムイメージ
**Amazon S3 発行**アクションは、[2022 年 11 月のイメージ](build-images.md#build.previous-image)で実行されます。詳細については、「[アクティブなイメージ](build-images.md#build-curated-images)」を参照してください。
# 例: Amazon S3 にファイルを発行する
次のワークフローの例には、**Amazon S3 発行**アクションとビルドアクションが含まれています。このワークフローは、静的ドキュメントウェブサイトをビルドして、サイトがホストされる Amazon S3 に発行します。このワークフローは、連続して実行される次の構成要素で構成されます。
+ **トリガー** – ソースリポジトリに変更をプッシュすると、このトリガーによってワークフローが自動的に開始されます。トリガーについての詳細は、「[トリガーを使用したワークフロー実行の自動的な開始](workflows-add-trigger.md)」を参照してください。
+ **ビルド**アクション (`BuildDocs`) – トリガーされると、アクションは静的ドキュメントウェブサイト (`mkdocs build`) をビルドし、関連する HTML ファイルとサポートメタデータを `MyDocsSite` というアーティファクトに追加します。ビルドアクションの詳細については、「[ワークフローを使用したビルド](build-workflow-actions.md)」を参照してください。
+ **Amazon S3 発行**アクション (`PublishToS3`) – ビルドアクションが完了すると、このアクションはアーティファクト `MyDocsSite` のサイトを、ホスティングのために Amazon S3 にコピーします。
**注記**
次のワークフロー例は説明を目的としており、追加の設定なしでは機能しません。
**注記**
次の YAML コードでは、必要に応じて `Connections:` セクションを省略できます。このセクションを省略する場合は、環境の**デフォルトの IAM ロール**フィールドで指定されたロールに、**Amazon S3 発行**アクションに必要なアクセス許可と信頼ポリシーが含まれていることを確認する必要があります。デフォルトの IAM ロールを使用して環境を設定する方法の詳細については、「[環境を作成する](deploy-environments-creating-environment.md)」を参照してください。**Amazon S3 発行**アクションに必要なアクセス許可と信頼ポリシーの詳細については、[「Amazon S3 発行」アクションの YAML](s3-pub-action-ref.md) の [Role](s3-pub-action-ref.md#s3.pub.environment.connections.role) プロパティの説明を参照してください。
```
Name: codecatalyst-s3-publish-workflow
SchemaVersion: 1.0
Triggers:
- Type: PUSH
Branches:
- main
Actions:
BuildDocs:
Identifier: aws/build@v1
Inputs:
Sources:
- WorkflowSource
Configuration:
Steps:
- Run: echo BuildDocs started on `date`
- Run: pip install --upgrade pip
- Run: pip install mkdocs
- Run: mkdocs build
- Run: echo BuildDocs completed on `date`
Outputs:
Artifacts:
- Name: MyDocsSite
Files:
- "site/**/*"
PublishToS3:
Identifier: aws/s3-publish@v1
Environment:
Name: codecatalyst-s3-publish-environment
Connections:
- Name: codecatalyst-account-connection
Role: codecatalyst-s3-publish-build-role
Inputs:
Sources:
- WorkflowSource
Artifacts:
- MyDocsSite
Configuration:
DestinationBucketName: amzn-s3-demo-bucket
SourcePath: /artifacts/PublishToS3/MyDocSite/site
TargetPath: my/docs/site
```
# 「Amazon S3 発行」アクションの追加
次の手順を使用して、**Amazon S3 発行**アクションをワークフローに追加します。
------
#### [ Visual ]
**ビジュアルエディタを使用して「Amazon S3 発行」アクションを追加するには**
1. [https://codecatalyst.aws/](https://codecatalyst.aws/) で CodeCatalyst コンソールを開きます。
1. プロジェクトを選択します。
1. ナビゲーションペインで **[CI/CD]**、**[ワークフロー]** の順に選択します。
1. ワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名またはステータスでフィルタリングすることもできます。
1. **[編集]** を選択します。
1. **[ビジュアル]** を選択します。
1. 左上で **[\$1 アクション]** を選択してアクションカタログを開きます。
1. ドロップダウンリストから、**[Amazon CodeCatalyst]** を選択します。
1. **[Amazon S3 発行]** アクションを検索し、次のいずれかを実行します。
+ プラス記号 (**＋**) を選択してワークフロー図にアクションを追加し、設定ペインを開きます。
または
+ **[Amazon S3 発行]** を選択します。アクションの詳細ダイアログボックスが表示されます。このダイアログボックスで、次の操作を行います。
+ (任意) **[ソースを表示]** を選択して、[アクションのソースコードを表示します](workflows-view-source.md#workflows-view-source.title)。
+ **[ワークフローに追加]** を選択して、ワークフロー図にアクションを追加し、設定ペインを開きます。
1. **[入力]**、**[設定]**、**[出力]** タブで、必要に応じてフィールドに入力します。各フィールドの説明については、「[「Amazon S3 発行」アクションの YAML](s3-pub-action-ref.md)」を参照してください。このリファレンスでは、YAML エディタとビジュアルエディタの両方に表示される各フィールド (および対応する YAML プロパティ値) に関する詳細情報を提供しています。
1. (オプション) **[検証]** を選択して、ワークフローの YAML コードをコミットする前に検証します。
1. **[コミット]** を選択し、コミットメッセージを入力し、再度 **[コミット]** を選択します。
------
#### [ YAML ]
**YAML エディタを使用して「Amazon S3 発行」アクションを追加するには**
1. [https://codecatalyst.aws/](https://codecatalyst.aws/) で CodeCatalyst コンソールを開きます。
1. プロジェクトを選択します。
1. ナビゲーションペインで **[CI/CD]**、**[ワークフロー]** の順に選択します。
1. ワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名またはステータスでフィルタリングすることもできます。
1. **[編集]** を選択します。
1. **[YAML]** を選択します。
1. 左上で **[\$1 アクション]** を選択してアクションカタログを開きます。
1. ドロップダウンリストから、**[Amazon CodeCatalyst]** を選択します。
1. **[Amazon S3 発行]** アクションを検索し、次のいずれかを実行します。
+ プラス記号 (**＋**) を選択してワークフロー図にアクションを追加し、設定ペインを開きます。
または
+ **[Amazon S3 発行]** を選択します。アクションの詳細ダイアログボックスが表示されます。このダイアログボックスで、次の操作を行います。
+ (任意) **[ソースを表示]** を選択して、[アクションのソースコードを表示します](workflows-view-source.md#workflows-view-source.title)。
+ **[ワークフローに追加]** を選択して、ワークフロー図にアクションを追加し、設定ペインを開きます。
1. 必要に応じて、YAML コードのプロパティを変更します。使用可能な各プロパティの説明は、「[「Amazon S3 発行」アクションの YAML](s3-pub-action-ref.md)」に記載されています。
1. (オプション) **[検証]** を選択して、ワークフローの YAML コードをコミットする前に検証します。
1. **[コミット]** を選択し、コミットメッセージを入力し、再度 **[コミット]** を選択します。
------
# 「Amazon S3 発行」アクションの YAML
以下は、**Amazon S3 発行**アクションの YAML 定義です。このアクションの使用方法については、「[ワークフローを使用して Amazon S3 にファイルを発行する](s3-pub-action.md)」を参照してください。
このアクション定義は、より広範なワークフロー定義ファイル内のセクションとして存在します。ファイルの詳細については、「[ワークフロー YAML 定義](workflow-reference.md)」を参照してください。
**注記**
後続の YAML プロパティのほとんどには、対応する UI 要素がビジュアルエディタにあります。UI 要素を検索するには、**[Ctrl\$1F]** を使用します。要素は、関連付けられた YAML プロパティとともに一覧表示されます。
```
# The workflow definition starts here.
# See 最上位プロパティ for details.
Name: MyWorkflow
SchemaVersion: 1.0
Actions:
# The action definition starts here.
S3Publish\$1nn:
Identifier: aws/s3-publish@v1
DependsOn:
- build-action
Compute:
Type: EC2 | Lambda
Fleet: fleet-name
Timeout: timeout-minutes
Inputs:
Sources:
- source-name-1
Artifacts:
- artifact-name
Variables:
- Name: variable-name-1
Value: variable-value-1
- Name: variable-name-2
Value: variable-value-2
Environment:
Name: environment-name
Connections:
- Name: account-connection-name
Role: iam-role-name
Configuration:
SourcePath: my/source
DestinationBucketName: amzn-s3-demo-bucket
TargetPath: my/target
```
## S3Publish
(必須)
アクションの名前を指定します。すべてのアクション名は、ワークフロー内で一意である必要があります。アクション名で使用できるのは、英数字 (a～z、A～Z、0～9)、ハイフン (-)、アンダースコア (\$1) のみです。スペースは使用できません。引用符を使用して、アクション名の特殊文字とスペースを有効にすることはできません。
デフォルト: `S3Publish_nn`。
対応する UI: [設定] タブ/**[アクション名]**
## Identifier
(*S3Publish*/**Identifier**)
(必須)
アクションを識別します。バージョンを変更したい場合でない限り、このプロパティを変更しないでください。詳細については、「[使用するアクションバージョンの指定](workflows-action-versions.md)」を参照してください。
デフォルト: `aws/s3-publish@v1`。
対応する UI: ワークフロー図/S3Publish\$1nn/**aws/s3-publish@v1** ラベル
## DependsOn
(*S3Publish*/**DependsOn**)
(オプション)
このアクションを実行するために正常に実行する必要があるアクション、アクショングループ、またはゲートを指定します。
「DependsOn」機能の詳細については、「[アクションの順序付け](workflows-depends-on.md)」を参照してください。
対応する UI: [入力] タブ/**[依存 - オプション]**
## Compute
(*S3Publish*/**Compute**)
(オプション)
ワークフローアクションの実行に使用されるコンピューティングエンジンです。コンピューティングはワークフローレベルまたはアクションレベルで指定できますが、両方を指定することはできません。ワークフローレベルで指定すると、コンピューティング設定はワークフローで定義されたすべてのアクションに適用されます。ワークフローレベルでは、同じインスタンスで複数のアクションを実行することもできます。詳細については、「[アクション間でのコンピューティングの共有する](compute-sharing.md)」を参照してください。
対応する UI: *[なし]*
## Type
(*S3Publish*/Compute/**Type**)
([Compute](#s3.pub.computename) が含まれている場合は必須)
コンピューティングエンジンのタイプです。次のいずれかの値を使用できます。
+ **EC2** (ビジュアルエディタ) または `EC2` (YAML エディタ)
アクション実行時の柔軟性を目的として最適化されています。
+ **Lambda** (ビジュアルエディタ) または `Lambda` (YAML エディタ)
アクションの起動速度を最適化しました。
コンピューティングタイプの詳細については、「[コンピューティングタイプ](workflows-working-compute.md#compute.types)」を参照してください。
対応する UI: [設定] タブ/**[コンピューティングタイプ]**
## Fleet
(*S3Publish*/Compute/**Fleet**)
(オプション)
ワークフローまたはワークフローアクションを実行するマシンまたはフリートを指定します。オンデマンドフリートでは、アクションが開始すると、ワークフローは必要なリソースをプロビジョニングし、アクションが完了するとマシンは破棄されます。オンデマンドフリートの例: `Linux.x86-64.Large`、`Linux.x86-64.XLarge`。オンデマンドフリートの詳細については、「[オンデマンドフリートのプロパティ](workflows-working-compute.md#compute.on-demand)」を参照してください。
プロビジョニングされたフリートでは、ワークフローアクションを実行するように専用マシンのセットを設定します。これらのマシンはアイドル状態のままで、アクションをすぐに処理できます。プロビジョニングされたフリートの詳細については、「[プロビジョニングされたフリートのプロパティ](workflows-working-compute.md#compute.provisioned-fleets)」を参照してください。
`Fleet` を省略した場合、デフォルトは `Linux.x86-64.Large` です。
対応する UI: [設定] タブ/**[コンピューティングフリート]**
## Timeout
(*S3Publish*/**Timeout**)
(必須)
CodeCatalyst がアクションを終了するまでにアクションを実行できる時間を分単位 (YAML エディタ) または時間分単位 (ビジュアルエディタ) で指定します。最小値は 5 分で、最大値は [CodeCatalyst のワークフローのクォータ](workflows-quotas.md) で記述されています。デフォルトのタイムアウトは、最大タイムアウトと同じです。
対応する UI: [設定] タブ/**[タイムアウト - オプション]**
## Inputs
(*S3Publish*/**Inputs**)
(オプション)
`Inputs` セクションでは、ワークフローの実行中に `S3Publish` に必要なデータを定義します。
**注記**
**AWS CDK デプロイ**アクションごとに最大 4 つの入力 (1 つのソースと 3 つのアーティファクト) が許可されます。変数はこの合計にはカウントされません。
異なる入力 (ソースとアーティファクトなど) にあるファイルを参照する必要がある場合、ソース入力はプライマリ入力で、アーティファクトはセカンダリ入力になります。セカンダリ入力内のファイルへの参照には、プライマリからファイルを区別するための特別なプレフィックスが付きます。詳細については、「[例: 複数のアーティファクトでのファイルの参照](workflows-working-artifacts-ex.md#workflows-working-artifacts-ex-ref-file)」を参照してください。
対応する UI: **入力**タブ
## Sources
(*S3Publish*/Inputs/**Sources**)
(Amazon S3 に発行するファイルがソースリポジトリに保存されている場合は必須）
Amazon S3 に発行するファイルがソースリポジトリに保存されている場合は、そのソースリポジトリのラベルを指定します。現在サポートされているラベルは、`WorkflowSource` のみです。
Amazon S3 に発行するファイルがソースリポジトリに含まれていない場合は、別のアクションによって生成されたアーティファクトに存在する必要があります。
sources の詳細については、「[ワークフローへのソースリポジトリの接続](workflows-sources.md)」を参照してください。
対応する UI: 入力タブ/**ソース - オプション**
## Artifacts - input
(*S3Publish*/Inputs/**Artifacts**)
(Amazon S3 に発行するファイルが前のアクションの[出力アーティファクト](workflows-working-artifacts-output.md)に保存されている場合は必須）
Amazon S3 に発行するファイルが、前のアクションによって生成されたアーティファクトに含まれている場合は、ここでそのアーティファクトを指定します。ファイルがアーティファクトに含まれていない場合は、ソースリポジトリに存在する必要があります。
アーティファクトの詳細 (例を含む) については、「[アクション間でのアーティファクトとファイルの共有](workflows-working-artifacts.md)」を参照してください。
対応する UI: [設定] タブ/**[アーティファクト - オプション]**
## Variables - input
(*S3Publish*/Inputs/**Variables**)
(オプション)
アクションで使用できるようにしたい入力変数を定義する名前と値のペアのシーケンスを指定します。変数名に使用できるのは、英数字 (a～z、A～Z、0～9)、ハイフン (-)、アンダースコア (\$1) のみです。スペースは使用できません。引用符を使用して、変数名で特殊文字とスペースを有効にすることはできません。
変数の詳細 (例を含む) については、「[ワークフローでの変数の使用](workflows-working-with-variables.md)」を参照してください。
対応する UI: [入力] タブ/**[変数 - オプション]**
## Environment
(*S3Publish*/**Environment**)
(必須)
アクションで使用する CodeCatalyst 環境を指定します。アクションは、選択した環境で指定された AWS アカウント およびオプションの Amazon VPC に接続します。アクションは、環境で指定されたデフォルトの IAM ロールを使用して に接続し AWS アカウント、[Amazon VPC 接続](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.add.html)で指定された IAM ロールを使用して Amazon VPC に接続します。
**注記**
デフォルトの IAM ロールにアクションに必要なアクセス許可がない場合は、別のロールを使用するようにアクションを設定できます。詳細については、「[アクションの IAM ロールの変更](deploy-environments-switch-role.md)」を参照してください。
環境タグ付けの詳細については、「[AWS アカウント と VPCs へのデプロイ](deploy-environments.md)」と「[環境を作成する](deploy-environments-creating-environment.md)」を参照してください。
対応する UI: [設定] タブ/**[環境]**
## Name
(*S3Publish*/Environment/**Name**)
([Environment](#s3.pub.environment) が含まれている場合は必須)
アクションに関連付ける既存の環境の名前を指定します。
対応する UI: [設定] タブ/**[環境]**
## Connections
(*S3Publish*/Environment/**Connections**)
(新しいバージョンのアクションでは任意。古いバージョンでは必須)
アクションに関連付けるアカウント接続を指定します。`Environment` で最大 1 つのアカウント接続を指定できます。
アカウント接続を指定しない場合:
+ アクションは、CodeCatalyst コンソールの環境で指定された AWS アカウント 接続とデフォルトの IAM ロールを使用します。アカウント接続とデフォルトの IAM ロールを環境に追加する方法については、「[環境を作成する](deploy-environments-creating-environment.md)」を参照してください。
+ デフォルトの IAM ロールには、アクションに必要なポリシーとアクセス許可が含まれている必要があります。これらのポリシーとアクセス許可を確認するには、アクションの YAML 定義ドキュメントの **[ロール]** プロパティの説明を参照してください。
アカウント接続の詳細については、「[接続された AWS リソースへのアクセスを許可する AWS アカウント](ipa-connect-account.md)」を参照してください。アカウント接続を環境に追加する方法については、「[環境を作成する](deploy-environments-creating-environment.md)」を参照してください。
対応する UI: アクションのバージョンに応じて、次のいずれか。
+ (新しいバージョン) [設定] タブ/[環境]/[*my-environment* の内容]/3 つのドットメニュー/**[ロールを切り替える]**
+ (旧バージョン) [設定] タブ/「環境/アカウント/ロール」/**[AWS アカウント接続]**
## Name
(*S3Publish*/Environment/Connections/**Name**)
([Connections](#s3.pub.environment.connections) が含まれている場合は必須)
アカウント接続の名前を指定します。
対応する UI: アクションのバージョンに応じて、次のいずれか。
+ (新しいバージョン) [設定] タブ/[環境]/[*my-environment* の内容]/3 つのドットメニュー/**[ロールを切り替える]**
+ (旧バージョン) [設定] タブ/「環境/アカウント/ロール」/**[AWS アカウント接続]**
## Role
(*S3Publish*/Environment/Connections/**Role**)
([Connections](#s3.pub.environment.connections) が含まれている場合は必須)
**Amazon S3 発行**アクションがアクセスおよび Amazon S3 へのファイル AWS のコピーに使用する IAM ロールの名前を指定します。 Amazon S3 [ロールを CodeCatalyst スペース に追加](ipa-connect-account-addroles.md)し、ロールに次のポリシーが含まれていることを確認します。
IAM ロールを指定しない場合、アクションは CodeCatalyst コンソールの [[環境]](deploy-environments.md) に記載されているデフォルトの IAM ロールを使用します。環境でデフォルトのロールを使用する場合は、次のポリシーがあることを確認してください。
+ 以下のアクセス許可ポリシー:
**警告**
アクセス許可は、次のポリシーに示すアクセス許可に制限します。範囲の広いアクセス許可を持つロールを使用すると、セキュリティリスクが発生する可能性があります。
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:ListBucket",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::bucket-name",
"arn:aws:s3:::bucket-name/*"
]
}
]
}
```
------
+ 次のカスタム信頼ポリシー:
**注記**
必要に応じて、このアクションで `CodeCatalystWorkflowDevelopmentRole-spaceName` ロールを使用できます。このロールの詳細については、「[アカウントとスペース用の **CodeCatalystWorkflowDevelopmentRole-*spaceName*** ロールを作成する](ipa-iam-roles.md#ipa-iam-roles-service-create)」を参照してください。`CodeCatalystWorkflowDevelopmentRole-spaceName` ロールにはフルアクセス許可があり、セキュリティ上のリスクをもたらす可能性があることを理解してください。このロールは、セキュリティが懸念されないチュートリアルやシナリオでのみ使用することをお勧めします。
対応する UI: アクションのバージョンに応じて、次のいずれか。
+ (新しいバージョン) [設定] タブ/[環境]/[*my-environment* の内容]/3 つのドットメニュー/**[ロールを切り替える]**
+ (旧バージョン) [設定] タブ/「環境/アカウント/ロール」/**[ロール]**
## Configuration
(*S3Publish*/**Configuration**)
(必須)
アクションの設定プロパティを定義できるセクション。
対応する UI: **[設定]** タブ
## SourcePath
(*S3Publish*/Configuration/**SourcePath**)
(必須)
Amazon S3 に発行するディレクトリまたはファイルの名前とパスを指定します。ディレクトリまたはファイルは、ソースリポジトリまたは前のアクションからのアーティファクトに存在します。ソースリポジトリまたはアーティファクトのルートへの相対パスを指定します。
例:
`./myFolder/` を指定すると、`/myFolder` の中身が Amazon S3 にコピーされ、内部のディレクトリ構造は保持されます。
`./myFolder/myfile.txt` を指定すると、`myfile.txt` *のみ*が Amazon S3 にコピーされます。（ディレクトリ構造は削除されます。）
ワイルドカードは使用できません。
**注記**
ディレクトリまたはファイルパスにプレフィックスを追加して、見つけるアーティファクトまたはソースを示す必要がある場合があります。詳細については、「[ソースリポジトリファイルの参照](workflows-sources-reference-files.md)」および「[アーティファクト内のファイルの参照](workflows-working-artifacts-refer-files.md)」を参照してください。
対応する UI: [設定] タブ/**[ソースパス]**
## DestinationBucketName
(*S3Publish*/Configuration/**DestinationBucketName**)
(必須)
ファイルを発行する Amazon S3 バケットの名前を指定します。
対応する UI: [設定] タブ/**[送信先バケット - オプション]**
## TargetPath
(*S3Publish*/Configuration/**TargetPath**)
(オプション)
ファイルを発行する Amazon S3 のディレクトリの名前とパスを指定します。ディレクトリが存在しない場合は作成されます。ディレクトリパスにバケット名を含めることはできません。
例:
`myS3Folder`
`./myS3Folder/myS3Subfolder`
対応する UI: [設定] タブ/**[送信先ディレクトリ - オプション]**