Show / Hide Table of Contents

Interface IStepFunctionsInvokeActivityJsonPathProps

Properties for invoking an Activity worker using JSONPath.

Inherited Members
ITaskStateJsonPathBaseProps.ResultPath
ITaskStateJsonPathBaseProps.ResultSelector
IStateBaseProps.Comment
IStateBaseProps.QueryLanguage
IStateBaseProps.StateName
ITaskStateBaseOptions.Credentials
ITaskStateBaseOptions.Heartbeat
ITaskStateBaseOptions.HeartbeatTimeout
ITaskStateBaseOptions.IntegrationPattern
ITaskStateBaseOptions.TaskTimeout
ITaskStateBaseOptions.Timeout
IAssignableStateOptions.Assign
IJsonPathCommonOptions.InputPath
IJsonPathCommonOptions.OutputPath
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IStepFunctionsInvokeActivityJsonPathProps : ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptions
Syntax (vb)
Public Interface IStepFunctionsInvokeActivityJsonPathProps Inherits ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptions
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;
            using Amazon.CDK.AWS.StepFunctions;
            using Amazon.CDK.AWS.StepFunctions.Tasks;

            Activity activity;
            var assign;
            var parameters;
            var resultSelector;
            TaskRole taskRole;
            Timeout timeout;

            var stepFunctionsInvokeActivityJsonPathProps = new StepFunctionsInvokeActivityJsonPathProps {
                Activity = activity,

                // the properties below are optional
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                Credentials = new Credentials {
                    Role = taskRole
                },
                Heartbeat = Duration.Minutes(30),
                HeartbeatTimeout = timeout,
                InputPath = "inputPath",
                IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
                OutputPath = "outputPath",
                Parameters = new Dictionary<string, object> {
                    { "parametersKey", parameters }
                },
                QueryLanguage = QueryLanguage.JSON_PATH,
                ResultPath = "resultPath",
                ResultSelector = new Dictionary<string, object> {
                    { "resultSelectorKey", resultSelector }
                },
                StateName = "stateName",
                TaskTimeout = timeout,
                Timeout = Duration.Minutes(30)
            };

Synopsis

Properties

Activity

Step Functions Activity to invoke.

Parameters

Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

Properties

Activity

Step Functions Activity to invoke.

IActivity Activity { get; }
Property Value

IActivity

Remarks

ExampleMetadata: fixture=_generated

Parameters

Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

IDictionary<string, object>? Parameters { get; }
Property Value

IDictionary<string, object>

Remarks

Default: No parameters

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

Back to top Generated by DocFX