AWS-ECSRunTask - AWS Systems Manager オートメーションランブックリファレンス

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

AWS-ECSRunTask

説明

AWS-ECSRunTask ランブックは、指定した Amazon Elastic Container Service (Amazon ECS) タスクを実行します。

このオートメーションを実行する (コンソール)

ドキュメントタイプ

Automation

[所有者]

Amazon

[Platforms] (プラットフォーム)

Linux

パラメータ

  • AutomationAssumeRole

    型: 文字列

    説明: (オプション) Systems Manager Automation が AWS Identity and Access Management ユーザーに代わってアクションを実行できるようにする () ロールARNの Amazon リソースネーム (IAM)。ロールを指定しない場合、Systems Manager Automation はこのランブックを開始するユーザーのアクセス許可を使用します。

  • capacityProviderStrategy

    型: 文字列

    説明: (オプション) タスクに使用するキャパシティープロバイダー戦略。

  • クラスター

    型: 文字列

    説明: (オプション) タスクを実行するクラスターARNの短縮名または 。クラスターを指定しない場合、デフォルトのクラスターが使用されます。

  • count

    型: 文字列

    説明: (オプション) クラスターに配置する指定されたタスクのインスタンス化の数。リクエストごとに最大 10 個のタスクを指定できます。

  • enableECSManagedタグ

    型: ブール値

    説明: (オプション) タスクに Amazon ECSマネージドタグを使用するかどうかを指定します。詳細については、「Amazon Elastic Container Service デベロッパーガイド」の「Amazon ECSリソースのタグ付け」を参照してください。

  • enableExecuteCommand

    型: ブール値

    説明: (オプション) このタスクのコンテナの実行コマンド機能を有効にするかどうかを決定します。true の場合、これはタスク内のすべてのコンテナでコマンド機能を実行します。

  • グループ

    型: 文字列

    説明: (オプション) タスクに関連付けるタスクグループの名前。デフォルト値は、タスク定義の姓です。例えば、family:my-family-name と指定します。

  • launchType

    型: 文字列

    有効な値: EC2 | FARGATE | EXTERNAL

    説明: (オプション) スタンドアロンタスクを実行するインフラストラクチャ。

  • networkConfiguration

    型: 文字列

    説明: (オプション) タスクのネットワーク設定。このパラメータは、awsvpcネットワークモードを使用して独自のElastic Network Interface を受信するタスク定義に必要であり、他のネットワークモードではサポートされていません。

  • オーバーライド

    型: 文字列

    説明: (オプション) 指定されたタスク定義でコンテナの名前を指定するJSON形式のコンテナオーバーライドのリストと、コンテナが受け取るオーバーライド。タスク定義または Docker イメージで指定されたコンテナのデフォルトコマンドを、コマンドオーバーライドで上書きできます。タスク定義またはコンテナの Docker イメージで指定されている既存の環境変数を上書きすることもできます。さらに、環境オーバーライドを使用して新しい環境変数を追加できます。

  • placementConstraints

    型: 文字列

    説明: (オプション) タスクに使用する配置制約オブジェクトの配列。タスク定義の制約や実行時に指定された制約を含め、各タスクに最大 10 個の制約を指定できます。

  • placementStrategy

    型: 文字列

    説明: (オプション) タスクに使用する配置戦略オブジェクト。タスクごとに最大 5 つの戦略ルールを指定できます。

  • platformVersion

    型: 文字列

    説明: (オプション) タスクが使用するプラットフォームバージョン。プラットフォームバージョンは、Fargate でホストされるタスクに対してのみ指定されます。プラットフォームバージョンが指定されない場合、LATEST プラットフォームバージョンが使用されます。

  • propagateTags

    型: 文字列

    説明: (オプション) タグがタスク定義からタスクに伝達されるかどうかを決定します。値を指定しない場合、タグは伝播されません。タグは、タスクの作成時にのみタスクに伝播できます。

  • referenceId

    型: 文字列

    説明: (オプション) タスクに使用するリファレンス ID。リファレンス ID の最大長は 1024 文字です。

  • startedBy

    型: 文字列

    説明: (オプション) タスクの開始時に指定されたオプションのタグ。これにより、ListTasksAPIオペレーションの結果をフィルタリングして、特定のジョブに属するタスクを特定できます。最大 36 文字 (大文字と小文字)、数字、ハイフン (-)、アンダースコア (_) を使用できます。

  • タグ

    型: 文字列

    説明: (オプション) タスクを分類および整理するのに役立つ、タスクに適用するメタデータ。各タグは、ユーザー定義のキーと値で構成されます。

  • taskDefinition

    型: 文字列

    説明: (オプション) 実行するタスク定義ARNの familyおよび revision (familyrevision) または一杯。リビジョンが指定されていない場合は、最新のACTIVEリビジョンが使用されます。

必要なIAMアクセス許可

AutomationAssumeRole パラメータでは、ランブックを正常に使用するために、次のアクションが必要です。

  • ecs:RunTask

ドキュメントステップ

aws:executeScript - ランブック入力パラメータに指定した値に基づいて Amazon ECSタスクを実行します。