class aws_cdk.aws_codepipeline_actions.LambdaInvokeAction(*, lambda_, inputs=None, outputs=None, user_parameters=None, role=None, action_name, run_order=None, variables_namespace=None)

Bases: aws_cdk.aws_codepipeline_actions.Action

CodePipeline invoke Action that is provided by an AWS Lambda function.


  • lambda – The lambda function to invoke.

  • inputs (Optional[Sequence[Artifact]]) – The optional input Artifacts of the Action. A Lambda Action can have up to 5 inputs. The inputs will appear in the event passed to the Lambda, under the 'CodePipeline.job'.data.inputArtifacts path. Default: the Action will not have any inputs

  • outputs (Optional[Sequence[Artifact]]) – The optional names of the output Artifacts of the Action. A Lambda Action can have up to 5 outputs. The outputs will appear in the event passed to the Lambda, under the 'CodePipeline.job'.data.outputArtifacts path. It is the responsibility of the Lambda to upload ZIP files with the Artifact contents to the provided locations. Default: the Action will not have any outputs

  • user_parameters (Optional[Mapping[str, Any]]) – A set of key-value pairs that will be accessible to the invoked Lambda inside the event that the Pipeline will call it with.

  • 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


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

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

Return type


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

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

  • 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[Sequence[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.

Return type



Reference a CodePipeline variable defined by the Lambda function this action points to.

Variables in Lambda invoke actions are defined by calling the PutJobSuccessResult CodePipeline API call with the ‘outputVariables’ property filled.


variable_name (str) – the name of the variable to reference. A variable by this name must be present in the ‘outputVariables’ section of the PutJobSuccessResult request that the Lambda function calls when the action is invoked


Return type




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

Note that this accessor will be called before the {@link bind} callback.

Return type