- class aws_cdk.aws_codepipeline_actions.LambdaInvokeAction(*, lambda_, inputs=None, outputs=None, user_parameters=None, user_parameters_string=None, role=None, action_name, run_order=None, variables_namespace=None)
CodePipeline invoke Action that is provided by an AWS Lambda function.
# fn: lambda.Function pipeline = codepipeline.Pipeline(self, "MyPipeline") lambda_action = codepipeline_actions.LambdaInvokeAction( action_name="Lambda", lambda_=fn ) pipeline.add_stage( stage_name="Lambda", actions=[lambda_action] )
lambda – The lambda function to invoke.
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.inputArtifactspath. Default: the Action will not have any inputs
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.outputArtifactspath. 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
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. Only one of
userParametersStringcan be specified. Default: - no user parameters will be passed
str]) – The string representation of the user parameters that will be accessible to the invoked Lambda inside the event that the Pipeline will call it with. Only one of
userParameterscan be specified. Default: - no user parameters will be passed
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.bindmethod in the
ActionBindOptions.roleproperty. Default: a new Role will be generated
str) – The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.
None]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1
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.
- on_state_change(name, target=None, *, enabled=None, event_bus=None, schedule=None, targets=None, cross_stack_scope=None, description=None, event_pattern=None, rule_name=None)
Creates an Event that will be triggered whenever the state of this Action changes.
bool]) – Indicates whether the rule is enabled. Default: true
IEventBus]) – The event bus to associate with this rule. Default: - The default event bus.
Schedule]) – The schedule or rate (frequency) that determines when EventBridge runs the rule. You must specify this property, the
eventPatternproperty, or both. For more information, see Schedule Expression Syntax for Rules in the Amazon EventBridge User Guide. Default: - None.
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.
Construct]) – The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations. Default: - none (the main scope will be used, even for cross-stack Events)
str]) – A description of the rule’s purpose. Default: - No description
None]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.
str]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.
- 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.
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