Class TaskRole
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.stepfunctions.TaskRole
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-27T16:51:05.973Z")
@Stability(Stable)
public abstract class TaskRole
extends software.amazon.jsii.JsiiObject
Role to be assumed by the State Machine's execution role for invoking a task's resource.
Example:
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();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic TaskRole
Construct a task role based on the provided IAM Role.static TaskRole
fromRoleArnJsonPath
(String expression) Construct a task role retrieved from task inputs using a json expression.abstract String
Retrieves the resource for use in IAM Policies for this TaskRole.abstract String
Retrieves the roleArn for this TaskRole.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
TaskRole
protected TaskRole(software.amazon.jsii.JsiiObjectRef objRef) -
TaskRole
protected TaskRole(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
TaskRole
@Stability(Stable) protected TaskRole()
-
-
Method Details
-
fromRole
Construct a task role based on the provided IAM Role.- Parameters:
role
- IAM Role. This parameter is required.
-
fromRoleArnJsonPath
Construct a task role retrieved from task inputs using a json expression.Example:
TaskRole.fromRoleArnJsonPath("$.RoleArn");
- Parameters:
expression
- json expression to roleArn. This parameter is required.
-
getResource
Retrieves the resource for use in IAM Policies for this TaskRole. -
getRoleArn
Retrieves the roleArn for this TaskRole.
-