Package software.amazon.awscdk.services.stepfunctions

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-13T21:17:41.846Z") @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();

See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    TaskRole()
     
    protected
    TaskRole(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    TaskRole(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static TaskRole
    fromRole(IRole role)
    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
    getResource()
    Retrieves the resource for use in IAM Policies for this TaskRole.
    abstract String
    getRoleArn()
    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

      @Stability(Stable) @NotNull public static TaskRole fromRole(@NotNull IRole role)
      Construct a task role based on the provided IAM Role.

      Parameters:
      role - IAM Role. This parameter is required.

    • fromRoleArnJsonPath

      @Stability(Stable) @NotNull public static TaskRole fromRoleArnJsonPath(@NotNull String expression)
      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

      @Stability(Stable) @NotNull public abstract String getResource()
      Retrieves the resource for use in IAM Policies for this TaskRole.

    • getRoleArn

      @Stability(Stable) @NotNull public abstract String getRoleArn()
      Retrieves the roleArn for this TaskRole.