Class: AWSCDK::StepFunctionsTasks::CallAWSServiceCrossRegionJsonataProps

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

Overview

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

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:, region:, service:, additional_iam_statements: nil, endpoint: nil, iam_action: nil, parameters: nil, retry_on_service_exceptions: nil) ⇒ CallAWSServiceCrossRegionJsonataProps

Returns a new instance of CallAWSServiceCrossRegionJsonataProps.

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 Lambda function role's policy to allow the state machine to make the API call.

  • region (String) —

    The AWS region to call this AWS API for.

  • service (String) —

    The AWS service to call in AWS SDK for JavaScript v3 format.

  • 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.

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

    The AWS API endpoint.

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

    The action for the IAM statement that will be added to the Lambda function 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 in AWS SDK for JavaScript v3 format.

  • retry_on_service_exceptions (Boolean, nil) (defaults to: nil) —

    Whether to retry on the backend Lambda service exceptions.



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
62
63
64
65
66
67
68
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 27

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:, region:, service:, additional_iam_statements: nil, endpoint: nil, iam_action: nil, parameters: nil, retry_on_service_exceptions: 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")
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region")
  @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?
  @endpoint = endpoint
  Jsii::Type.check_type(@endpoint, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpoint") unless @endpoint.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?
  @retry_on_service_exceptions = retry_on_service_exceptions
  Jsii::Type.check_type(@retry_on_service_exceptions, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "retryOnServiceExceptions") unless @retry_on_service_exceptions.nil?
end

Instance Attribute Details

#action ⇒ String (readonly)

The API action to call.

Use camelCase.

Returns:

  • (String) 


159
160
161
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 159

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:



185
186
187
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 185

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:



141
142
143
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 141

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


74
75
76
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 74

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:



95
96
97
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 95

def credentials
  @credentials
end

#endpoint ⇒ String? (readonly)

Note:

Default: Do not override API endpoint.

The AWS API endpoint.

Be aware that if you set this to a value from the Step Functions state (e.g. sfn.JsonPath.stringAt('$.endpoint')), the endpoint is controlled at runtime by whoever can start the state machine execution. This could allow them to redirect the authenticated AWS API call to a server they control, allowing them to intercept and replay that specific API call.

Returns:

  • (String, nil) 


196
197
198
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 196

def endpoint
  @endpoint
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



101
102
103
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 101

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:



109
110
111
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 109

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 Lambda function 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.

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) 


206
207
208
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 206

def iam_action
  @iam_action
end

#iam_resources ⇒ Array<String> (readonly)

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

Returns:

  • (Array<String>) 


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

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:



119
120
121
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 119

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:



153
154
155
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 153

def outputs
  @outputs
end

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

Note:

Default: - no parameters

Parameters for the API action call in AWS SDK for JavaScript v3 format.

Returns:

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


211
212
213
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 211

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:



82
83
84
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 82

def query_language
  @query_language
end

#region ⇒ String (readonly)

The AWS region to call this AWS API for.

Examples:

"us-east-1"

Returns:

  • (String) 


169
170
171
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 169

def region
  @region
end

#retry_on_service_exceptions ⇒ Boolean? (readonly)

Note:

Default: true

Whether to retry on the backend Lambda service exceptions.

This handles Lambda.ServiceException, Lambda.AWSLambdaException, Lambda.SdkClientException, and Lambda.ClientExecutionTimeoutException with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts.

Returns:

  • (Boolean, nil)

See Also:



222
223
224
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 222

def retry_on_service_exceptions
  @retry_on_service_exceptions
end

#service ⇒ String (readonly)

The AWS service to call in AWS SDK for JavaScript v3 format.

Examples:

"s3"

Returns:

  • (String)

See Also:



176
177
178
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 176

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) 


87
88
89
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 87

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:



127
128
129
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 127

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



133
134
135
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 133

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 224

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",
    :region => "region",
    :service => "service",
    :additional_iam_statements => "additionalIamStatements",
    :endpoint => "endpoint",
    :iam_action => "iamAction",
    :parameters => "parameters",
    :retry_on_service_exceptions => "retryOnServiceExceptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'step_functions_tasks/call_aws_service_cross_region_jsonata_props.rb', line 249

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,
    "region" => @region,
    "service" => @service,
    "additionalIamStatements" => @additional_iam_statements,
    "endpoint" => @endpoint,
    "iamAction" => @iam_action,
    "parameters" => @parameters,
    "retryOnServiceExceptions" => @retry_on_service_exceptions,
  })
  result.compact
end