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

Class CallAwsServiceCrossRegionProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CallAwsServiceCrossRegionProps, TaskStateBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CallAwsServiceCrossRegionProps

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

An implementation for CallAwsServiceCrossRegionProps

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

CallAwsServiceCrossRegionProps.Builder, CallAwsServiceCrossRegionProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CallAwsServiceCrossRegionProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CallAwsServiceCrossRegionProps.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 String	getComment()	An optional description for 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 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 in AWS SDK for JavaScript v3 format.
final String	getRegion()	The AWS region to call this AWS API for.
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 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(CallAwsServiceCrossRegionProps.Builder builder)

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

Method Details

getAction

public final String getAction()

Description copied from interface: CallAwsServiceCrossRegionProps

The API action to call.

Use camelCase.

Specified by:

getAction in interface CallAwsServiceCrossRegionProps

getIamResources

public final List<String> getIamResources()

Description copied from interface: CallAwsServiceCrossRegionProps

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 CallAwsServiceCrossRegionProps

getRegion

public final String getRegion()

Description copied from interface: CallAwsServiceCrossRegionProps

The AWS region to call this AWS API for.

Example:

 "us-east-1";
 

Specified by:

getRegion in interface CallAwsServiceCrossRegionProps

getService

public final String getService()

Description copied from interface: CallAwsServiceCrossRegionProps

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

Example:

 "s3";
 

Specified by:

getService in interface CallAwsServiceCrossRegionProps

See Also:

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

getAdditionalIamStatements

public final List<PolicyStatement> getAdditionalIamStatements()

Description copied from interface: CallAwsServiceCrossRegionProps

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 CallAwsServiceCrossRegionProps

getEndpoint

public final String getEndpoint()

Description copied from interface: CallAwsServiceCrossRegionProps

The AWS API endpoint.

Default: Do not override API endpoint.

Specified by:

getEndpoint in interface CallAwsServiceCrossRegionProps

getIamAction

public final String getIamAction()

Description copied from interface: CallAwsServiceCrossRegionProps

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 CallAwsServiceCrossRegionProps

getParameters

public final Map<String,Object> getParameters()

Description copied from interface: CallAwsServiceCrossRegionProps

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

Default: - no parameters

Specified by:

getParameters in interface CallAwsServiceCrossRegionProps

getRetryOnServiceExceptions

public final Boolean getRetryOnServiceExceptions()

Description copied from interface: CallAwsServiceCrossRegionProps

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 CallAwsServiceCrossRegionProps

See Also:

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

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

getCredentials

public final Credentials getCredentials()

Description copied from interface: TaskStateBaseProps

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 TaskStateBaseProps

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: TaskStateBaseProps

(deprecated) Timeout for the heartbeat.

Default: - None

Specified by:

getHeartbeat in interface TaskStateBaseProps

getHeartbeatTimeout

public final Timeout getHeartbeatTimeout()

Description copied from interface: TaskStateBaseProps

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

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 TaskStateBaseProps

See Also:

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

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

getStateName

public final String getStateName()

Description copied from interface: TaskStateBaseProps

Optional name for this state.

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

Specified by:

getStateName in interface TaskStateBaseProps

getTaskTimeout

public final Timeout getTaskTimeout()

Description copied from interface: TaskStateBaseProps

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 TaskStateBaseProps

getTimeout

public final Duration getTimeout()

Description copied from interface: TaskStateBaseProps

(deprecated) Timeout for the task.

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