TaskRole Class
Role to be assumed by the State Machine's execution role for invoking a task's resource.
Example
ts
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 },
});
python
import aws_cdk.aws_lambda as lambda_
# submit_lambda: lambda.Function
# iam_role: iam.Role
# use a fixed role for all task invocations
role = sfn.TaskRole.from_role(iam_role)
# or use a json expression to resolve the role at runtime based on task inputs
# const role = sfn.TaskRole.fromRoleArnJsonPath('$.RoleArn');
submit_job = tasks.LambdaInvoke(self, "Submit Job",
lambda_function=submit_lambda,
output_path="$.Payload",
# use credentials
credentials=sfn.Credentials(role=role)
)
java
import software.amazon.awscdk.services.lambda.*;
Function submitLambda;
Role iamRole;
// use a fixed role for all task invocations
TaskRole role = TaskRole.fromRole(iamRole);
// or use a json expression to resolve the role at runtime based on task inputs
//const role = sfn.TaskRole.fromRoleArnJsonPath('$.RoleArn');
LambdaInvoke submitJob = LambdaInvoke.Builder.create(this, "Submit Job")
.lambdaFunction(submitLambda)
.outputPath("$.Payload")
// use credentials
.credentials(Credentials.builder().role(role).build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Lambda;
Function submitLambda;
Role iamRole;
// use a fixed role for all task invocations
var role = TaskRole.FromRole(iamRole);
// or use a json expression to resolve the role at runtime based on task inputs
//const role = sfn.TaskRole.fromRoleArnJsonPath('$.RoleArn');
var submitJob = new LambdaInvoke(this, "Submit Job", new LambdaInvokeProps {
LambdaFunction = submitLambda,
OutputPath = "$.Payload",
// use credentials
Credentials = new Credentials { Role = role }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import lambda "github.com/aws/aws-cdk-go/awscdk"
var submitLambda Function
var iamRole Role
// use a fixed role for all task invocations
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');
submitJob := tasks.NewLambdaInvoke(this, jsii.String("Submit Job"), &LambdaInvokeProps{
LambdaFunction: submitLambda,
OutputPath: jsii.String("$.Payload"),
// use credentials
Credentials: &Credentials{
Role: *Role,
},
})
Initializer
ts
new TaskRole()
python
TaskRole()
java
new TaskRole()
csharp
new TaskRole()
go
NewTaskRole()
Properties
Methods
fromRole(role: IRole): TaskRole // chainable@staticmethod def from_role(role: IRole) -> TaskRolepublic static TaskRole fromRole(IRole role)public static TaskRole FromRole(IRole role)func FromRole(Role IRole) TaskRolestatic#Construct a task role based on the provided IAM Role.
1 parameter
Parameters
roleroleroleroleRole— IAM Role.
fromRoleArnJsonPath(expression: string): TaskRole // chainable@staticmethod def from_role_arn_json_path(expression: str) -> TaskRolepublic static TaskRole fromRoleArnJsonPath(String expression)public static TaskRole FromRoleArnJsonPath(string expression)func FromRoleArnJsonPath(Expression *string) TaskRolestatic#Construct a task role retrieved from task inputs using a json expression.
1 parameter · example
Parameters
expressionexpressionexpressionexpressionExpression— json expression to roleArn.
ts
sfn.TaskRole.fromRoleArnJsonPath('$.RoleArn');