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

Class CallAwsServiceProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CallAwsServiceProps, TaskStateBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CallAwsServiceProps

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

An implementation for CallAwsServiceProps

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.CallAwsServiceProps

CallAwsServiceProps.Builder, CallAwsServiceProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CallAwsServiceProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CallAwsServiceProps.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	getAction()	The API action to call.
final String	getComment()	An optional description for this state.
final Duration	getHeartbeat()	Timeout for the heartbeat.
final String	getIamAction()	The action for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call.
final List<String>	getIamResources()	The resources for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call.
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 String	getOutputPath()	JSONPath expression to select select a portion of the state output to pass to the next state.
final Map<String,Object>	getParameters()	Parameters for the API action call.
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	getService()	The AWS service to call.
final Duration	getTimeout()	Timeout for the state machine.
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(CallAwsServiceProps.Builder builder)

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

Method Details

getAction

public final String getAction()

Description copied from interface: CallAwsServiceProps

The API action to call.

Use camelCase.

Specified by:

getAction in interface CallAwsServiceProps

getIamResources

public final List<String> getIamResources()

Description copied from interface: CallAwsServiceProps

The resources for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call.

By default the action for this IAM statement will be service:action.

Specified by:

getIamResources in interface CallAwsServiceProps

getService

public final String getService()

Description copied from interface: CallAwsServiceProps

The AWS service to call.

Specified by:

getService in interface CallAwsServiceProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/supported-services-awssdk.html

getIamAction

public final String getIamAction()

Description copied from interface: CallAwsServiceProps

The action for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call.

Use in the case where the IAM action name does not match with the API service/action name, e.g. s3:ListBuckets requires s3:ListAllMyBuckets.

Default: - service:action

Specified by:

getIamAction in interface CallAwsServiceProps

getParameters

public final Map<String,Object> getParameters()

Description copied from interface: CallAwsServiceProps

Parameters for the API action call.

Use PascalCase for the parameter names.

Default: - no parameters

Specified by:

getParameters in interface CallAwsServiceProps

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