「AWS Lambda 呼び出し」アクション YAML

フォーカスモード

「AWS Lambda 呼び出し」アクション YAML - Amazon CodeCatalyst

AWS Lambda 呼び出しアクションの YAML 定義を次に示します。このアクションの使用方法については、「ワークフローを使用して Lambda 関数を呼び出す」を参照してください。

このアクション定義は、より広範なワークフロー定義ファイル内のセクションとして存在します。ファイルの詳細については、「ワークフロー 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.   
  LambdaInvoke_nn: 
    Identifier: aws/lambda-invoke@v1
    DependsOn:
      - dependent-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:
        - request-payload
      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:
      Function: my-function|function-arn
      AWSRegion: us-west-2
      # Specify RequestPayload or RequestPayloadFile, but not both.
      RequestPayload: '{"firstname": "Li", lastname: "Jean", "company": "ExampleCo", "team": "Development"}'
      RequestPayloadFile: my/request-payload.json
      ContinueOnError: true|false
      LogType: Tail|None
      ResponseFilters: '{"name": ".name", "company": ".department.company"}'
    Outputs:
      Artifacts:
        - Name: lambda_artifacts
          Files: 
            - "lambda-response.json"

LambdaInvoke

(必須)

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

デフォルト: Lambda_Invoke_Action_Workflow_nn。

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

Identifier

(LambdaInvoke/Identifier)

(必須)

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

デフォルト: aws/lambda-invoke@v1。

対応する UI: ワークフロー図/LambdaInvoke_nn/aws/lambda-invoke@v1 ラベル

DependsOn

(LambdaInvoke/DependsOn)

(オプション)

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

「DependsOn」機能の詳細については、「アクションの順序付け」を参照してください。

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

Compute

(LambdaInvoke/Compute)

(オプション)

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

対応する UI: なし

Type

(LambdaInvoke/Compute/Type)

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

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

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

アクション実行時の柔軟性を目的として最適化されています。
Lambda (ビジュアルエディタ) または Lambda (YAML エディタ)

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

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

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

Fleet

(LambdaInvoke/Compute/Fleet)

(オプション)

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

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

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

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

Timeout

(LambdaInvoke/Timeout)

(必須)

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

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

Inputs

(LambdaInvoke/Inputs)

(必須)

この Inputs セクションは、ワークフローの実行中にAWS Lambda呼び出しアクションに必要なデータを定義します。

注記

AWS Lambda 呼び出しアクションごとに 1 つの入力 (ソースまたはアーティファクト) のみが許可されます。変数はこの合計にはカウントされません。

対応する UI: [入力] タブ

Sources

(LambdaInvoke/Inputs/Sources)

(RequestPayloadFile が指定されている場合は必須)

リクエストペイロード JSON ファイルを AWS Lambda呼び出しアクションに渡したい場合で、このペイロードファイルがソースリポジトリに格納されている場合は、そのソースリポジトリのラベルを指定します。現在サポートされているラベルは、WorkflowSource のみです。

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

ペイロードの詳細については、「RequestPayloadFile」を参照してください。

注記

ペイロードファイルを指定する代わりに、RequestPayload プロパティを使用してペイロードの JSON コードをアクションに直接追加できます。詳細については、「RequestPayload」を参照してください。

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

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

Artifacts - input

(LambdaInvoke/Inputs/Artifacts)

(RequestPayloadFile が指定されている場合は必須)

リクエストペイロード JSON ファイルをAWS Lambda呼び出しアクションに渡したい場合で、このペイロードファイルが前のアクションの出力アーティファクトに含まれている場合は、ここでそのアーティファクトを指定します。

ペイロードの詳細については、「RequestPayloadFile」を参照してください。

注記

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

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

Variables - input

(LambdaInvoke/Inputs/Variables)

(オプション)

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

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

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

Environment

(LambdaInvoke/Environment)

(必須)

アクションで使用する CodeCatalyst 環境を指定します。アクションは、選択した環境で指定された AWS アカウントおよび任意の Amazon VPC に接続します。このアクションは、環境で指定されたデフォルトの IAM ロールを使用して AWS アカウントに接続し、[Amazon VPC 接続] で指定された IAM ロールを使用して Amazon VPC に接続します。

注記

デフォルトの IAM ロールにアクションに必要なアクセス許可がない場合は、別のロールを使用するようにアクションを設定できます。詳細については、「アクションの IAM ロールの変更」を参照してください。

環境タグ付けの詳細については、「AWS アカウントと VPCsへのデプロイ」と「環境を作成する」を参照してください。

対応する UI: [設定] タブ/[環境]

Name

(LambdaInvoke/Environment/Name)

(Environment が含まれている場合は必須)

アクションに関連付ける既存の環境の名前を指定します。

対応する UI: [設定] タブ/[環境]

Connections

(LambdaInvoke/Environment/Connections)

(新しいバージョンのアクションではオプション。古いバージョンでは必須)

アクションに関連付けるアカウント接続を指定します。Environment で最大 1 つのアカウント接続を指定できます。

アカウント接続を指定しない場合:

このアクションは、CodeCatalyst コンソールの環境で指定された AWS アカウント接続とデフォルトの IAM ロールを使用します。アカウント接続とデフォルトの IAM ロールを環境に追加する方法については、「環境を作成する」を参照してください。
デフォルトの IAM ロールには、アクションに必要なポリシーとアクセス許可が含まれている必要があります。これらのポリシーとアクセス許可を確認するには、アクションの YAML 定義ドキュメントの Role プロパティの説明を参照してください。

アカウント接続の詳細については、「接続された AWS リソースへのアクセスを許可する AWS アカウント」を参照してください。アカウント接続を環境に追加する方法については、「環境を作成する」を参照してください。

対応する UI: アクションのバージョンに応じて、次のいずれか。

(新しいバージョン) [設定] タブ/[環境]/[my-environment の内容]/3 つのドットメニュー/[ロールを切り替える]
(旧バージョン) [設定] タブ/「環境/アカウント/ロール」/[AWS アカウント接続]

Name

(LambdaInvoke/Environment/Connections/Name)

(Connections が含まれている場合は必須)

アカウント接続の名前を指定します。

対応する UI: アクションのバージョンに応じて、次のいずれか。

(新しいバージョン) [設定] タブ/[環境]/[my-environment の内容]/3 つのドットメニュー/[ロールを切り替える]
(旧バージョン) [設定] タブ/「環境/アカウント/ロール」/[AWS アカウント接続]

Role

(LambdaInvoke/Environment/Connections/Role)

(Connections が含まれている場合は必須)

AWS Lambda 呼び出しアクションが AWS へのアクセスと Lambda 関数の呼び出しに使用する IAM ロールの名前を指定します。ロールを CodeCatalyst スペースに追加し、ロールに次のポリシーが含まれていることを確認します。

IAM ロールを指定しない場合、アクションは CodeCatalyst コンソールの [環境] に記載されているデフォルトの IAM ロールを使用します。環境でデフォルトのロールを使用する場合は、次のポリシーが設定されていることを確認してください。

以下のアクセス許可ポリシー:

警告

アクセス許可は、次のポリシーに示すアクセス許可に制限します。範囲の広いアクセス許可を持つロールを使用すると、セキュリティリスクが発生する可能性があります。


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": "lambda:InvokeFunction",
            "Resource": "arn:aws:lambda:aws-region:aws-account:function:function-name"
        }
    ]
}

次のカスタム信頼ポリシー:


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service":  [
                   "codecatalyst-runner.amazonaws.com",
                   "codecatalyst.amazonaws.com"
                 ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

注記

必要に応じて、このアクションで CodeCatalystWorkflowDevelopmentRole-spaceName ロールを使用できます。このロールの詳細については、「アカウントとスペース用の CodeCatalystWorkflowDevelopmentRole-spaceName ロールを作成する」を参照してください。CodeCatalystWorkflowDevelopmentRole-spaceName ロールにはフルアクセス許可があり、セキュリティ上のリスクをもたらす可能性があることを理解してください。このロールは、セキュリティが懸念されないチュートリアルやシナリオでのみ使用することをお勧めします。

対応する UI: アクションのバージョンに応じて、次のいずれか。

(新しいバージョン) [設定] タブ/[環境]/[my-environment の内容]/3 つのドットメニュー/[ロールを切り替える]
(旧バージョン) [設定] タブ/「環境/アカウント/ロール」/[ロール]

Configuration

(LambdaInvoke/Configuration)

(必須)

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

対応する UI: [設定] タブ

Function

(LambdaInvoke/Configuration/Function)

(必須)

このアクションが呼び出す AWS Lambda 関数を指定します。関数名または Amazon リソースネーム (ARN) を指定できます。関数名または ARN は、Lambda コンソールで確認できます。

注記

Lambda 関数が存在する AWS アカウントは、Connections: で指定されたアカウントとは異なる場合があります。

対応する UI: [設定] タブ/[関数]

AWSRegion

(LambdaInvoke/Configuration/AWSRegion)

(必須)

AWS Lambda 関数が存在する AWS リージョンを指定します。リージョンコードの一覧については、「AWS 全般のリファレンス」の「Regional endpoints」を参照してください。

対応する UI: [設定] タブ/[送信先バケット - オプション]

RequestPayload

(LambdaInvoke/Configuration/RequestPayload)

(オプション)

リクエストペイロードを AWS Lambda 呼び出しアクションに渡す場合は、JSON 形式でリクエストペイロードをここで指定します。

リクエストペイロードの例:


'{ "key": "value" }'

Lambda 関数にリクエストペイロードを渡さない場合は、このプロパティを省略します。

注記

RequestPayload または RequestPayloadFile を指定できます。両方を指定することはできません。

リクエストペイロードの詳細については、「AWS Lambda API リファレンス」の「Invoke」トピックを参照してください。

対応する UI: [設定] タブ/[リクエストペイロード - オプション]

RequestPayloadFile

(LambdaInvoke/Configuration/RequestPayloadFile)

(オプション)

リクエストペイロードを AWS Lambda 呼び出しアクションに渡す場合は、ここでこのリクエストペイロードファイルのパスを指定します。ファイルは JSON 形式である必要があります。

リクエストペイロードファイルは、ソースリポジトリまたは前のアクションのアーティファクトに置くことができます。ファイルパスは、ソースリポジトリまたはアーティファクトのルートを基準としています。

Lambda 関数にリクエストペイロードを渡さない場合は、このプロパティを省略します。

注記

RequestPayload または RequestPayloadFile を指定できます。両方を指定することはできません。

リクエストペイロードファイルの詳細については、「AWS Lambda API リファレンス」の「Invoke」トピックを参照してください。

対応する UI: [設定] タブ/[リクエストペイロードファイル - オプション]

ContinueOnError

(LambdaInvoke/Configuration/RequestPayloadFile)

(オプション)

呼び出した AWS Lambda 関数が失敗した場合でも、AWS Lambda 呼び出しアクションを成功としてマークするかどうかを指定します。Lambda が失敗したにもかかわらず、ワークフロー内の後続のアクションを開始できるように、このプロパティを true に設定することを検討してください。

デフォルトでは、Lambda 関数が失敗した場合、アクションは失敗します (ビジュアルエディタでは「off」、YAML エディタでは「false」)。

対応する UI: [設定] タブ/[エラー発生時に続行]

LogType

(LambdaInvoke/Configuration/LogType)

(オプション)

呼び出し後に Lambda 関数からのレスポンスにエラーログを含めるかどうかを指定します。このログは、CodeCatalyst コンソールの Lambda 呼び出しアクションの [ログ] タブで表示できます。可能な値は以下のとおりです。

Tail – ログを返す
None – ログを返さない

デフォルトでは [Tail] に設定されています。

ログタイプの詳細については、「AWS Lambda API リファレンス」の「Invoke」トピックを参照してください。

ログの表示の詳細については、「ワークフロー実行のステータスと詳細の表示」を参照してください。

対応する UI: [設定] タブ/[ログタイプ]

ResponseFilters

(LambdaInvoke/Configuration/ResponseFilters)

(オプション)

Lambda レスポンスペイロードのどのキーを出力変数に変換するかを指定します。その後、ワークフロー内の後続のアクションで出力変数を参照できます。CodeCatalyst における変数の詳細については、「ワークフローでの変数の使用」を参照してください。

例えば、レスポンスペイロードが次のような場合:


responsePayload = {
  "name": "Saanvi",
  "location": "Seattle",
  "department": {
    "company": "Amazon",
    "team": "AWS"
  }
}

...そして、レスポンスフィルターは次のような場合:


Configuration:
  ...
  ResponseFilters: '{"name": ".name", "company": ".department.company"}'

...アクションは次の出力変数を生成します。

キー	値
name	Saanvi
company	Amazon

その後、後続のアクションで name 変数と company 変数を参照できます。

ResponseFilters でキーを指定しない場合、アクションは Lambda レスポンスの各最上位キーを出力変数に変換します。詳細については、「「AWS Lambda 呼び出し」変数」を参照してください。

レスポンスフィルターを使用して、生成された出力変数を実際に使用するもののみに制限することを検討してください。

対応する UI: [設定] タブ/[レスポンスフィルター - オプション]

Outputs

(LambdaInvoke/Outputs)

(オプション)

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

対応する UI: [出力] タブ

Artifacts

(LambdaInvoke/Outputs/Artifacts)

(オプション)

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

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

対応する UI: [出力] タブ/[アーティファクト]/[ビルドアーティファクト名]

Name

(LambdaInvoke/Outputs/Artifacts/Name)

(オプション)

Lambda 関数によって返される Lambda レスポンスペイロードを含むアーティファクトの名前を指定します。デフォルト値は lambda_artifacts です。アーティファクトを指定しない場合、Lambda レスポンスペイロードをアクションのログで表示できます。これは、CodeCatalyst コンソールのアクションの [ログ] タブにあります。ログの表示の詳細については、「ワークフロー実行のステータスと詳細の表示」を参照してください。

対応する UI: [出力] タブ/[アーティファクト]/[ビルドアーティファクト名]

Files

(LambdaInvoke/Outputs/Artifacts/Files)

(オプション)

アーティファクトに含めるファイルを指定します。Lambda レスポンスペイロードファイルを含めるように lambda-response.json を指定する必要があります。

対応する UI: [出力] タブ/[アーティファクト]/[ビルドで生成されるファイル]

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

変数 -AWS Lambda 「呼び出し」

Amazon ECS タスク定義の変更

このページの内容

Cookie の設定を選択する

「AWS Lambda 呼び出し」アクション YAML

注記

LambdaInvoke

Identifier

DependsOn

Compute

Type

Fleet

Timeout

Inputs

注記

Sources

注記

Artifacts - input

注記

Variables - input

Environment

注記

Name

Connections

Name

Role

警告

注記

Configuration

Function

注記

AWSRegion

RequestPayload

注記

RequestPayloadFile

注記

ContinueOnError

LogType

ResponseFilters

Outputs

Artifacts

Name

Files

このページの内容

このページは役に立ちましたか?

次のトピック

前のトピック:

ヘルプが必要ですか?