aws-cdk-lib.aws_codepipeline_actions.StepFunctionInvokeAction

class StepFunctionInvokeAction

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.Actions.StepFunctionInvokeAction
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#StepFunctionInvokeAction
Javasoftware.amazon.awscdk.services.codepipeline.actions.StepFunctionInvokeAction
Pythonaws_cdk.aws_codepipeline_actions.StepFunctionInvokeAction
TypeScript (source)aws-cdk-lib » aws_codepipeline_actions » StepFunctionInvokeAction

Implements IAction

Extends Action

StepFunctionInvokeAction that is provided by an AWS CodePipeline.

Example

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],
});

Initializer

new StepFunctionInvokeAction(props: StepFunctionsInvokeActionProps)

Parameters

  • props StepFunctionsInvokeActionProps

Properties

NameTypeDescription
actionPropertiesActionPropertiesThe simple properties of the Action, like its Owner, name, etc.

actionProperties

Type: ActionProperties

The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the bind callback.

Methods

NameDescription
bind(scope, stage, options)The callback invoked when this Action is added to a Pipeline.
onStateChange(name, target?, options?)Creates an Event that will be triggered whenever the state of this Action changes.
protected bound(_scope, _stage, options)This is a renamed version of the IAction.bind method.

bind(scope, stage, options)

public bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

  • scope Construct
  • stage IStage
  • options ActionBindOptions

Returns

  • ActionConfig

The callback invoked when this Action is added to a Pipeline.


onStateChange(name, target?, options?)

public onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Rule

Parameters

  • name string
  • target IRuleTarget
  • options RuleProps

Returns

  • Rule

Creates an Event that will be triggered whenever the state of this Action changes.


protected bound(_scope, _stage, options)

protected bound(_scope: Construct, _stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

  • _scope Construct
  • _stage IStage
  • options ActionBindOptions

Returns

  • ActionConfig

This is a renamed version of the IAction.bind method.