aws-cdk-lib.aws_stepfunctions.Credentials

Credentials Struct

Specifies a target role assumed by the State Machine's execution role for invoking the task's resource.

Source

aws-stepfunctions/lib/task-credentials.ts

Type last changed

v2.54.0 · 7 Dec 2022

Example

import * as lambda from 'aws-cdk-lib/aws-lambda';

declare const submitLambda: lambda.Function;
declare const iamRole: iam.Role;

// use a fixed role for all task invocations
const role = sfn.TaskRole.fromRole(iamRole);
// or use a json expression to resolve the role at runtime based on task inputs
//const role = sfn.TaskRole.fromRoleArnJsonPath('$.RoleArn');

const submitJob = new tasks.LambdaInvoke(this, 'Submit Job', {
  lambdaFunction: submitLambda,
  outputPath: '$.Payload',
  // use credentials
  credentials: { role },
});

Properties

roleTaskRoleroleTaskRoleroleTaskRoleRoleTaskRoleRoleTaskRolerequired#

The role to be assumed for executing the Task.