Skip to content
v2.275.0

StepFunctionsParametersProperty Struct Added in v2.275.0 ​

Parameters for starting an AWS Step Functions state machine execution target.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eventsv2 as eventsv2 } from 'aws-cdk-lib';
const stepFunctionsParametersProperty: eventsv2.CfnSubscriber.StepFunctionsParametersProperty = {
  invocationTimeoutSeconds: 'invocationTimeoutSeconds',
  invocationType: 'invocationType',
  name: 'name',
  traceHeader: 'traceHeader',
};

Properties ​

invocationTimeoutSecondsoptionalstringinvocation_timeout_secondsoptionalstrinvocationTimeoutSecondsoptionalStringInvocationTimeoutSecondsoptionalstringInvocationTimeoutSecondsoptional*string#
The timeout in seconds for each invocation of the target, written as a string.

Accepts a literal value or a JSONata expression.

invocationTypeoptionalstringinvocation_typeoptionalstrinvocationTypeoptionalStringInvocationTypeoptionalstringInvocationTypeoptional*string#
How the execution is started: EVENT (StartExecution, asynchronous) or REQUEST_RESPONSE (StartSyncExecution, synchronous).
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
A name for the execution.

Must be unique for the account, Region, and state machine. Accepts a literal value or a JSONata expression.

traceHeaderoptionalstringtrace_headeroptionalstrtraceHeaderoptionalStringTraceHeaderoptionalstringTraceHeaderoptional*string#
The AWS X-Ray trace header for distributed tracing.

Accepts a literal value or a JSONata expression.