Class: AWSCDK::StepFunctionsTasks::SQSSendMessageJsonataProps

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

Overview

Properties for sending a message to an SQS queue using JSONata.

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, message_body:, queue:, delay: nil, message_deduplication_id: nil, message_group_id: nil) ⇒ SQSSendMessageJsonataProps

Returns a new instance of SQSSendMessageJsonataProps.

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.

  • message_body (AWSCDK::StepFunctions::TaskInput) —

    The text message to send to the queue.

  • queue (AWSCDK::SQS::IQueue) —

    The SQS queue that messages will be sent to.

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

    The length of time, for which to delay a message.

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

    The token used for deduplication of sent messages.

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

    The tag that specifies that a message belongs to a specific message group.



23
24
25
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
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 23

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, message_body:, queue:, delay: nil, message_deduplication_id: nil, message_group_id: 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?
  @message_body = message_body
  Jsii::Type.check_type(@message_body, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "messageBody")
  @queue = queue
  Jsii::Type.check_type(@queue, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3FzLklRdWV1ZSJ9")), "queue")
  @delay = delay
  Jsii::Type.check_type(@delay, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "delay") unless @delay.nil?
  @message_deduplication_id = message_deduplication_id
  Jsii::Type.check_type(@message_deduplication_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "messageDeduplicationId") unless @message_deduplication_id.nil?
  @message_group_id = message_group_id
  Jsii::Type.check_type(@message_group_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "messageGroupId") unless @message_group_id.nil?
end

Instance Attribute Details

#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:



129
130
131
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 129

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


62
63
64
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 62

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:



83
84
85
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 83

def credentials
  @credentials
end

#delay ⇒ AWSCDK::Duration? (readonly)

Note:

Default: - delay set on the queue. If a delay is not set on the queue, messages are sent immediately (0 seconds).

The length of time, for which to delay a message.

Messages that you send to the queue remain invisible to consumers for the duration of the delay period. The maximum allowed delay is 15 minutes.

Returns:



157
158
159
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 157

def delay
  @delay
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



89
90
91
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 89

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:



97
98
99
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 97

def heartbeat_timeout
  @heartbeat_timeout
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:



107
108
109
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 107

def integration_pattern
  @integration_pattern
end

#message_body ⇒ AWSCDK::StepFunctions::TaskInput (readonly)

The text message to send to the queue.

Returns:



145
146
147
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 145

def message_body
  @message_body
end

#message_deduplication_id ⇒ String? (readonly)

Note:

Default: - None

The token used for deduplication of sent messages.

Any messages sent with the same deduplication ID are accepted successfully, but aren't delivered during the 5-minute deduplication interval.

Returns:

  • (String, nil) 


165
166
167
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 165

def message_deduplication_id
  @message_deduplication_id
end

#message_group_id ⇒ String? (readonly)

Note:

Default: - None

The tag that specifies that a message belongs to a specific message group.

Messages that belong to the same message group are processed in a FIFO manner. Messages in different message groups might be processed out of order.

Returns:

  • (String, nil) 


173
174
175
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 173

def message_group_id
  @message_group_id
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:



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

def outputs
  @outputs
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:



70
71
72
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 70

def query_language
  @query_language
end

#queue ⇒ AWSCDK::SQS::IQueue (readonly)

The SQS queue that messages will be sent to.

Returns:



149
150
151
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 149

def queue
  @queue
end

#state_name ⇒ String? (readonly)

Note:

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

Optional name for this state.

Returns:

  • (String, nil) 


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

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:



115
116
117
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 115

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



121
122
123
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 121

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 175

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",
    :message_body => "messageBody",
    :queue => "queue",
    :delay => "delay",
    :message_deduplication_id => "messageDeduplicationId",
    :message_group_id => "messageGroupId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'step_functions_tasks/sqs_send_message_jsonata_props.rb', line 196

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,
    "messageBody" => @message_body,
    "queue" => @queue,
    "delay" => @delay,
    "messageDeduplicationId" => @message_deduplication_id,
    "messageGroupId" => @message_group_id,
  })
  result.compact
end