Class SnsPublishProps.Jsii$Proxy
- All Implemented Interfaces:
SnsPublishProps
,TaskStateBaseProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- SnsPublishProps
SnsPublishProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.SnsPublishProps
SnsPublishProps.Builder, SnsPublishProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(SnsPublishProps.Builder builder) Constructor that initializes the object based on literal property values passed by theSnsPublishProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final String
An optional description for this state.final Duration
Timeout for the heartbeat.final String
JSONPath expression to select part of the state to be the input to this state.final IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.final TaskInput
The message you want to send.final Map<String,
MessageAttribute> Add message attributes when publishing.final Boolean
Send different messages for each transport protocol.final String
JSONPath expression to select select a portion of the state output to pass to the next state.final String
JSONPath expression to indicate where to inject the state's output.The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.final String
Used as the "Subject" line when the message is delivered to email endpoints.final Duration
Timeout for the state machine.final ITopic
getTopic()
The SNS topic that the task will publish to.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theSnsPublishProps.Builder
.
-
-
Method Details
-
getMessage
Description copied from interface:SnsPublishProps
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.
- Specified by:
getMessage
in interfaceSnsPublishProps
-
getTopic
Description copied from interface:SnsPublishProps
The SNS topic that the task will publish to.- Specified by:
getTopic
in interfaceSnsPublishProps
-
getMessageAttributes
Description copied from interface:SnsPublishProps
Add message attributes when publishing.These attributes carry additional metadata about the message and may be used for subscription filters.
Default: {}
- Specified by:
getMessageAttributes
in interfaceSnsPublishProps
- See Also:
-
getMessagePerSubscriptionType
Description copied from interface:SnsPublishProps
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)
Default: false
- Specified by:
getMessagePerSubscriptionType
in interfaceSnsPublishProps
- See Also:
-
getSubject
Description copied from interface:SnsPublishProps
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.
Default: - No subject
- Specified by:
getSubject
in interfaceSnsPublishProps
-
getComment
Description copied from interface:TaskStateBaseProps
An optional description for this state.Default: - No comment
- Specified by:
getComment
in interfaceTaskStateBaseProps
-
getHeartbeat
Description copied from interface:TaskStateBaseProps
Timeout for the heartbeat.Default: - None
- Specified by:
getHeartbeat
in interfaceTaskStateBaseProps
-
getInputPath
Description copied from interface:TaskStateBaseProps
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 {}.
Default: - The entire task input (JSON path '$')
- Specified by:
getInputPath
in interfaceTaskStateBaseProps
-
getIntegrationPattern
Description copied from interface:TaskStateBaseProps
AWS Step Functions integrates with services directly in the Amazon States Language.You can control these AWS services using service integration patterns
Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
- Specified by:
getIntegrationPattern
in interfaceTaskStateBaseProps
- See Also:
-
getOutputPath
Description copied from interface:TaskStateBaseProps
JSONPath expression to select select a portion of the state output to pass to the next state.May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
- Specified by:
getOutputPath
in interfaceTaskStateBaseProps
-
getResultPath
Description copied from interface:TaskStateBaseProps
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.
Default: - Replaces the entire input with the result (JSON path '$')
- Specified by:
getResultPath
in interfaceTaskStateBaseProps
-
getResultSelector
Description copied from interface:TaskStateBaseProps
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.
Default: - None
-
getTimeout
Description copied from interface:TaskStateBaseProps
Timeout for the state machine.Default: - None
- Specified by:
getTimeout
in interfaceTaskStateBaseProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-