Class LambdaInvokeActionProps
Construction properties of the LambdaInvokeAction Lambda invoke CodePipeline Action
.
Inheritance
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class LambdaInvokeActionProps : Object, ILambdaInvokeActionProps, ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Class LambdaInvokeActionProps
Inherits Object
Implements ILambdaInvokeActionProps, ICommonAwsActionProps, ICommonActionProps
Remarks
ExampleMetadata: infused
Examples
Function fn;
var pipeline = new Pipeline(this, "MyPipeline");
var lambdaAction = new LambdaInvokeAction(new LambdaInvokeActionProps {
ActionName = "Lambda",
Lambda = fn
});
pipeline.AddStage(new StageOptions {
StageName = "Lambda",
Actions = new [] { lambdaAction }
});
Synopsis
Constructors
LambdaInvokeActionProps() |
Properties
ActionName | The physical, human-readable name of the Action. |
Inputs | The optional input Artifacts of the Action. |
Lambda | The lambda function to invoke. |
Outputs | The optional names of the output Artifacts of the Action. |
Role | The Role in which context's this Action will be executing in. |
RunOrder | The runOrder property for this Action. |
UserParameters | A set of key-value pairs that will be accessible to the invoked Lambda inside the event that the Pipeline will call it with. |
UserParametersString | 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. |
VariablesNamespace | The name of the namespace to use for variables emitted by this action. |
Constructors
LambdaInvokeActionProps()
public LambdaInvokeActionProps()
Properties
ActionName
The physical, human-readable name of the Action.
public string ActionName { get; set; }
Property Value
System.String
Remarks
Note that Action names must be unique within a single Stage.
Inputs
The optional input Artifacts of the Action.
public Artifact_[] Inputs { get; set; }
Property Value
Remarks
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
Lambda
Outputs
The optional names of the output Artifacts of the Action.
public Artifact_[] Outputs { get; set; }
Property Value
Remarks
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
Role
The Role in which context's this Action will be executing in.
public IRole Role { get; set; }
Property Value
Remarks
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.bind
method in the ActionBindOptions.role
property.
Default: a new Role will be generated
RunOrder
The runOrder property for this Action.
public Nullable<double> RunOrder { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
UserParameters
A set of key-value pairs that will be accessible to the invoked Lambda inside the event that the Pipeline will call it with.
public IDictionary<string, object> UserParameters { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
Only one of userParameters
or userParametersString
can be specified.
Default: - no user parameters will be passed
UserParametersString
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.
public string UserParametersString { get; set; }
Property Value
System.String
Remarks
Only one of userParametersString
or userParameters
can be specified.
Default: - no user parameters will be passed
VariablesNamespace
The name of the namespace to use for variables emitted by this action.
public string VariablesNamespace { get; set; }
Property Value
System.String
Remarks
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