StepFunctionInvokeAction

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

Bases: aws_cdk.aws_codepipeline_actions.Action

StepFunctionInvokeAction that is provided by an AWS CodePipeline.

__init__(*, state_machine, execution_name_prefix=None, output=None, state_machine_input=None, role=None, action_name, run_order=None, variables_namespace=None)
Parameters
  • 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

  • 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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property. Default: a new Role will be generated

  • 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

Return type

None

Methods

bind(scope, stage, *, bucket, role)
Parameters

stability :stability: experimental

Return type

ActionConfig

on_state_change(name, target=None, *, description=None, enabled=None, event_bus=None, event_pattern=None, rule_name=None, schedule=None, targets=None)
Parameters
  • name (str) –

  • target (Optional[IRuleTarget]) –

  • description (Optional[str]) – A description of the rule’s purpose. Default: - No description.

  • enabled (Optional[bool]) – Indicates whether the rule is enabled. Default: true

  • event_bus (Optional[IEventBus]) – The event bus to associate with this rule. Default: - The default event bus.

  • event_pattern (Optional[EventPattern]) – Describes which events EventBridge routes to the specified target. These routed events are matched events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide. Default: - None.

  • rule_name (Optional[str]) – A name for the rule. Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

  • schedule (Optional[Schedule]) – The schedule or rate (frequency) that determines when EventBridge runs the rule. For more information, see Schedule Expression Syntax for Rules in the Amazon EventBridge User Guide. Default: - None.

  • targets (Optional[List[IRuleTarget]]) – Targets to invoke when this rule matches an event. Input will be the full matched event. If you wish to specify custom target input, use addTarget(target[, inputOptions]). Default: - No targets.

stability :stability: experimental

Return type

Rule

Attributes

action_properties

stability :stability: experimental

Return type

ActionProperties