StepFunctionsInvokeActionProps

class aws_cdk.aws_codepipeline_actions.StepFunctionsInvokeActionProps(*, action_name, run_order=None, variables_namespace=None, role=None, state_machine, execution_name_prefix=None, output=None, state_machine_input=None)

Bases: CommonAwsActionProps

Construction properties of the StepFunctionsInvokeAction StepFunction Invoke Action.

Parameters:

  • action_name (str) – The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.

  • run_order (Union[int, float, None]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1

  • variables_namespace (Optional[str]) – 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

  • role (Optional[IRole]) – The Role in which context’s this Action will be executing in. 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. Default: a new Role will be generated

  • state_machine (IStateMachine) – The state machine to invoke.

  • execution_name_prefix (Optional[str]) – Prefix (optional). 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. Default: - action execution ID

  • output (Optional[Artifact]) – The optional output Artifact of the Action. Default: the Action will not have any outputs

  • state_machine_input (Optional[StateMachineInput]) – Represents the input to the StateMachine. This includes input artifact, input type and the statemachine input. Default: - none

ExampleMetadata:

infused

Example:

import aws_cdk.aws_stepfunctions as stepfunctions

pipeline = codepipeline.Pipeline(self, "MyPipeline")
start_state = stepfunctions.Pass(self, "StartState")
simple_state_machine = stepfunctions.StateMachine(self, "SimpleStateMachine",
    definition=start_state
)
step_function_action = codepipeline_actions.StepFunctionInvokeAction(
    action_name="Invoke",
    state_machine=simple_state_machine,
    state_machine_input=codepipeline_actions.StateMachineInput.literal({"IsHelloWorldExample": True})
)
pipeline.add_stage(
    stage_name="StepFunctions",
    actions=[step_function_action]
)

Attributes

action_name

The physical, human-readable name of the Action.

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

execution_name_prefix

Prefix (optional).

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.

Default:

  • action execution ID

output

The optional output Artifact of the Action.

Default:

the Action will not have any outputs

role

The Role in which context’s this Action will be executing in.

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.

Default:

a new Role will be generated

run_order

The runOrder property for this Action.

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

Default:

1

See:

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

state_machine

The state machine to invoke.

state_machine_input

Represents the input to the StateMachine.

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

Default:

  • none

variables_namespace

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