「Amazon ECSタスク定義のレンダリング」アクション YAML

以下は、Amazon タスクYAML定義アクションのレンダリングの定義です。 ECS このアクションの使用方法については、「」を参照してくださいAmazon ECSタスク定義の変更。

このアクション定義は、より広範なワークフロー定義ファイル内のセクションとして存在します。ファイルの詳細については、「ワークフローYAML定義」を参照してください。

注記

以下のYAMLプロパティのほとんどには、ビジュアルエディタに対応する UI 要素があります。UI 要素を検索するには、Ctrl+F を使用します。 要素は、関連付けられた YAMLプロパティとともに一覧表示されます。

# The workflow definition starts here.
# See 最上位プロパティ for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.   
  ECSRenderTaskDefinition_nn: 
    Identifier: aws/ecs-render-task-definition@v1
    DependsOn:
      - build-action
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Inputs:
      # Specify a source or an artifact, but not both.
      Sources:
        - source-name-1
      Artifacts:
        - task-definition-artifact
      Variables:
        - Name: variable-name-1
          Value: variable-value-1
        - Name: variable-name-2
          Value: variable-value-2
    Configuration 
      task-definition: task-definition-path
      container-definition-name: container-definition-name
      image: docker-image-name
      environment-variables:
        - variable-name-1=variable-value-1
        - variable-name-2=variable-value-2
    Outputs:
      Artifacts:
        - Name: TaskDefArtifact
          Files: "task-definition*"
      Variables:
        - task-definition
        

ECSRenderTaskDefinition

(必須)

アクションの名前を指定します。すべてのアクション名は、ワークフロー内で一意である必要があります。アクション名は、英数字 (a～z、A～Z、0～9)、ハイフン (-)、アンダースコア (_) に制限されています。スペースは使用できません。引用符を使用してアクション名で特殊文字やスペースを有効にすることはできません。

デフォルト: ECSRenderTaskDefinition_nn。

対応する UI: 設定タブ/アクション名

Identifier

(ECSRenderTaskDefinition/Identifier)

(必須)

アクションを識別します。バージョンを変更しない限り、このプロパティを変更しないでください。詳細については、「使用するアクションバージョンの指定」を参照してください。

デフォルト: aws/ecs-render-task-definition@v1。

対応する UI: ワークフロー図/ECSRenderTaskDefinition_nn/aws/ecs-render-task-definition@v1 ラベル

DependsOn

(ECSRenderTaskDefinition/DependsOn)

(オプション)

このアクションを実行するために正常に実行する必要があるアクション、アクショングループ、またはゲートを指定します。

「依存」機能の詳細については、「」を参照してくださいシーケンスアクション。

対応する UI: の入力タブ/依存 - オプション

Compute

(ECSRenderTaskDefinition/Compute)

(オプション)

ワークフローアクションを実行するために使用されるコンピューティングエンジン。コンピューティングはワークフローレベルまたはアクションレベルで指定できますが、両方を指定することはできません。ワークフローレベルで指定すると、コンピューティング設定はワークフローで定義されたすべてのアクションに適用されます。ワークフローレベルでは、同じインスタンスで複数のアクションを実行することもできます。詳細については、「アクション間でのコンピューティングの共有」を参照してください。

対応する UI: なし

Type

(ECSRenderTaskDefinition/Compute/Type)

( Computeが含まれている場合は必須）

コンピューティングエンジンのタイプ。次のいずれかの値を使用できます。

• EC2 (ビジュアルエディタ) または EC2 (YAML エディタ）

  アクション実行中の柔軟性のために最適化されました。

• Lambda (ビジュアルエディタ) または Lambda (YAMLエディタ）

  アクションの起動速度を最適化しました。

コンピューティングタイプの詳細については、「コンピューティングタイプ」を参照してください。

対応する UI: 設定タブ/コンピューティングタイプ

Fleet

(ECSRenderTaskDefinition/Compute/Fleet)

(オプション)

ワークフローまたはワークフローアクションを実行するマシンまたはフリートを指定します。オンデマンドフリートでは、アクションが開始されると、ワークフローは必要なリソースをプロビジョニングし、アクションが終了するとマシンは破棄されます。オンデマンドフリートの例: Linux.x86-64.Large、Linux.x86-64.XLarge。オンデマンドフリートの詳細については、「」を参照してくださいオンデマンドフリートプロパティ。

プロビジョニングされたフリートでは、ワークフローアクションを実行するように一連の専用マシンを設定します。これらのマシンはアイドル状態のままで、すぐにアクションを処理できます。プロビジョニングされたフリートの詳細については、「」を参照してくださいプロビジョニングされたフリートプロパティ。

Fleet を省略した場合、デフォルトは ですLinux.x86-64.Large。

対応する UI: 設定タブ/コンピューティングフリート

Timeout

(ECSRenderTaskDefinition/Timeout)

(オプション)

がアクション CodeCatalyst を終了するまでにアクションを実行できる時間を分単位で指定します (YAML エディタ）、または時間と分単位で指定します (ビジュアルエディタ）。最小値は 5 分で、最大値は「」で説明されていますでのワークフローのクォータ CodeCatalyst。デフォルトのタイムアウトは、最大タイムアウトと同じです。

対応する UI: 設定タブ/タイムアウト - オプション

Inputs

(ECSRenderTaskDefinition/Inputs)

(オプション)

Inputs セクションでは、ワークフローの実行中に がECSRenderTaskDefinition必要とするデータを定義します。

注記

Render Amazon ECSタスク定義アクションごとに許可される入力 (ソースまたはアーティファクト) は 1 つだけです。変数はこの合計にはカウントされません。

対応する UI: Inputs タブ

Sources

(ECSRenderTaskDefinition/Inputs/Sources)

（タスク定義ファイルがソースリポジトリに保存されている場合に必須）

タスク定義ファイルがソースリポジトリに保存されている場合は、そのソースリポジトリのラベルを指定します。現在、サポートされているラベルは のみですWorkflowSource。

タスク定義ファイルがソースリポジトリに含まれていない場合は、別のアクションによって生成されたアーティファクトに存在する必要があります。

sources の詳細については、「ソースリポジトリをワークフローに接続する」を参照してください。

対応する UI: 入力タブ/ソース - オプション

Artifacts - input

(ECSRenderTaskDefinition/Inputs/Artifacts)

（タスク定義ファイルが前のアクションの出力アーティファクトに保存されている場合に必要です）

デプロイするタスク定義ファイルが、前のアクションによって生成されたアーティファクトに含まれている場合は、ここでそのアーティファクトを指定します。タスク定義ファイルがアーティファクトに含まれていない場合は、ソースリポジトリに存在する必要があります。

アーティファクトの例などの詳細については、「」を参照してくださいアクション間でのアーティファクトとファイルの共有。

対応する UI: 設定タブ/アーティファクト - オプション

Variables - input

(ECSRenderTaskDefinition/Inputs/Variables)

(必須)

アクションで使用できるようにしたい入力変数を定義する名前と値のペアのシーケンスを指定します。変数名は、英数字 (a～z、A～Z、0～9)、ハイフン (-)、アンダースコア (_) に制限されています。スペースは使用できません。変数名で特殊文字やスペースを有効にするために引用符を使用することはできません。

例を含む変数の詳細については、「」を参照してくださいワークフローでの変数の使用。

対応する UI: 入力タブ/変数 - オプション

Configuration

(ECSRenderTaskDefinition/Configuration)

(必須)

アクションの設定プロパティを定義できるセクション。

対応する UI: 設定タブ

task-definition

(ECSRenderTaskDefinition/Configuration/task-definition)

(必須)

既存のタスク定義ファイルへのパスを指定します。ファイルがソースリポジトリにある場合、パスはソースリポジトリのルートフォルダを基準にしています。ファイルが以前のワークフローアクションのアーティファクトに存在する場合、パスはアーティファクトルートフォルダを基準にしています。タスク定義ファイルの詳細については、「Amazon Elastic Container Service デベロッパーガイド」の「タスク定義」を参照してください。

対応する UI: 設定タブ/タスク定義

container-definition-name

(ECSRenderTaskDefinition/Configuration/container-definition-name)

(必須)

Docker イメージを実行するコンテナの名前を指定します。この名前はcontainerDefinitions、タスク定義ファイルの 、 nameフィールドにあります。詳細については、「Amazon Elastic Container Service デベロッパーガイド」の「名前」を参照してください。

対応する UI: 設定タブ/コンテナ名

image

(ECSRenderTaskDefinition/Configuration/image)

(必須)

Render Amazon ECSタスク定義アクションでタスク定義ファイルに追加する Docker イメージの名前を指定します。アクションはcontainerDefinitions、タスク定義ファイルの 、 imageフィールドにこの名前を追加します。値が imageフィールドにすでに存在する場合、アクションによって上書きされます。イメージ名に変数を含めることができます。

例:

を指定するとMyDockerImage:${WorkflowSource.CommitId}、アクションはMyDockerImage:commit-idタスク定義ファイルに を追加します。ここで、commit-id は、ワークフローによって実行時に生成されるコミット ID です。

を指定するとmy-ecr-repo/image-repo:$(date +%m-%d-%y-%H-%m-%s)、 アクションは を追加します。my-ecr-repo/image-repo:date +%m-%d-%y-%H-%m-%s タスク定義ファイルへの 。ここで、my-ecr-repo はURI、Amazon Elastic Container Registry (ECR) および date +%m-%d-%y-%H-%m-%s は、ワークフローによって実行時にmonth-day-year-hour-minute-second生成される形式のタイムスタンプです。

image フィールドの詳細については、「Amazon Elastic Container Service デベロッパーガイド」の「イメージ」を参照してください。変数の詳細については、「」を参照してくださいワークフローでの変数の使用。

対応する UI: 設定タブ/イメージ名

environment-variables

(ECSRenderTaskDefinition/Configuration/environment-variables)

(必須)

Render Amazon ECSタスク定義アクションでタスク定義ファイルに追加する環境変数を指定します。アクションは、タスク定義ファイルの containerDefinitions、 environmentフィールドに変数を追加します。変数が ファイルにすでに存在する場合、 アクションは既存の変数の値を上書きし、新しい変数を追加します。Amazon ECS環境変数の詳細については、「Amazon Elastic Container Service デベロッパーガイド」の「環境変数の指定」を参照してください。

対応する UI: 設定タブ/環境変数 - オプション

Outputs

(ECSRenderTaskDefinition/Outputs)

(必須)

ワークフローの実行中に アクションによって出力されるデータを定義します。

対応する UI: 出力タブ

Artifacts

(ECSRenderTaskDefinition/Outputs/Artifacts)

(必須)

アクションによって生成されたアーティファクトを指定します。これらのアーティファクトは、他のアクションで入力として参照できます。

アーティファクトの例などの詳細については、「」を参照してくださいアクション間でのアーティファクトとファイルの共有。

対応する UI: 出力タブ/アーティファクト

Name

(ECSRenderTaskDefinition/Outputs/Artifacts/Name)

(必須)

更新されたタスク定義ファイルを含むアーティファクトの名前を指定します。デフォルト値は、MyTaskDefinitionArtifactです。次に、このアーティファクトを Amazon へのデプロイECSアクションへの入力として指定する必要があります。このアーティファクトを入力として Amazon にデプロイECSアクションに追加する方法については、「」を参照してください例: Amazon ECS taskdef を変更する。

対応する UI: 出力タブ/アーティファクト/名前

Files

(ECSRenderTaskDefinition/Outputs/Artifacts/Files)

(必須)

アーティファクトに含めるファイルを指定します。で始まる更新されたタスク定義ファイルが含まれるtask-definition-*ように task-definition-を指定する必要があります。

対応する UI: タブ/アーティファクト/ファイル出力

Variables

(ECSRenderTaskDefinition/Outputs/Variables)

(必須)

レンダリングアクションによって設定される変数の名前を指定します。レンダリングアクションは、この変数の値を更新されたタスク定義ファイルの名前 ( など) に設定しますtask-definition-random-string.json。次に、Amazon アクションへのデプロイ ECS (ビジュアルエディタ) または (task-definitionyaml エディタ) プロパティでこの変数を指定する必要があります。この変数を Amazon へのデプロイECSアクションに追加する方法については、例: Amazon ECS taskdef を変更する「」を参照してください。

デフォルト: task-definition

対応する UI: Outputs tab/Variables/Name フィールド