StateMachineInput

class aws_cdk.aws_codepipeline_actions.StateMachineInput

Bases: object

Represents the input for the StateMachine.

Attributes

input

When InputType is set to Literal (default), the Input field is used directly as the input for the state machine execution.

Otherwise, the state machine is invoked with an empty JSON object {}.

When InputType is set to FilePath, this field is required. An input artifact is also required when InputType is set to FilePath.

default :default: - none

Return type

Any

input_artifact

The optional input Artifact of the Action.

If InputType is set to FilePath, this artifact is required and is used to source the input for the state machine execution.

default :default: - the Action will not have any inputs

see :see: https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-StepFunctions.html#action-reference-StepFunctions-example

Return type

Optional[Artifact]

input_type

Optional StateMachine InputType InputType can be Literal or FilePath.

default :default: - Literal

Return type

Optional[str]

Static Methods

classmethod file_path(input_file)

When the input type is FilePath, input artifact and filepath must be specified.

Parameters

input_file (ArtifactPath) –

Return type

StateMachineInput

classmethod literal(object)

When the input type is Literal, input value is passed directly to the state machine input.

Parameters

object (Mapping[Any, Any]) –

Return type

StateMachineInput