Package software.amazon.awscdk.services.stepfunctions.tasks

Class SnsPublishProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.tasks.SnsPublishProps.Jsii$Proxy

All Implemented Interfaces:

SnsPublishProps, TaskStateBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

SnsPublishProps

@Stability(Stable)
@Internal
public static final class SnsPublishProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements SnsPublishProps

An implementation for 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

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(SnsPublishProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the SnsPublishProps.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 Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getComment()	An optional description for this state.
final Duration	getHeartbeat()	Timeout for the heartbeat.
final String	getInputPath()	JSONPath expression to select part of the state to be the input to this state.
final IntegrationPattern	getIntegrationPattern()	AWS Step Functions integrates with services directly in the Amazon States Language.
final TaskInput	getMessage()	The message you want to send.
final Map<String,MessageAttribute>	getMessageAttributes()	Add message attributes when publishing.
final Boolean	getMessagePerSubscriptionType()	Send different messages for each transport protocol.
final String	getOutputPath()	JSONPath expression to select select a portion of the state output to pass to the next state.
final String	getResultPath()	JSONPath expression to indicate where to inject the state's output.
final Map<String,Object>	getResultSelector()	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
final String	getSubject()	Used as the "Subject" line when the message is delivered to email endpoints.
final Duration	getTimeout()	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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

protected Jsii$Proxy(SnsPublishProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the SnsPublishProps.Builder.

Method Details

getMessage

public final TaskInput 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 interface SnsPublishProps

getTopic

public final ITopic getTopic()

Description copied from interface: SnsPublishProps

The SNS topic that the task will publish to.

Specified by:

getTopic in interface SnsPublishProps

getMessageAttributes

public final Map<String,MessageAttribute> 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 interface SnsPublishProps

See Also:

• https://docs.aws.amazon.com/sns/latest/dg/sns-message-attributes.html

getMessagePerSubscriptionType

public final Boolean 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 interface SnsPublishProps

See Also:

• https://docs.aws.amazon.com/sns/latest/api/API_Publish.html#API_Publish_RequestParameters

getSubject

public final String 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 interface SnsPublishProps

getComment

public final String getComment()

Description copied from interface: TaskStateBaseProps

An optional description for this state.

Default: - No comment

Specified by:

getComment in interface TaskStateBaseProps

getHeartbeat

public final Duration getHeartbeat()

Description copied from interface: TaskStateBaseProps

Timeout for the heartbeat.

Default: - None

Specified by:

getHeartbeat in interface TaskStateBaseProps

getInputPath

public final String 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 interface TaskStateBaseProps

getIntegrationPattern

public final IntegrationPattern 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 interface TaskStateBaseProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

getOutputPath

public final String 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 interface TaskStateBaseProps

getResultPath

public final String 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 interface TaskStateBaseProps

getResultSelector

public final Map<String,Object> 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

Specified by:

getResultSelector in interface TaskStateBaseProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

getTimeout

public final Duration getTimeout()

Description copied from interface: TaskStateBaseProps

Timeout for the state machine.

Default: - None

Specified by:

getTimeout in interface TaskStateBaseProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object