AWS CDK Reference

Appearance

v2.275.0

StepFunctionsInvokeActionProps Struct ​

Construction properties of the StepFunctionsInvokeAction StepFunction Invoke Action.

Source
aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts

Example ​

ts
import * as stepfunctions from 'aws-cdk-lib/aws-stepfunctions';
const pipeline = new codepipeline.Pipeline(this, 'MyPipeline');
const startState = new stepfunctions.Pass(this, 'StartState');
const simpleStateMachine  = new stepfunctions.StateMachine(this, 'SimpleStateMachine', {
  definition: startState,
});
const stepFunctionAction = new codepipeline_actions.StepFunctionInvokeAction({
  actionName: 'Invoke',
  stateMachine: simpleStateMachine,
  stateMachineInput: codepipeline_actions.StateMachineInput.literal({ IsHelloWorldExample: true }),
});
pipeline.addStage({
  stageName: 'StepFunctions',
  actions: [stepFunctionAction],
});

Properties ​

actionNamestringaction_namestractionNameStringActionNamestringActionName*stringrequired#
The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

executionNamePrefixoptionalstringexecution_name_prefixoptionalstrexecutionNamePrefixoptionalStringExecutionNamePrefixoptionalstringExecutionNamePrefixoptional*string#
Prefix (optional).

Default: action execution ID

By default, the action execution ID is used as the state machine execution name. If a prefix is provided, it is prepended to the action execution ID with a hyphen and together used as the state machine execution name.

outputoptionalArtifactoutputoptionalArtifactoutputoptionalArtifactOutputoptionalArtifactOutputoptionalArtifact#
The optional output Artifact of the Action.

Default: the Action will not have any outputs

roleoptionalIRoleroleoptionalIRoleroleoptionalIRoleRoleoptionalIRoleRoleoptionalIRole#
The Role in which context's this Action will be executing in.

Default: a new Role will be generated

notes

The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property.

runOrderoptionalnumberrun_orderoptionalint | floatrunOrderoptionalNumberRunOrderoptionaldoubleRunOrderoptional*float64= 1#
The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

stateMachineIStateMachinestate_machineIStateMachinestateMachineIStateMachineStateMachineIStateMachineStateMachineIStateMachinerequired#
The state machine to invoke.
stateMachineInputoptionalStateMachineInputstate_machine_inputoptionalStateMachineInputstateMachineInputoptionalStateMachineInputStateMachineInputoptionalStateMachineInputStateMachineInputoptionalStateMachineInput= none#
Represents the input to the StateMachine.

This includes input artifact, input type and the statemachine input.

variablesNamespaceoptionalstringvariables_namespaceoptionalstrvariablesNamespaceoptionalStringVariablesNamespaceoptionalstringVariablesNamespaceoptional*string#
The name of the namespace to use for variables emitted by this action.

Default: a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set