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

Class CallAwsServiceCrossRegionJsonataProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

AssignableStateOptions, JsonataCommonOptions, StateBaseProps, CallAwsServiceCrossRegionJsonataProps, TaskStateBaseOptions, TaskStateJsonataBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CallAwsServiceCrossRegionJsonataProps

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

An implementation for CallAwsServiceCrossRegionJsonataProps

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

CallAwsServiceCrossRegionJsonataProps.Builder, CallAwsServiceCrossRegionJsonataProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CallAwsServiceCrossRegionJsonataProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CallAwsServiceCrossRegionJsonataProps.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 List<PolicyStatement>	getAdditionalIamStatements()	Additional IAM statements that will be added to the state machine role's policy.
final Map<String,Object>	getAssign()	Workflow variables to store in this step.
final String	getComment()	A comment describing this state.
final Credentials	getCredentials()	Credentials for an IAM Role that the State Machine assumes for executing the task.
final String	getEndpoint()	The AWS API endpoint.
final Duration	getHeartbeat()	(deprecated) Timeout for the heartbeat.
final Timeout	getHeartbeatTimeout()	Timeout for the heartbeat.
final String	getIamAction()	The action for the IAM statement that will be added to the Lambda function 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 Lambda function role's policy to allow the state machine to make the API call.
final IntegrationPattern	getIntegrationPattern()	AWS Step Functions integrates with services directly in the Amazon States Language.
final Object	getOutputs()	Used to specify and transform output from the state.
final Map<String,Object>	getParameters()	Parameters for the API action call in AWS SDK for JavaScript v3 format.
final QueryLanguage	getQueryLanguage()	The name of the query language used by the state.
final String	getRegion()	The AWS region to call this AWS API for.
final Boolean	getRetryOnServiceExceptions()	Whether to retry on the backend Lambda service exceptions.
final String	getService()	The AWS service to call in AWS SDK for JavaScript v3 format.
final String	getStateName()	Optional name for this state.
final Timeout	getTaskTimeout()	Timeout for the task.
final Duration	getTimeout()	(deprecated) Timeout for the task.
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(CallAwsServiceCrossRegionJsonataProps.Builder builder)

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

Method Details

getAction

public final String getAction()

Description copied from interface: CallAwsServiceCrossRegionJsonataProps

The API action to call.

Use camelCase.

Specified by:

getAction in interface CallAwsServiceCrossRegionJsonataProps

getIamResources

public final List<String> getIamResources()

Description copied from interface: CallAwsServiceCrossRegionJsonataProps

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

Specified by:

getIamResources in interface CallAwsServiceCrossRegionJsonataProps

getRegion

public final String getRegion()

Description copied from interface: CallAwsServiceCrossRegionJsonataProps

The AWS region to call this AWS API for.

Example:

 "us-east-1";
 

Specified by:

getRegion in interface CallAwsServiceCrossRegionJsonataProps

getService

public final String getService()

Description copied from interface: CallAwsServiceCrossRegionJsonataProps

The AWS service to call in AWS SDK for JavaScript v3 format.

Example:

 "s3";
 

Specified by:

getService in interface CallAwsServiceCrossRegionJsonataProps

See Also:

• https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/

getAdditionalIamStatements

public final List<PolicyStatement> getAdditionalIamStatements()

Description copied from interface: CallAwsServiceCrossRegionJsonataProps

Additional IAM statements that will be added to the state machine role's policy.

Use in the case where the call requires more than a single statement to be executed, e.g. rekognition:detectLabels requires also S3 permissions to read the object on which it must act.

Default: - no additional statements are added

Specified by:

getAdditionalIamStatements in interface CallAwsServiceCrossRegionJsonataProps

getEndpoint

public final String getEndpoint()

Description copied from interface: CallAwsServiceCrossRegionJsonataProps

The AWS API endpoint.

Default: Do not override API endpoint.

Specified by:

getEndpoint in interface CallAwsServiceCrossRegionJsonataProps

getIamAction

public final String getIamAction()

Description copied from interface: CallAwsServiceCrossRegionJsonataProps

The action for the IAM statement that will be added to the Lambda function 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.

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 CallAwsServiceCrossRegionJsonataProps

getParameters

public final Map<String,Object> getParameters()

Description copied from interface: CallAwsServiceCrossRegionJsonataProps

Parameters for the API action call in AWS SDK for JavaScript v3 format.

Default: - no parameters

Specified by:

getParameters in interface CallAwsServiceCrossRegionJsonataProps

getRetryOnServiceExceptions

public final Boolean getRetryOnServiceExceptions()

Description copied from interface: CallAwsServiceCrossRegionJsonataProps

Whether to retry on the backend Lambda service exceptions.

This handles Lambda.ServiceException, Lambda.AWSLambdaException, Lambda.SdkClientException, and Lambda.ClientExecutionTimeoutException with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts.

Default: true

Specified by:

getRetryOnServiceExceptions in interface CallAwsServiceCrossRegionJsonataProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/bp-lambda-serviceexception.html

getComment

public final String getComment()

Description copied from interface: StateBaseProps

A comment describing this state.

Default: No comment

Specified by:

getComment in interface StateBaseProps

getQueryLanguage

public final QueryLanguage getQueryLanguage()

Description copied from interface: StateBaseProps

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default: - JSONPath

Specified by:

getQueryLanguage in interface StateBaseProps

getStateName

public final String getStateName()

Description copied from interface: StateBaseProps

Optional name for this state.

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

Specified by:

getStateName in interface StateBaseProps

getCredentials

public final Credentials getCredentials()

Description copied from interface: TaskStateBaseOptions

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

Default: - None (Task is executed using the State Machine's execution role)

Specified by:

getCredentials in interface TaskStateBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

getHeartbeat

public final Duration getHeartbeat()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the heartbeat.

Default: - None

Specified by:

getHeartbeat in interface TaskStateBaseOptions

getHeartbeatTimeout

public final Timeout getHeartbeatTimeout()

Description copied from interface: TaskStateBaseOptions

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Specified by:

getHeartbeatTimeout in interface TaskStateBaseOptions

getIntegrationPattern

public final IntegrationPattern getIntegrationPattern()

Description copied from interface: TaskStateBaseOptions

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.

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 TaskStateBaseOptions

See Also:

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

getTaskTimeout

public final Timeout getTaskTimeout()

Description copied from interface: TaskStateBaseOptions

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Specified by:

getTaskTimeout in interface TaskStateBaseOptions

getTimeout

public final Duration getTimeout()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the task.

Default: - None

Specified by:

getTimeout in interface TaskStateBaseOptions

getAssign

public final Map<String,Object> getAssign()

Description copied from interface: AssignableStateOptions

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

Specified by:

getAssign in interface AssignableStateOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

getOutputs

public final Object getOutputs()

Description copied from interface: JsonataCommonOptions

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

Specified by:

getOutputs in interface JsonataCommonOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

$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