Class: AWSCDK::StepFunctionsTasks::CallAWSServiceJsonataProps

Inherits:
AWSCDK::StepFunctions::TaskStateJsonataBaseProps
  • Object
show all
Defined in:
step_functions_tasks/call_aws_service_jsonata_props.rb

Overview

Properties for calling an AWS service's API action using JSONata from your state machine.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, query_language: nil, state_name: nil, credentials: nil, heartbeat: nil, heartbeat_timeout: nil, integration_pattern: nil, task_timeout: nil, timeout: nil, assign: nil, outputs: nil, action:, iam_resources:, service:, additional_iam_statements: nil, iam_action: nil, parameters: nil) ⇒ CallAWSServiceJsonataProps

Returns a new instance of CallAWSServiceJsonataProps.

Parameters:

  • comment (String, nil) (defaults to: nil) —

    A comment describing this state.

  • query_language (AWSCDK::StepFunctions::QueryLanguage, nil) (defaults to: nil) —

    The name of the query language used by the state.

  • state_name (String, nil) (defaults to: nil) —

    Optional name for this state.

  • credentials (AWSCDK::StepFunctions::Credentials, nil) (defaults to: nil) —

    Credentials for an IAM Role that the State Machine assumes for executing the task.

  • heartbeat (AWSCDK::Duration, nil) (defaults to: nil) —

    Timeout for the heartbeat.

  • heartbeat_timeout (AWSCDK::StepFunctions::Timeout, nil) (defaults to: nil) —

    Timeout for the heartbeat.

  • integration_pattern (AWSCDK::StepFunctions::IntegrationPattern, nil) (defaults to: nil) —

    AWS Step Functions integrates with services directly in the Amazon States Language.

  • task_timeout (AWSCDK::StepFunctions::Timeout, nil) (defaults to: nil) —

    Timeout for the task.

  • timeout (AWSCDK::Duration, nil) (defaults to: nil) —

    Timeout for the task.

  • assign (Hash{String => Object}, nil) (defaults to: nil) —

    Workflow variables to store in this step.

  • outputs (Object, nil) (defaults to: nil) —

    Used to specify and transform output from the state.

  • action (String) —

    The API action to call.

  • iam_resources (Array<String>) —

    The resources for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call.

  • service (String) —

    The AWS service to call.

  • additional_iam_statements (Array<AWSCDK::IAM::PolicyStatement>, nil) (defaults to: nil) —

    Additional IAM statements that will be added to the state machine role's policy.

  • iam_action (String, nil) (defaults to: nil) —

    The action for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call.

  • parameters (Hash{String => Object}, nil) (defaults to: nil) —

    Parameters for the API action call.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 26

def initialize(comment: nil, query_language: nil, state_name: nil, credentials: nil, heartbeat: nil, heartbeat_timeout: nil, integration_pattern: nil, task_timeout: nil, timeout: nil, assign: nil, outputs: nil, action:, iam_resources:, service:, additional_iam_statements: nil, iam_action: nil, parameters: nil)
  @comment = comment
  Jsii::Type.check_type(@comment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comment") unless @comment.nil?
  @query_language = query_language
  Jsii::Type.check_type(@query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "queryLanguage") unless @query_language.nil?
  @state_name = state_name
  Jsii::Type.check_type(@state_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateName") unless @state_name.nil?
  @credentials = credentials.is_a?(Hash) ? ::AWSCDK::StepFunctions::Credentials.new(**credentials.transform_keys(&:to_sym)) : credentials
  Jsii::Type.check_type(@credentials, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5DcmVkZW50aWFscyJ9")), "credentials") unless @credentials.nil?
  @heartbeat = heartbeat
  Jsii::Type.check_type(@heartbeat, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "heartbeat") unless @heartbeat.nil?
  @heartbeat_timeout = heartbeat_timeout
  Jsii::Type.check_type(@heartbeat_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UaW1lb3V0In0=")), "heartbeatTimeout") unless @heartbeat_timeout.nil?
  @integration_pattern = integration_pattern
  Jsii::Type.check_type(@integration_pattern, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5JbnRlZ3JhdGlvblBhdHRlcm4ifQ==")), "integrationPattern") unless @integration_pattern.nil?
  @task_timeout = task_timeout
  Jsii::Type.check_type(@task_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UaW1lb3V0In0=")), "taskTimeout") unless @task_timeout.nil?
  @timeout = timeout
  Jsii::Type.check_type(@timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "timeout") unless @timeout.nil?
  @assign = assign
  Jsii::Type.check_type(@assign, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "assign") unless @assign.nil?
  @outputs = outputs
  Jsii::Type.check_type(@outputs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "outputs") unless @outputs.nil?
  @action = action
  Jsii::Type.check_type(@action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "action")
  @iam_resources = iam_resources
  Jsii::Type.check_type(@iam_resources, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "iamResources")
  @service = service
  Jsii::Type.check_type(@service, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "service")
  @additional_iam_statements = additional_iam_statements
  Jsii::Type.check_type(@additional_iam_statements, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pYW0uUG9saWN5U3RhdGVtZW50In0sImtpbmQiOiJhcnJheSJ9fQ==")), "additionalIamStatements") unless @additional_iam_statements.nil?
  @iam_action = iam_action
  Jsii::Type.check_type(@iam_action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iamAction") unless @iam_action.nil?
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "parameters") unless @parameters.nil?
end

Instance Attribute Details

#action ⇒ String (readonly)

The API action to call.

Use camelCase.

Returns:

  • (String) 


152
153
154
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 152

def action
  @action
end

#additional_iam_statements ⇒ Array<AWSCDK::IAM::PolicyStatement>? (readonly)

Note:

Default: - no additional statements are added

Additional IAM statements that will be added to the state machine role's policy.

Use in the case where the call requires more than a single statement to be executed, e.g. rekognition:detectLabels requires also S3 permissions to read the object on which it must act.

Returns:



172
173
174
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 172

def additional_iam_statements
  @additional_iam_statements
end

#assign ⇒ Hash{String => Object}? (readonly)

Note:

Default: - Not assign variables

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

  • (Hash{String => Object}, nil)

See Also:



134
135
136
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 134

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


67
68
69
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 67

def comment
  @comment
end

#credentials ⇒ AWSCDK::StepFunctions::Credentials? (readonly)

Note:

Default: - None (Task is executed using the State Machine's execution role)

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

Returns:

See Also:



88
89
90
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 88

def credentials
  @credentials
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



94
95
96
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 94

def heartbeat
  @heartbeat
end

#heartbeat_timeout ⇒ AWSCDK::StepFunctions::Timeout? (readonly)

Note:

Default: - None

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:



102
103
104
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 102

def heartbeat_timeout
  @heartbeat_timeout
end

#iam_action ⇒ String? (readonly)

Note:

Default: - service:action

The action for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call.

Use in the case where the IAM action name does not match with the API service/action name, e.g. s3:ListBuckets requires s3:ListAllMyBuckets.

Returns:

  • (String, nil) 


180
181
182
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 180

def iam_action
  @iam_action
end

#iam_resources ⇒ Array<String> (readonly)

The resources for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call.

By default the action for this IAM statement will be service:action.

Returns:

  • (Array<String>) 


158
159
160
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 158

def iam_resources
  @iam_resources
end

#integration_pattern ⇒ AWSCDK::StepFunctions::IntegrationPattern? (readonly)

Note:

Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

See Also:



112
113
114
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 112

def integration_pattern
  @integration_pattern
end

#outputs ⇒ Object? (readonly)

Note:

Default: - $states.result or $states.errorOutput

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by % characters. Output also accepts a JSONata expression directly.

Returns:

  • (Object, nil)

See Also:



146
147
148
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 146

def outputs
  @outputs
end

#parameters ⇒ Hash{String => Object}? (readonly)

Note:

Default: - no parameters

Parameters for the API action call.

Use PascalCase for the parameter names.

Returns:

  • (Hash{String => Object}, nil) 


187
188
189
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 187

def parameters
  @parameters
end

#query_language ⇒ AWSCDK::StepFunctions::QueryLanguage? (readonly)

Note:

Default: - JSONPath

The name of the query language used by the state.

If the state does not contain a query_language field, then it will use the query language specified in the top-level query_language field.

Returns:



75
76
77
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 75

def query_language
  @query_language
end

#service ⇒ String (readonly)

The AWS service to call.

Returns:

  • (String)

See Also:



163
164
165
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 163

def service
  @service
end

#state_name ⇒ String? (readonly)

Note:

Default: - The construct ID will be used as state name

Optional name for this state.

Returns:

  • (String, nil) 


80
81
82
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 80

def state_name
  @state_name
end

#task_timeout ⇒ AWSCDK::StepFunctions::Timeout? (readonly)

Note:

Default: - None

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:



120
121
122
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 120

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



126
127
128
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 126

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 189

def self.jsii_properties
  {
    :comment => "comment",
    :query_language => "queryLanguage",
    :state_name => "stateName",
    :credentials => "credentials",
    :heartbeat => "heartbeat",
    :heartbeat_timeout => "heartbeatTimeout",
    :integration_pattern => "integrationPattern",
    :task_timeout => "taskTimeout",
    :timeout => "timeout",
    :assign => "assign",
    :outputs => "outputs",
    :action => "action",
    :iam_resources => "iamResources",
    :service => "service",
    :additional_iam_statements => "additionalIamStatements",
    :iam_action => "iamAction",
    :parameters => "parameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'step_functions_tasks/call_aws_service_jsonata_props.rb', line 211

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "comment" => @comment,
    "queryLanguage" => @query_language,
    "stateName" => @state_name,
    "credentials" => @credentials,
    "heartbeat" => @heartbeat,
    "heartbeatTimeout" => @heartbeat_timeout,
    "integrationPattern" => @integration_pattern,
    "taskTimeout" => @task_timeout,
    "timeout" => @timeout,
    "assign" => @assign,
    "outputs" => @outputs,
    "action" => @action,
    "iamResources" => @iam_resources,
    "service" => @service,
    "additionalIamStatements" => @additional_iam_statements,
    "iamAction" => @iam_action,
    "parameters" => @parameters,
  })
  result.compact
end