Class: AWSCDK::StepFunctionsTasks::SNSPublishJsonPathProps

Inherits:
AWSCDK::StepFunctions::TaskStateJsonPathBaseProps
  • Object
show all
Defined in:
step_functions_tasks/sns_publish_json_path_props.rb

Overview

Properties for publishing a message to an SNS topic using JSONPath.

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, input_path: nil, output_path: nil, result_path: nil, result_selector: nil, message:, topic:, message_attributes: nil, message_deduplication_id: nil, message_group_id: nil, message_per_subscription_type: nil, subject: nil) ⇒ SNSPublishJsonPathProps

Returns a new instance of SNSPublishJsonPathProps.

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.

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

    JSONPath expression to select part of the state to be the input to this state.

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

    JSONPath expression to select part of the state to be the output to this state.

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

    JSONPath expression to indicate where to inject the state's output.

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

    The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

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

    The message you want to send.

  • topic (AWSCDK::SNS::ITopic) —

    The SNS topic that the task will publish to.

  • message_attributes (Hash{String => AWSCDK::StepFunctionsTasks::MessageAttribute}, nil) (defaults to: nil) —

    Add message attributes when publishing.

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

    This parameter applies only to FIFO topics.

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

    This parameter applies only to FIFO topics.

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

    Send different messages for each transport protocol.

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

    Used as the "Subject" line when the message is delivered to email endpoints.



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
69
70
71
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 28

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, input_path: nil, output_path: nil, result_path: nil, result_selector: nil, message:, topic:, message_attributes: nil, message_deduplication_id: nil, message_group_id: nil, message_per_subscription_type: nil, subject: 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?
  @input_path = input_path
  Jsii::Type.check_type(@input_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputPath") unless @input_path.nil?
  @output_path = output_path
  Jsii::Type.check_type(@output_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputPath") unless @output_path.nil?
  @result_path = result_path
  Jsii::Type.check_type(@result_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resultPath") unless @result_path.nil?
  @result_selector = result_selector
  Jsii::Type.check_type(@result_selector, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "resultSelector") unless @result_selector.nil?
  @message = message
  Jsii::Type.check_type(@message, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "message")
  @topic = topic
  Jsii::Type.check_type(@topic, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc25zLklUb3BpYyJ9")), "topic")
  @message_attributes = message_attributes.is_a?(Hash) ? message_attributes.transform_values { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::MessageAttribute.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : message_attributes
  Jsii::Type.check_type(@message_attributes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLk1lc3NhZ2VBdHRyaWJ1dGUifSwia2luZCI6Im1hcCJ9fQ==")), "messageAttributes") unless @message_attributes.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?
  @message_per_subscription_type = message_per_subscription_type
  Jsii::Type.check_type(@message_per_subscription_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "messagePerSubscriptionType") unless @message_per_subscription_type.nil?
  @subject = subject
  Jsii::Type.check_type(@subject, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subject") unless @subject.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:



144
145
146
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 144

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


77
78
79
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 77

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:



98
99
100
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 98

def credentials
  @credentials
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



104
105
106
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 104

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:



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

def heartbeat_timeout
  @heartbeat_timeout
end

#input_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

  • (String, nil) 


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

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



122
123
124
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 122

def integration_pattern
  @integration_pattern
end

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

The message you want to send.

With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size. For SMS, each message can contain up to 140 characters.

Returns:



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

def message
  @message
end

#message_attributes ⇒ Hash{String => AWSCDK::StepFunctionsTasks::MessageAttribute}? (readonly)

Note:

Default: {}

Add message attributes when publishing.

These attributes carry additional metadata about the message and may be used for subscription filters.

Returns:

See Also:



198
199
200
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 198

def message_attributes
  @message_attributes
end

#message_deduplication_id ⇒ String? (readonly)

Note:

Default: - Not used for standard topics, required for FIFO topics with ContentBasedDeduplication disabled.

This parameter applies only to FIFO topics.

Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.

If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.

Returns:

  • (String, nil) 


210
211
212
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 210

def message_deduplication_id
  @message_deduplication_id
end

#message_group_id ⇒ String? (readonly)

Note:

Default: - Not used for standard topics, required for FIFO topics.

This parameter applies only to FIFO topics.

The MessageGroupId is a 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 (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.

Returns:

  • (String, nil) 


220
221
222
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 220

def message_group_id
  @message_group_id
end

#message_per_subscription_type ⇒ Boolean? (readonly)

Note:

Default: false

Send different messages for each transport protocol.

For example, you might want to send a shorter message to SMS subscribers and a more verbose message to email and SQS subscribers.

Your message must be a JSON object with a top-level JSON key of "default" with a value that is a string You can define other top-level keys that define the message you want to send to a specific transport protocol (i.e. "sqs", "email", "http", etc)

Returns:

  • (Boolean, nil)

See Also:



234
235
236
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 234

def message_per_subscription_type
  @message_per_subscription_type
end

#output_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

  • (String, nil) 


160
161
162
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 160

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



85
86
87
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 85

def query_language
  @query_language
end

#result_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

  • (String, nil) 


168
169
170
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 168

def result_path
  @result_path
end

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

Note:

Default: - None

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

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

See Also:



177
178
179
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 177

def result_selector
  @result_selector
end

#state_name ⇒ String? (readonly)

Note:

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

Optional name for this state.

Returns:

  • (String, nil) 


90
91
92
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 90

def state_name
  @state_name
end

#subject ⇒ String? (readonly)

Note:

Default: - No subject

Used as the "Subject" line when the message is delivered to email endpoints.

This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

Returns:

  • (String, nil) 


242
243
244
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 242

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



130
131
132
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 130

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



136
137
138
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 136

def timeout
  @timeout
end

#topic ⇒ AWSCDK::SNS::ITopic (readonly)

The SNS topic that the task will publish to.

Returns:



189
190
191
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 189

def topic
  @topic
end

Class Method Details

.jsii_properties ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 244

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",
    :input_path => "inputPath",
    :output_path => "outputPath",
    :result_path => "resultPath",
    :result_selector => "resultSelector",
    :message => "message",
    :topic => "topic",
    :message_attributes => "messageAttributes",
    :message_deduplication_id => "messageDeduplicationId",
    :message_group_id => "messageGroupId",
    :message_per_subscription_type => "messagePerSubscriptionType",
    :subject => "subject",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'step_functions_tasks/sns_publish_json_path_props.rb', line 270

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,
    "inputPath" => @input_path,
    "outputPath" => @output_path,
    "resultPath" => @result_path,
    "resultSelector" => @result_selector,
    "message" => @message,
    "topic" => @topic,
    "messageAttributes" => @message_attributes,
    "messageDeduplicationId" => @message_deduplication_id,
    "messageGroupId" => @message_group_id,
    "messagePerSubscriptionType" => @message_per_subscription_type,
    "subject" => @subject,
  })
  result.compact
end