LambdaInvokeActionProps¶
-
class
aws_cdk.aws_codepipeline_actions.
LambdaInvokeActionProps
(*, action_name, run_order=None, variables_namespace=None, role=None, lambda_, inputs=None, outputs=None, user_parameters=None)¶ Bases:
aws_cdk.aws_codepipeline.CommonAwsActionProps
Construction properties of the {@link LambdaInvokeAction Lambda invoke CodePipeline 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: 1variables_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 setrole (
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 generatedlambda – The lambda function to invoke.
inputs (
Optional
[List
[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 inputsoutputs (
Optional
[List
[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 outputsuser_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.
Attributes
-
action_name
¶ The physical, human-readable name of the Action.
Note that Action names must be unique within a single Stage.
- Return type
str
-
inputs
¶ 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
- See
- Return type
Optional
[List
[Artifact
]]
-
outputs
¶ 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
- Return type
Optional
[List
[Artifact
]]
-
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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.
- Default
a new Role will be generated
- Return type
Optional
[IRole
]
-
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
- Return type
Union
[int
,float
,None
]
-
user_parameters
¶ A set of key-value pairs that will be accessible to the invoked Lambda inside the event that the Pipeline will call it with.
- See
- Return type
Optional
[Mapping
[str
,Any
]]
-
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
- Return type
Optional
[str
]