Class: AWSCDK::StepFunctions::TaskRole

Inherits:
Jsii::Object
  • Object
show all
Defined in:
step_functions/task_role.rb

Overview

Role to be assumed by the State Machine's execution role for invoking a task's resource.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ TaskRole

Returns a new instance of TaskRole.



10
11
12
 
# File 'step_functions/task_role.rb', line 10

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.from_role(role) ⇒ AWSCDK::StepFunctions::TaskRole

Construct a task role based on the provided IAM Role.

Parameters:

Returns:

  • (AWSCDK::StepFunctions::TaskRole) 


25
26
27
28
 
# File 'step_functions/task_role.rb', line 25

def self.from_role(role)
  Jsii::Type.check_type(role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.TaskRole", "fromRole", [role])
end

.from_role_arn_json_path(expression) ⇒ AWSCDK::StepFunctions::TaskRole

Construct a task role retrieved from task inputs using a json expression.

Examples:

AWSCDK::StepFunctions::TaskRole.from_role_arn_json_path("$.RoleArn")

Parameters:

  • expression (String) —

    json expression to roleArn.

Returns:

  • (AWSCDK::StepFunctions::TaskRole) 


36
37
38
39
 
# File 'step_functions/task_role.rb', line 36

def self.from_role_arn_json_path(expression)
  Jsii::Type.check_type(expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "expression")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.TaskRole", "fromRoleArnJsonPath", [expression])
end

.jsii_overridable_methods ⇒ Object 



14
15
16
17
18
19
 
# File 'step_functions/task_role.rb', line 14

def self.jsii_overridable_methods
  {
    :resource => { kind: :property, name: "resource", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
  }
end

Instance Method Details

#resource ⇒ String

Retrieves the resource for use in IAM Policies for this TaskRole.

Returns:

  • (String) 


44
45
46
 
# File 'step_functions/task_role.rb', line 44

def resource()
  jsii_get_property("resource")
end

#role_arn ⇒ String

Retrieves the roleArn for this TaskRole.

Returns:

  • (String) 


51
52
53
 
# File 'step_functions/task_role.rb', line 51

def role_arn()
  jsii_get_property("roleArn")
end