@Stability(value=Experimental) @Internal public static final class SnsPublishProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements SnsPublishProps
SnsPublishPropssoftware.amazon.jsii.JsiiObject.InitializationModeSnsPublishProps.Builder, SnsPublishProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
protected |
Jsii$Proxy(TaskInput message,
ITopic topic,
Boolean messagePerSubscriptionType,
String subject,
String comment,
Duration heartbeat,
String inputPath,
IntegrationPattern integrationPattern,
String outputPath,
String resultPath,
Map<String,? extends Object> resultSelector,
Duration timeout)
Constructor that initializes the object based on literal property values passed by the
SnsPublishProps.Builder. |
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
String |
getComment()
(experimental) An optional description for this state.
|
Duration |
getHeartbeat()
(experimental) Timeout for the heartbeat.
|
String |
getInputPath()
(experimental) JSONPath expression to select part of the state to be the input to this state.
|
IntegrationPattern |
getIntegrationPattern()
(experimental) AWS Step Functions integrates with services directly in the Amazon States Language.
|
TaskInput |
getMessage()
(experimental) The message you want to send.
|
Boolean |
getMessagePerSubscriptionType()
(experimental) Send different messages for each transport protocol.
|
String |
getOutputPath()
(experimental) JSONPath expression to select select a portion of the state output to pass to the next state.
|
String |
getResultPath()
(experimental) JSONPath expression to indicate where to inject the state's output.
|
Map<String,Object> |
getResultSelector()
(experimental) The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
|
String |
getSubject()
(experimental) Used as the "Subject" line when the message is delivered to email endpoints.
|
Duration |
getTimeout()
(experimental) Timeout for the state machine.
|
ITopic |
getTopic()
(experimental) The SNS topic that the task will publish to.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(TaskInput message, ITopic topic, Boolean messagePerSubscriptionType, String subject, String comment, Duration heartbeat, String inputPath, IntegrationPattern integrationPattern, String outputPath, String resultPath, Map<String,? extends Object> resultSelector, Duration timeout)
SnsPublishProps.Builder.public final TaskInput getMessage()
SnsPublishPropsWith 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.
getMessage in interface SnsPublishPropspublic final ITopic getTopic()
SnsPublishPropsgetTopic in interface SnsPublishPropspublic final Boolean getMessagePerSubscriptionType()
SnsPublishPropsFor 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
getMessagePerSubscriptionType in interface SnsPublishPropshttps://docs.aws.amazon.com/sns/latest/api/API_Publish.html#API_Publish_RequestParameterspublic final String getSubject()
SnsPublishPropsThis field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Default: - No subject
getSubject in interface SnsPublishPropspublic final String getComment()
TaskStateBasePropsDefault: - No comment
getComment in interface TaskStateBasePropspublic final Duration getHeartbeat()
TaskStateBasePropsDefault: - None
getHeartbeat in interface TaskStateBasePropspublic final String getInputPath()
TaskStateBasePropsMay 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 '$')
getInputPath in interface TaskStateBasePropspublic final IntegrationPattern getIntegrationPattern()
TaskStateBasePropsYou can control these AWS services using service integration patterns
Default: IntegrationPattern.REQUEST_RESPONSE
getIntegrationPattern in interface TaskStateBasePropshttps://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-tokenpublic final String getOutputPath()
TaskStateBasePropsMay 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 '$')
getOutputPath in interface TaskStateBasePropspublic final String getResultPath()
TaskStateBasePropsMay 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 '$')
getResultPath in interface TaskStateBasePropspublic final Map<String,Object> getResultSelector()
TaskStateBasePropsYou can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
getResultSelector in interface TaskStateBasePropshttps://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselectorpublic final Duration getTimeout()
TaskStateBasePropsDefault: - None
getTimeout in interface TaskStateBaseProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2021. All rights reserved.