Class StepFunctionsInvokeActionProps
Construction properties of the {@link StepFunctionsInvokeAction StepFunction Invoke Action}.
Inheritance
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.AWS.CodePipeline.Actions.dll
Syntax (csharp)
public class StepFunctionsInvokeActionProps : Object, IStepFunctionsInvokeActionProps, ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Class StepFunctionsInvokeActionProps
Inherits Object
Implements IStepFunctionsInvokeActionProps, ICommonAwsActionProps, ICommonActionProps
Remarks
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.StepFunctions;
var pipeline = new Pipeline(this, "MyPipeline");
var startState = new Pass(this, "StartState");
var simpleStateMachine = new StateMachine(this, "SimpleStateMachine", new StateMachineProps {
Definition = startState
});
var stepFunctionAction = new StepFunctionInvokeAction(new StepFunctionsInvokeActionProps {
ActionName = "Invoke",
StateMachine = simpleStateMachine,
StateMachineInput = StateMachineInput.Literal(new Dictionary<string, boolean> { { "IsHelloWorldExample", true } })
});
pipeline.AddStage(new StageOptions {
StageName = "StepFunctions",
Actions = new [] { stepFunctionAction }
});
Synopsis
Constructors
StepFunctionsInvokeActionProps() |
Properties
ActionName | The physical, human-readable name of the Action. |
ExecutionNamePrefix | Prefix (optional). |
Output | The optional output Artifact of the Action. |
Role | The Role in which context's this Action will be executing in. |
RunOrder | The runOrder property for this Action. |
StateMachine | The state machine to invoke. |
StateMachineInput | Represents the input to the StateMachine. |
VariablesNamespace | The name of the namespace to use for variables emitted by this action. |
Constructors
StepFunctionsInvokeActionProps()
public StepFunctionsInvokeActionProps()
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.
ExecutionNamePrefix
Prefix (optional).
public string ExecutionNamePrefix { get; set; }
Property Value
System.String
Remarks
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
The optional output Artifact of the Action.
public Artifact_ Output { get; set; }
Property Value
Remarks
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 {@link IAction.bind} method in the {@link 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
StateMachine
The state machine to invoke.
public IStateMachine StateMachine { get; set; }
Property Value
StateMachineInput
Represents the input to the StateMachine.
public StateMachineInput StateMachineInput { get; set; }
Property Value
Remarks
This includes input artifact, input type and the statemachine input.
Default: - none
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